API introspection – List packages, resources and their interfaces

Found 6 resources

Resource class Smartarchivo\Controller\Report\Api\V1\ReportController of type EntityController
No access control

Skeleton class for controlling a row from the 'ReportModel' table.

Controller providing report related actions.

Name Type Size Default Description Visible Mutable Nullable
Name VARCHAR 128 not set yes yes no
PeriodDateStart DATE not set yes yes no
PeriodDateEnd DATE not set yes yes no
ValidUntil DATE not set yes yes no
Password VARCHAR 64 not set no yes no
ClientName VIRTUAL not set yes no yes
FacilityName VIRTUAL not set yes no yes
ReportSequences VIRTUAL not set yes no yes
ReportDocuments VIRTUAL not set yes no yes
CreatedAt TIMESTAMP not set yes no yes
UpdatedAt TIMESTAMP not set yes no yes
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 5 interfaces in class Smartarchivo\Controller\Report\Api\V1\ReportController

Resource: Report, Method: load

Loads a model enitiy from the table defined by the model class name

Endpoint
GET /report/api/v1/{clientUuid}/{facilityUuid}/report/{uuid}/
Example request 
GET /report/api/v1/{clientUuid}/{facilityUuid}/report/{uuid}
Host: /
Accept: application/json
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1748
Content-Type: application/json
{
    "ReportModel": {
        "Name": "CT-Report 2021-12",
        "PeriodDateStart": "2013-11-12",
        "PeriodDateEnd": "2013-11-12",
        "ValidUntil": "2013-11-12",
        "ClientName": null,
        "FacilityName": null,
        "ReportSequences": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Sequence": "123e4567-e89b-12d3-a456-426655440000",
                "PeriodDateStart": "2013-11-12",
                "PeriodDateEnd": "2013-11-12",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "ReportDocuments": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Document": "123e4567-e89b-12d3-a456-426655440000",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredReportControllerModel named ReportModel

Resource: Report, Method: loadDefault

Loads an item holding the default attributes

Endpoint
GET /report/api/v1/{clientUuid}/{facilityUuid}/report/
Example request 
GET /report/api/v1/{clientUuid}/{facilityUuid}/report
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1748
Content-Type: application/json
{
    "ReportModel": {
        "Name": "CT-Report 2021-12",
        "PeriodDateStart": "2013-11-12",
        "PeriodDateEnd": "2013-11-12",
        "ValidUntil": "2013-11-12",
        "ClientName": null,
        "FacilityName": null,
        "ReportSequences": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Sequence": "123e4567-e89b-12d3-a456-426655440000",
                "PeriodDateStart": "2013-11-12",
                "PeriodDateEnd": "2013-11-12",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "ReportDocuments": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Document": "123e4567-e89b-12d3-a456-426655440000",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredReportControllerModel named ReportModel

Resource: Report, Method: create

Creates model with properties given by request

Endpoint
POST /report/api/v1/{clientUuid}/{facilityUuid}/report/
Example request 
POST /report/api/v1/{clientUuid}/{facilityUuid}/report
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 913
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Name": "CT-Report 2021-12",
    "PeriodDateStart": "2013-11-12",
    "PeriodDateEnd": "2013-11-12",
    "ValidUntil": "2013-11-12",
    "Password": "",
    "ReportSequences": [
        {
            "Report": "123e4567-e89b-12d3-a456-426655440000",
            "Sequence": "123e4567-e89b-12d3-a456-426655440000",
            "PeriodDateStart": "2013-11-12",
            "PeriodDateEnd": "2013-11-12",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "ReportDocuments": [
        {
            "Report": "123e4567-e89b-12d3-a456-426655440000",
            "Document": "123e4567-e89b-12d3-a456-426655440000",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ]
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1748
Content-Type: application/json
{
    "ReportModel": {
        "Name": "CT-Report 2021-12",
        "PeriodDateStart": "2013-11-12",
        "PeriodDateEnd": "2013-11-12",
        "ValidUntil": "2013-11-12",
        "ClientName": null,
        "FacilityName": null,
        "ReportSequences": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Sequence": "123e4567-e89b-12d3-a456-426655440000",
                "PeriodDateStart": "2013-11-12",
                "PeriodDateEnd": "2013-11-12",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "ReportDocuments": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Document": "123e4567-e89b-12d3-a456-426655440000",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Request data
FilteredReportControllerModel
Response data
FilteredReportControllerModel named ReportModel

Resource: Report, Method: update

Updates model with properties given by request

Endpoint
PUT /report/api/v1/{clientUuid}/{facilityUuid}/report/{Uuid}/
Example request 
PUT /report/api/v1/{clientUuid}/{facilityUuid}/report/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 913
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Name": "CT-Report 2021-12",
    "PeriodDateStart": "2013-11-12",
    "PeriodDateEnd": "2013-11-12",
    "ValidUntil": "2013-11-12",
    "Password": "",
    "ReportSequences": [
        {
            "Report": "123e4567-e89b-12d3-a456-426655440000",
            "Sequence": "123e4567-e89b-12d3-a456-426655440000",
            "PeriodDateStart": "2013-11-12",
            "PeriodDateEnd": "2013-11-12",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "ReportDocuments": [
        {
            "Report": "123e4567-e89b-12d3-a456-426655440000",
            "Document": "123e4567-e89b-12d3-a456-426655440000",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ]
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1748
Content-Type: application/json
{
    "ReportModel": {
        "Name": "CT-Report 2021-12",
        "PeriodDateStart": "2013-11-12",
        "PeriodDateEnd": "2013-11-12",
        "ValidUntil": "2013-11-12",
        "ClientName": null,
        "FacilityName": null,
        "ReportSequences": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Sequence": "123e4567-e89b-12d3-a456-426655440000",
                "PeriodDateStart": "2013-11-12",
                "PeriodDateEnd": "2013-11-12",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "ReportDocuments": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Document": "123e4567-e89b-12d3-a456-426655440000",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Request data
FilteredReportControllerModel
Response data
FilteredReportControllerModel named ReportModel

Resource: Report, Method: delete

Deletes the loaded model

Endpoint
DELETE /report/api/v1/{clientUuid}/{facilityUuid}/report/{Uuid}/
Example request 
DELETE /report/api/v1/{clientUuid}/{facilityUuid}/report/{Uuid}
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1748
Content-Type: application/json
{
    "ReportModel": {
        "Name": "CT-Report 2021-12",
        "PeriodDateStart": "2013-11-12",
        "PeriodDateEnd": "2013-11-12",
        "ValidUntil": "2013-11-12",
        "ClientName": null,
        "FacilityName": null,
        "ReportSequences": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Sequence": "123e4567-e89b-12d3-a456-426655440000",
                "PeriodDateStart": "2013-11-12",
                "PeriodDateEnd": "2013-11-12",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "ReportDocuments": [
            {
                "Report": "123e4567-e89b-12d3-a456-426655440000",
                "Document": "123e4567-e89b-12d3-a456-426655440000",
                "CreatedAt": "2013-11-12 16:39:00",
                "UpdatedAt": "2013-11-12 16:39:00",
                "Uuid": "123e4567-e89b-12d3-a456-426655440000"
            }
        ],
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredReportControllerModel named ReportModel