API introspection – List packages, resources and their interfaces

Found 6 resources

Resource class Smartarchivo\Controller\Core\Api\V1\ActorController of type EntityController
No access control

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

Controller providing actor related actions like profile change, password update and others.

Name Type Size Default Description Visible Mutable Nullable
Type ENUM USER Value set: OWNER, USER yes no no
State ENUM INACTIVE Value set: INACTIVE, ACTIVE, LOCKED yes no no
MailAddress VARCHAR 128 not set yes no yes
Username VARCHAR 128 not set yes no yes
Realname VARCHAR 128 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 1 interfaces in class Smartarchivo\Controller\Core\Api\V1\ActorController

Resource: Actor, Method: load

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

Endpoint
GET /core/api/v1/actor/{uuid}/
Example request 
GET /core/api/v1/actor/{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: 864
Content-Type: application/json
{
    "ActorModel": {
        "Type": "OWNER",
        "State": "INACTIVE",
        "MailAddress": "john.doe@mail.com",
        "Username": "john.doe",
        "Realname": "John Doe",
        "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
FilteredActorControllerModel named ActorModel