API introspection – List packages, resources and their interfaces

Found 5 resources

Resource class Smartarchivo\Controller\Document\Api\V1\DocumentFolderController of type EntityController
No access control

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

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

Resource: DocumentFolder, Method: load

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

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 943
Content-Type: application/json
{
    "DocumentFolderModel": {
        "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"
    },
    "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
FilteredDocumentFolderControllerModel named DocumentFolderModel

Resource: DocumentFolder, Method: create

Creates model with properties given by request

Endpoint
POST /document/api/v1/{clientUuid}/{facilityUuid}/document-folder/
Example request 
POST /document/api/v1/{clientUuid}/{facilityUuid}/document-folder
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 50
{
    "State": "ACTIVE",
    "Name": "My folder"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 943
Content-Type: application/json
{
    "DocumentFolderModel": {
        "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"
    },
    "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
FilteredDocumentFolderControllerModel
Response data
FilteredDocumentFolderControllerModel named DocumentFolderModel

Resource: DocumentFolder, Method: update

Updates model with properties given by request

Endpoint
PUT /document/api/v1/{clientUuid}/{facilityUuid}/document-folder/{Uuid}/
Example request 
PUT /document/api/v1/{clientUuid}/{facilityUuid}/document-folder/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 50
{
    "State": "ACTIVE",
    "Name": "My folder"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 943
Content-Type: application/json
{
    "DocumentFolderModel": {
        "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"
    },
    "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
FilteredDocumentFolderControllerModel
Response data
FilteredDocumentFolderControllerModel named DocumentFolderModel

Resource: DocumentFolder, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 943
Content-Type: application/json
{
    "DocumentFolderModel": {
        "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"
    },
    "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
FilteredDocumentFolderControllerModel named DocumentFolderModel

Resource: DocumentFolder, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 943
Content-Type: application/json
{
    "DocumentFolderModel": {
        "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"
    },
    "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
FilteredDocumentFolderControllerModel named DocumentFolderModel