API introspection – List packages, resources and their interfaces

Found 3 resources

Resource class Smartarchivo\Controller\Document\ReportApi\V1\DocumentController of type EntityController
No access control

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

Controller providing document related actions.

Name Type Size Default Description Visible Mutable Nullable
Client VARCHAR 36 not set yes no no
Facility VARCHAR 36 not set yes no no
Scope ENUM not set Value set: DOCUMENT_FOLDER, DEVICE, RECORD, MAINTENANCE_LOG_ENTRY, GENERATOR, CYCLOTRON_PRODUCT yes yes no
ScopeReference VARCHAR 36 not set yes yes no
State ENUM ACTIVE Value set: ACTIVE, ARCHIVED yes yes no
File FILE_OBJECT not set no yes no
Filename VARCHAR 128 not set yes yes no
Url VIRTUAL not set yes no yes
FileInfo 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 1 interfaces in class Smartarchivo\Controller\Document\ReportApi\V1\DocumentController

Resource: Document, Method: load

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

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1034
Content-Type: application/json
{
    "DocumentModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Scope": "DOCUMENT_FOLDER",
        "ScopeReference": "123e4567-e89b-12d3-a456-426655440000",
        "State": "ACTIVE",
        "Filename": "my-file.pdf",
        "Url": null,
        "FileInfo": null,
        "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
FilteredDocumentControllerModel named DocumentModel