API introspection – List packages, resources and their interfaces

Found 7 resources

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

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

Controller providing sequence related actions.

Name Type Size Default Description Visible Mutable Nullable
ReplacedRecordId INTEGER not set no yes yes
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
Sequence VIRTUAL not set yes no yes
SequenceType VIRTUAL not set yes no yes
SequenceMemory VIRTUAL not set yes no yes
Documents VIRTUAL not set yes no yes
Supplemented BOOLEAN yes yes no
Replaced BOOLEAN yes yes no
Replaces VIRTUAL not set yes no yes
RecordedAt TIMESTAMP not set yes yes no
RecordedByName VIRTUAL not set yes no yes
UpdatedByName VIRTUAL not set yes no yes
RecordConfiguration OBJECT not set yes yes no
Valuation ENUM UNKNOWN Value set: UNKNOWN, UNDEFINED, ACCEPTABLE, NOTICEABLE, UNACCEPTABLE 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\Device\Api\V1\RecordController

Resource: Record, Method: load

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

Endpoint
GET /device/api/v1/record/{clientUuid}/{facilityUuid}/{uuid}/
Example request 
GET /device/api/v1/record/{clientUuid}/{facilityUuid}/{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: 1764
Content-Type: application/json
{
    "RecordModel": {
        "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",
        "SequenceMemory": {
            "type": "MEAN_ADJUSTED_VALUE",
            "initialValueRecordedAt": 1677581144207,
            "meanAdjustedValue": 4.1415926535898,
            "latestRecordValuation": "ACCEPTABLE"
        },
        "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.",
        "Valuation": "UNKNOWN",
        "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
FilteredRecordControllerModel named RecordModel

Resource: Record, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1764
Content-Type: application/json
{
    "RecordModel": {
        "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",
        "SequenceMemory": {
            "type": "MEAN_ADJUSTED_VALUE",
            "initialValueRecordedAt": 1677581144207,
            "meanAdjustedValue": 4.1415926535898,
            "latestRecordValuation": "ACCEPTABLE"
        },
        "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.",
        "Valuation": "UNKNOWN",
        "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
FilteredRecordControllerModel named RecordModel

Resource: Record, Method: create

Creates model with properties given by request

Endpoint
POST /device/api/v1/{clientUuid}/{facilityUuid}/record/
Example request 
POST /device/api/v1/{clientUuid}/{facilityUuid}/record
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 242
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "ReplacedRecordId": null,
    "Supplemented": true,
    "Replaced": true,
    "RecordedAt": "2013-11-12 16:39:00",
    "RecordConfiguration": "An object expressed following the object notation conventions.",
    "Valuation": "UNKNOWN"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1764
Content-Type: application/json
{
    "RecordModel": {
        "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",
        "SequenceMemory": {
            "type": "MEAN_ADJUSTED_VALUE",
            "initialValueRecordedAt": 1677581144207,
            "meanAdjustedValue": 4.1415926535898,
            "latestRecordValuation": "ACCEPTABLE"
        },
        "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.",
        "Valuation": "UNKNOWN",
        "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
FilteredRecordControllerModel
Response data
FilteredRecordControllerModel named RecordModel

Resource: Record, Method: update

Updates model with properties given by request

Endpoint
PUT /device/api/v1/{clientUuid}/{facilityUuid}/record/{Uuid}/
Example request 
PUT /device/api/v1/{clientUuid}/{facilityUuid}/record/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 242
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "ReplacedRecordId": null,
    "Supplemented": true,
    "Replaced": true,
    "RecordedAt": "2013-11-12 16:39:00",
    "RecordConfiguration": "An object expressed following the object notation conventions.",
    "Valuation": "UNKNOWN"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1764
Content-Type: application/json
{
    "RecordModel": {
        "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",
        "SequenceMemory": {
            "type": "MEAN_ADJUSTED_VALUE",
            "initialValueRecordedAt": 1677581144207,
            "meanAdjustedValue": 4.1415926535898,
            "latestRecordValuation": "ACCEPTABLE"
        },
        "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.",
        "Valuation": "UNKNOWN",
        "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
FilteredRecordControllerModel
Response data
FilteredRecordControllerModel named RecordModel

Resource: Record, Method: delete

Deletes the loaded model

Endpoint
DELETE /device/api/v1/{clientUuid}/{facilityUuid}/record/{Uuid}/
Example request 
DELETE /device/api/v1/{clientUuid}/{facilityUuid}/record/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 242
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "ReplacedRecordId": null,
    "Supplemented": true,
    "Replaced": true,
    "RecordedAt": "2013-11-12 16:39:00",
    "RecordConfiguration": "An object expressed following the object notation conventions.",
    "Valuation": "UNKNOWN"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1764
Content-Type: application/json
{
    "RecordModel": {
        "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",
        "SequenceMemory": {
            "type": "MEAN_ADJUSTED_VALUE",
            "initialValueRecordedAt": 1677581144207,
            "meanAdjustedValue": 4.1415926535898,
            "latestRecordValuation": "ACCEPTABLE"
        },
        "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.",
        "Valuation": "UNKNOWN",
        "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
FilteredRecordControllerModel named RecordModel