API introspection – List packages, resources and their interfaces

Found 5 resources

Resource class Smartarchivo\Controller\Document\Api\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 5 interfaces in class Smartarchivo\Controller\Document\Api\V1\DocumentController

Resource: Document, Method: load

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

Endpoint
GET /document/api/v1/{clientUuid}/{facilityUuid}/document/{uuid}/
Example request 
GET /document/api/v1/{clientUuid}/{facilityUuid}/document/{uuid}
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: 1383
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": "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"
    },
    "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
FilteredDocumentControllerModel named DocumentModel

Resource: Document, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1383
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": "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"
    },
    "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
FilteredDocumentControllerModel named DocumentModel

Resource: Document, Method: create

Creates model with properties given by request

Endpoint
POST /document/api/v1/{clientUuid}/{facilityUuid}/document/
Example request 
POST /document/api/v1/{clientUuid}/{facilityUuid}/document
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 177
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Scope": "DOCUMENT_FOLDER",
    "ScopeReference": "123e4567-e89b-12d3-a456-426655440000",
    "State": "ACTIVE",
    "File": "File object",
    "Filename": "my-file.pdf"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1383
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": "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"
    },
    "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
FilteredDocumentControllerModel
Response data
FilteredDocumentControllerModel named DocumentModel

Resource: Document, Method: update

Updates model with properties given by request

Endpoint
PUT /document/api/v1/{clientUuid}/{facilityUuid}/document/{Uuid}/
Example request 
PUT /document/api/v1/{clientUuid}/{facilityUuid}/document/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 177
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Scope": "DOCUMENT_FOLDER",
    "ScopeReference": "123e4567-e89b-12d3-a456-426655440000",
    "State": "ACTIVE",
    "File": "File object",
    "Filename": "my-file.pdf"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1383
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": "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"
    },
    "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
FilteredDocumentControllerModel
Response data
FilteredDocumentControllerModel named DocumentModel

Resource: Document, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1383
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": "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"
    },
    "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
FilteredDocumentControllerModel named DocumentModel