API introspection – List packages, resources and their interfaces

Found 7 resources

Resource class Smartarchivo\Controller\Device\Api\V1\SequenceController of type EntityController
No access control

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

Controller providing sequence 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
Device VIRTUAL not set yes no yes
DeviceType VIRTUAL not set yes no yes
Deletable BOOLEAN 1 yes no no
State ENUM ACTIVE Value set: ACTIVE, ARCHIVED yes yes no
Type VARCHAR 128 not set yes yes no
Name VARCHAR 128 not set yes yes no
NotificationMailAddress VARCHAR 128 not set yes yes yes
DownloadUrl VIRTUAL not set yes no yes
SequenceConfiguration OBJECT not set yes yes no
SequenceMemory OBJECT 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 6 interfaces in class Smartarchivo\Controller\Device\Api\V1\SequenceController

Resource: Sequence, Method: load

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

Endpoint
GET /device/api/v1/{clientUuid}/{facilityUuid}/sequence/{uuid}/
Example request 
GET /device/api/v1/{clientUuid}/{facilityUuid}/sequence/{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: 1338
Content-Type: application/json
{
    "SequenceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceType": "ACTIVIMETER",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "BACKGROUND_COUNT_BARIUM",
        "Name": "Rotop Zweistreifen Spezial",
        "NotificationMailAddress": "support@domain.tld",
        "DownloadUrl": null,
        "SequenceConfiguration": "An object expressed following the object notation conventions.",
        "SequenceMemory": "An object expressed following the object notation conventions.",
        "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
FilteredSequenceControllerModel named SequenceModel

Resource: Sequence, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1338
Content-Type: application/json
{
    "SequenceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceType": "ACTIVIMETER",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "BACKGROUND_COUNT_BARIUM",
        "Name": "Rotop Zweistreifen Spezial",
        "NotificationMailAddress": "support@domain.tld",
        "DownloadUrl": null,
        "SequenceConfiguration": "An object expressed following the object notation conventions.",
        "SequenceMemory": "An object expressed following the object notation conventions.",
        "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
FilteredSequenceControllerModel named SequenceModel

Resource: Sequence, Method: create

Creates model with properties given by request

Endpoint
POST /device/api/v1/{clientUuid}/{facilityUuid}/sequence/
Example request 
POST /device/api/v1/{clientUuid}/{facilityUuid}/sequence
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 342
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "State": "ACTIVE",
    "Type": "BACKGROUND_COUNT_BARIUM",
    "Name": "Rotop Zweistreifen Spezial",
    "NotificationMailAddress": "support@domain.tld",
    "SequenceConfiguration": "An object expressed following the object notation conventions.",
    "SequenceMemory": "An object expressed following the object notation conventions."
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1338
Content-Type: application/json
{
    "SequenceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceType": "ACTIVIMETER",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "BACKGROUND_COUNT_BARIUM",
        "Name": "Rotop Zweistreifen Spezial",
        "NotificationMailAddress": "support@domain.tld",
        "DownloadUrl": null,
        "SequenceConfiguration": "An object expressed following the object notation conventions.",
        "SequenceMemory": "An object expressed following the object notation conventions.",
        "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
FilteredSequenceControllerModel
Response data
FilteredSequenceControllerModel named SequenceModel

Resource: Sequence, Method: update

Updates model with properties given by request

Endpoint
PUT /device/api/v1/{clientUuid}/{facilityUuid}/sequence/{uuid}/
Example request 
PUT /device/api/v1/{clientUuid}/{facilityUuid}/sequence/{uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 342
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "State": "ACTIVE",
    "Type": "BACKGROUND_COUNT_BARIUM",
    "Name": "Rotop Zweistreifen Spezial",
    "NotificationMailAddress": "support@domain.tld",
    "SequenceConfiguration": "An object expressed following the object notation conventions.",
    "SequenceMemory": "An object expressed following the object notation conventions."
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1338
Content-Type: application/json
{
    "SequenceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceType": "ACTIVIMETER",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "BACKGROUND_COUNT_BARIUM",
        "Name": "Rotop Zweistreifen Spezial",
        "NotificationMailAddress": "support@domain.tld",
        "DownloadUrl": null,
        "SequenceConfiguration": "An object expressed following the object notation conventions.",
        "SequenceMemory": "An object expressed following the object notation conventions.",
        "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
FilteredSequenceControllerModel
Response data
FilteredSequenceControllerModel named SequenceModel

Resource: Sequence, Method: delete

Deletes the loaded model

Endpoint
DELETE /device/api/v1/{clientUuid}/{facilityUuid}/sequence/{uuid}/
Example request 
DELETE /device/api/v1/{clientUuid}/{facilityUuid}/sequence/{uuid}
Host: /
Accept: application/json

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1338
Content-Type: application/json
{
    "SequenceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceType": "ACTIVIMETER",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "BACKGROUND_COUNT_BARIUM",
        "Name": "Rotop Zweistreifen Spezial",
        "NotificationMailAddress": "support@domain.tld",
        "DownloadUrl": null,
        "SequenceConfiguration": "An object expressed following the object notation conventions.",
        "SequenceMemory": "An object expressed following the object notation conventions.",
        "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
FilteredSequenceControllerModel named SequenceModel

Resource: Sequence, Method: records

Loads records for the sequence

Endpoint
GET /device/api/v1/{clientUuid}/{facilityUuid}/sequence/{uuid}/records/
Example request 
GET /device/api/v1/{clientUuid}/{facilityUuid}/sequence/{uuid}/records
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: 2277
Content-Type: application/json
{
    "RecordModelCollection": [
        {
            "Client": "123e4567-e89b-12d3-a456-426655440000",
            "Facility": "123e4567-e89b-12d3-a456-426655440000",
            "Device": "123e4567-e89b-12d3-a456-426655440000",
            "DeviceType": "ACTIVIMETER",
            "Sequence": "123e4567-e89b-12d3-a456-426655440000",
            "SequenceType": "BACKGROUND_COUNT_BARIUM",
            "Documents": [
                "123e4567-e89b-12d3-a456-426655440000",
                "123e4567-e89b-12d3-a456-426655440000"
            ],
            "Supplemented": true,
            "Replaced": true,
            "Replaces": "123e4567-e89b-12d3-a456-426655440000",
            "RecordedAt": "2013-11-12 16:39:00",
            "RecordedByName": "Jane Doe",
            "UpdatedByName": "John Doe",
            "RecordConfiguration": "An object expressed following the object notation conventions.",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "RecordModelCollection",
        "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
FilteredRecordsControllerModel[] named RecordModelCollection