API introspection – List packages, resources and their interfaces

Found 2 resources

Resource class Smartarchivo\Controller\MaintenanceLog\Api\V1\MaintenanceLogEntriesController of type CollectionController
No access control

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

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

Resource: MaintenanceLogEntries, Method: find

Loads a model collection or throws an exception

Endpoint
GET /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log-entries/
Example request 
GET /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log-entries
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: 2204
Content-Type: application/json
{
    "MaintenanceLogEntryModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "MaintenanceLogEntryModelCollection",
        "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
FilteredMaintenanceLogEntriesControllerModel[] named MaintenanceLogEntryModelCollection

Resource: MaintenanceLogEntries, 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 /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log-entries/page/{?page}/
Example request 
GET /maintenance-log/api/v1/{clientUuid}/{facilityUuid}/maintenance-log-entries/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: 2204
Content-Type: application/json
{
    "MaintenanceLogEntryModelCollection": [
        {
            "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"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "MaintenanceLogEntryModelCollection",
        "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
FilteredMaintenanceLogEntriesControllerModel[] named MaintenanceLogEntryModelCollection