API introspection – List packages, resources and their interfaces

Found 3 resources

Resource class Smartarchivo\Controller\Document\ReportApi\V1\DocumentsController of type CollectionController
No access control

Skeleton class for controlling a collection of rows from the 'DocumentModel' table.

Controller providing document related collection actions like listing, filtering, searching and others.

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 no no
ScopeReference VARCHAR 36 not set yes no no
State ENUM ACTIVE Value set: ACTIVE, ARCHIVED yes no no
Filename VARCHAR 128 not set yes no 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 6 interfaces in class Smartarchivo\Controller\Document\ReportApi\V1\DocumentsController

Resource: Documents, Method: documentFolder

Loads a model collection for the given document folder or throws an exception

Endpoint
GET /document/report-api/v1/{clientUuid}/{facilityUuid}/documents/document-folder/{documentFolderUuid}/
Example request 
GET /document/report-api/v1/{clientUuid}/{facilityUuid}/documents/document-folder/{documentFolderUuid}
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: 2149
Content-Type: application/json
{
    "DocumentModelCollection": [
        {
            "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": "https:\/\/v2.smartarchivo.test\/document\/api\/v1\/a0795809-4568-4b36-8606-3c362ff2efb2\/80d0babe-0bd9-4ee1-991c-056272917747\/document-download\/4badaccb-6195-4387-9ffa-b187583a2749\/download",
            "FileInfo": {
                "CreatedDatetime": 1625684401,
                "ModifiedDatetime": 1625684401,
                "Filesize": 70,
                "Mimetype": "image\/png"
            },
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "DocumentModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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
FilteredDocumentsControllerModel[] named DocumentModelCollection

Resource: Documents, Method: record

Loads a model collection for the given record or throws an exception

Endpoint
GET /document/report-api/v1/documents/record/{recordUuid}/
Example request 
GET /document/report-api/v1/documents/record/{recordUuid}
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: 2149
Content-Type: application/json
{
    "DocumentModelCollection": [
        {
            "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": "https:\/\/v2.smartarchivo.test\/document\/api\/v1\/a0795809-4568-4b36-8606-3c362ff2efb2\/80d0babe-0bd9-4ee1-991c-056272917747\/document-download\/4badaccb-6195-4387-9ffa-b187583a2749\/download",
            "FileInfo": {
                "CreatedDatetime": 1625684401,
                "ModifiedDatetime": 1625684401,
                "Filesize": 70,
                "Mimetype": "image\/png"
            },
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "DocumentModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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
FilteredDocumentsControllerModel[] named DocumentModelCollection

Resource: Documents, Method: device

Loads a model collection for the given device or throws an exception

Endpoint
GET /document/report-api/v1/documents/device/{deviceUuid}/
Example request 
GET /document/report-api/v1/documents/device/{deviceUuid}
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: 2149
Content-Type: application/json
{
    "DocumentModelCollection": [
        {
            "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": "https:\/\/v2.smartarchivo.test\/document\/api\/v1\/a0795809-4568-4b36-8606-3c362ff2efb2\/80d0babe-0bd9-4ee1-991c-056272917747\/document-download\/4badaccb-6195-4387-9ffa-b187583a2749\/download",
            "FileInfo": {
                "CreatedDatetime": 1625684401,
                "ModifiedDatetime": 1625684401,
                "Filesize": 70,
                "Mimetype": "image\/png"
            },
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "DocumentModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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
FilteredDocumentsControllerModel[] named DocumentModelCollection

Resource: Documents, Method: maintenanceLogEntry

Loads a model collection for the given maintenance log entry or throws an exception

Endpoint
GET /document/report-api/v1/documents/maintenance-log-entry/{maintenanceLogEntryUuid}/
Example request 
GET /document/report-api/v1/documents/maintenance-log-entry/{maintenanceLogEntryUuid}
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: 2149
Content-Type: application/json
{
    "DocumentModelCollection": [
        {
            "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": "https:\/\/v2.smartarchivo.test\/document\/api\/v1\/a0795809-4568-4b36-8606-3c362ff2efb2\/80d0babe-0bd9-4ee1-991c-056272917747\/document-download\/4badaccb-6195-4387-9ffa-b187583a2749\/download",
            "FileInfo": {
                "CreatedDatetime": 1625684401,
                "ModifiedDatetime": 1625684401,
                "Filesize": 70,
                "Mimetype": "image\/png"
            },
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "DocumentModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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
FilteredDocumentsControllerModel[] named DocumentModelCollection

Resource: Documents, Method: find

Loads a model collection or throws an exception

Endpoint
GET /document/report-api/v1/documents/
Example request 
GET /document/report-api/v1/documents
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1780
Content-Type: application/json
{
    "DocumentModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "DocumentModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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
FilteredDocumentsControllerModel[] named DocumentModelCollection

Resource: Documents, Method: page

Loads a paginated model collection or throws an exception

The number of items per page is defined in the class property $modelsPerPage

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1780
Content-Type: application/json
{
    "DocumentModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "DocumentModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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
FilteredDocumentsControllerModel[] named DocumentModelCollection