API introspection – List packages, resources and their interfaces

Found 5 resources

Resource class Smartarchivo\Controller\Document\Api\V1\DocumentFoldersController of type CollectionController
No access control

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

Controller providing document folder 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
Parent VIRTUAL not set yes no yes
State ENUM ACTIVE Value set: ACTIVE, ARCHIVED yes no no
Name VARCHAR 128 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\Document\Api\V1\DocumentFoldersController

Resource: DocumentFolders, Method: find

Loads a model collection or throws an exception

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1683
Content-Type: application/json
{
    "DocumentFolderModelCollection": [
        {
            "Client": "123e4567-e89b-12d3-a456-426655440000",
            "Facility": "123e4567-e89b-12d3-a456-426655440000",
            "Parent": "a0795809-4568-4b36-8606-3c362ff2efb2",
            "State": "ACTIVE",
            "Name": "My folder",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "DocumentFolderModelCollection",
        "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
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredDocumentFoldersControllerModel[] named DocumentFolderModelCollection

Resource: DocumentFolders, 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/api/v1/{clientUuid}/{facilityUuid}/document-folders/page/{?page}/
Example request 
GET /document/api/v1/{clientUuid}/{facilityUuid}/document-folders/page/{?page}
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1683
Content-Type: application/json
{
    "DocumentFolderModelCollection": [
        {
            "Client": "123e4567-e89b-12d3-a456-426655440000",
            "Facility": "123e4567-e89b-12d3-a456-426655440000",
            "Parent": "a0795809-4568-4b36-8606-3c362ff2efb2",
            "State": "ACTIVE",
            "Name": "My folder",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "DocumentFolderModelCollection",
        "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
        }
    ]
}
Request header
Bearer JSON Web Token named Authorization
Acceptable Languages named Accept-Language // Optional
Response data
FilteredDocumentFoldersControllerModel[] named DocumentFolderModelCollection