API introspection – List packages, resources and their interfaces

Found 2 resources

Resource class Smartarchivo\Controller\MaintenanceLog\Api\V1\MaintenanceLogEntryController of type EntityController
No access control

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

Controller providing maintenance log entry 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 VARCHAR 36 not set yes yes yes
DeviceName VIRTUAL not set yes no yes
Reporter VARCHAR 36 not set yes yes no
ReporterName VIRTUAL not set yes no yes
Solver VARCHAR 36 not set yes yes yes
SolverName VIRTUAL not set yes no yes
State ENUM ONGOING Value set: ONGOING, SOLVED yes yes no
IncidentTitle VARCHAR 64 not set yes yes no
IncidentCause VARCHAR 512 not set yes yes no
IncidentSolution VARCHAR 512 not set yes yes yes
IncidentDateStart TIMESTAMP not set yes yes no
IncidentDateEnd TIMESTAMP 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\MaintenanceLog\Api\V1\MaintenanceLogEntryController

Resource: MaintenanceLogEntry, Method: load

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

Endpoint
GET /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log/{uuid}/
Example request 
GET /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log/{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: 1423
Content-Type: application/json
{
    "MaintenanceLogEntryModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceName": "CT 2000",
        "Reporter": "123e4567-e89b-12d3-a456-426655440000",
        "ReporterName": "John Doe",
        "Solver": "123e4567-e89b-12d3-a456-426655440000",
        "SolverName": "Jane Doe",
        "State": "ONGOING",
        "IncidentTitle": "Title of the incident",
        "IncidentCause": "Description of the incident cause",
        "IncidentSolution": "Description of the incident solution",
        "IncidentDateStart": "2013-11-12 16:39:00",
        "IncidentDateEnd": "2013-11-12 16:39:00",
        "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
FilteredMaintenanceLogEntryControllerModel named MaintenanceLogEntryModel

Resource: MaintenanceLogEntry, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1423
Content-Type: application/json
{
    "MaintenanceLogEntryModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceName": "CT 2000",
        "Reporter": "123e4567-e89b-12d3-a456-426655440000",
        "ReporterName": "John Doe",
        "Solver": "123e4567-e89b-12d3-a456-426655440000",
        "SolverName": "Jane Doe",
        "State": "ONGOING",
        "IncidentTitle": "Title of the incident",
        "IncidentCause": "Description of the incident cause",
        "IncidentSolution": "Description of the incident solution",
        "IncidentDateStart": "2013-11-12 16:39:00",
        "IncidentDateEnd": "2013-11-12 16:39:00",
        "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
FilteredMaintenanceLogEntryControllerModel named MaintenanceLogEntryModel

Resource: MaintenanceLogEntry, Method: create

Creates model with properties given by request

Endpoint
POST /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log/
Example request 
POST /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 452
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Device": "123e4567-e89b-12d3-a456-426655440000",
    "Reporter": "123e4567-e89b-12d3-a456-426655440000",
    "Solver": "123e4567-e89b-12d3-a456-426655440000",
    "State": "ONGOING",
    "IncidentTitle": "Title of the incident",
    "IncidentCause": "Description of the incident cause",
    "IncidentSolution": "Description of the incident solution",
    "IncidentDateStart": "2013-11-12 16:39:00",
    "IncidentDateEnd": "2013-11-12 16:39:00"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1423
Content-Type: application/json
{
    "MaintenanceLogEntryModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceName": "CT 2000",
        "Reporter": "123e4567-e89b-12d3-a456-426655440000",
        "ReporterName": "John Doe",
        "Solver": "123e4567-e89b-12d3-a456-426655440000",
        "SolverName": "Jane Doe",
        "State": "ONGOING",
        "IncidentTitle": "Title of the incident",
        "IncidentCause": "Description of the incident cause",
        "IncidentSolution": "Description of the incident solution",
        "IncidentDateStart": "2013-11-12 16:39:00",
        "IncidentDateEnd": "2013-11-12 16:39:00",
        "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
FilteredMaintenanceLogEntryControllerModel
Response data
FilteredMaintenanceLogEntryControllerModel named MaintenanceLogEntryModel

Resource: MaintenanceLogEntry, Method: update

Updates model with properties given by request

Endpoint
PUT /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log/{Uuid}/
Example request 
PUT /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 452
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Device": "123e4567-e89b-12d3-a456-426655440000",
    "Reporter": "123e4567-e89b-12d3-a456-426655440000",
    "Solver": "123e4567-e89b-12d3-a456-426655440000",
    "State": "ONGOING",
    "IncidentTitle": "Title of the incident",
    "IncidentCause": "Description of the incident cause",
    "IncidentSolution": "Description of the incident solution",
    "IncidentDateStart": "2013-11-12 16:39:00",
    "IncidentDateEnd": "2013-11-12 16:39:00"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1423
Content-Type: application/json
{
    "MaintenanceLogEntryModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceName": "CT 2000",
        "Reporter": "123e4567-e89b-12d3-a456-426655440000",
        "ReporterName": "John Doe",
        "Solver": "123e4567-e89b-12d3-a456-426655440000",
        "SolverName": "Jane Doe",
        "State": "ONGOING",
        "IncidentTitle": "Title of the incident",
        "IncidentCause": "Description of the incident cause",
        "IncidentSolution": "Description of the incident solution",
        "IncidentDateStart": "2013-11-12 16:39:00",
        "IncidentDateEnd": "2013-11-12 16:39:00",
        "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
FilteredMaintenanceLogEntryControllerModel
Response data
FilteredMaintenanceLogEntryControllerModel named MaintenanceLogEntryModel

Resource: MaintenanceLogEntry, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1423
Content-Type: application/json
{
    "MaintenanceLogEntryModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Device": "123e4567-e89b-12d3-a456-426655440000",
        "DeviceName": "CT 2000",
        "Reporter": "123e4567-e89b-12d3-a456-426655440000",
        "ReporterName": "John Doe",
        "Solver": "123e4567-e89b-12d3-a456-426655440000",
        "SolverName": "Jane Doe",
        "State": "ONGOING",
        "IncidentTitle": "Title of the incident",
        "IncidentCause": "Description of the incident cause",
        "IncidentSolution": "Description of the incident solution",
        "IncidentDateStart": "2013-11-12 16:39:00",
        "IncidentDateEnd": "2013-11-12 16:39:00",
        "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
FilteredMaintenanceLogEntryControllerModel named MaintenanceLogEntryModel