API introspection – List packages, resources and their interfaces

Found 7 resources

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

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

Controller providing device 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
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
Identifier VARCHAR 128 not set yes yes yes
SerialNumber VARCHAR 128 not set yes yes yes
Location VARCHAR 128 not set yes yes 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\Device\Api\V1\DeviceController

Resource: Device, Method: load

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

Endpoint
GET /device/api/v1/{clientUuid}/{facilityUuid}/device/{uuid}/
Example request 
GET /device/api/v1/{clientUuid}/{facilityUuid}/device/{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: 1048
Content-Type: application/json
{
    "DeviceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "ACTIVIMETER",
        "Name": "CT 2000",
        "Identifier": "Siemens CT 2000",
        "SerialNumber": "CX-123654-987",
        "Location": "Im Keller",
        "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
FilteredDeviceControllerModel named DeviceModel

Resource: Device, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1048
Content-Type: application/json
{
    "DeviceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "ACTIVIMETER",
        "Name": "CT 2000",
        "Identifier": "Siemens CT 2000",
        "SerialNumber": "CX-123654-987",
        "Location": "Im Keller",
        "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
FilteredDeviceControllerModel named DeviceModel

Resource: Device, Method: create

Creates model with properties given by request

Endpoint
POST /device/api/v1/{clientUuid}/{facilityUuid}/device/
Example request 
POST /device/api/v1/{clientUuid}/{facilityUuid}/device
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 178
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": "ACTIVIMETER",
    "Name": "CT 2000",
    "Identifier": "Siemens CT 2000",
    "SerialNumber": "CX-123654-987",
    "Location": "Im Keller"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1048
Content-Type: application/json
{
    "DeviceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "ACTIVIMETER",
        "Name": "CT 2000",
        "Identifier": "Siemens CT 2000",
        "SerialNumber": "CX-123654-987",
        "Location": "Im Keller",
        "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
FilteredDeviceControllerModel
Response data
FilteredDeviceControllerModel named DeviceModel

Resource: Device, Method: update

Updates model with properties given by request

Endpoint
PUT /device/api/v1/{clientUuid}/{facilityUuid}/device/{Uuid}/
Example request 
PUT /device/api/v1/{clientUuid}/{facilityUuid}/device/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 178
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": "ACTIVIMETER",
    "Name": "CT 2000",
    "Identifier": "Siemens CT 2000",
    "SerialNumber": "CX-123654-987",
    "Location": "Im Keller"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1048
Content-Type: application/json
{
    "DeviceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "ACTIVIMETER",
        "Name": "CT 2000",
        "Identifier": "Siemens CT 2000",
        "SerialNumber": "CX-123654-987",
        "Location": "Im Keller",
        "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
FilteredDeviceControllerModel
Response data
FilteredDeviceControllerModel named DeviceModel

Resource: Device, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1048
Content-Type: application/json
{
    "DeviceModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Deletable": true,
        "State": "ACTIVE",
        "Type": "ACTIVIMETER",
        "Name": "CT 2000",
        "Identifier": "Siemens CT 2000",
        "SerialNumber": "CX-123654-987",
        "Location": "Im Keller",
        "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
FilteredDeviceControllerModel named DeviceModel