API introspection – List packages, resources and their interfaces

Found 6 resources

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

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

Controller providing report document related actions like deletion.

Name Type Size Default Description Visible Mutable Nullable
Report VIRTUAL not set yes no yes
Document VARCHAR 36 not set yes no no
CreatedAt TIMESTAMP not set yes no yes
UpdatedAt TIMESTAMP not set yes no yes
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 2 interfaces in class Smartarchivo\Controller\Report\Api\V1\ReportDocumentController

Resource: ReportDocument, Method: load

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

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 829
Content-Type: application/json
{
    "ReportDocumentModel": {
        "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"
    },
    "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
        }
    ]
}
Response data
FilteredReportDocumentControllerModel named ReportDocumentModel

Resource: ReportDocument, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 829
Content-Type: application/json
{
    "ReportDocumentModel": {
        "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"
    },
    "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
        }
    ]
}
Response data
FilteredReportDocumentControllerModel named ReportDocumentModel