API introspection – List packages, resources and their interfaces

Found 6 resources

Resource class Smartarchivo\Controller\Device\ReportApi\V1\SequencesController of type CollectionController
No access control

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

Controller providing sequence 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
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 no no
Type VARCHAR 128 not set yes no no
Name VARCHAR 128 not set yes no no
NotificationMailAddress VARCHAR 128 not set yes no yes
DownloadUrl VIRTUAL not set yes no yes
SequenceConfiguration OBJECT not set yes no no
SequenceMemory OBJECT 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\Device\ReportApi\V1\SequencesController

Resource: Sequences, Method: find

Loads a model collection or throws an exception

Endpoint
GET /device/report-api/v1/sequences/
Example request 
GET /device/report-api/v1/sequences
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: 2100
Content-Type: application/json
{
    "SequenceModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "SequenceModelCollection",
        "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
FilteredSequencesControllerModel[] named SequenceModelCollection

Resource: Sequences, 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 /device/report-api/v1/sequences/page/{?page}/
Example request 
GET /device/report-api/v1/sequences/page/{?page}
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: 2100
Content-Type: application/json
{
    "SequenceModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "SequenceModelCollection",
        "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
FilteredSequencesControllerModel[] named SequenceModelCollection