API introspection – List packages, resources and their interfaces

Found 4 resources

Resource class Smartarchivo\Controller\Generator\Api\V1\GeneratorEluatController of type EntityController
No access control

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

Controller providing generator eluat related actions like deletion.

Name Type Size Default Description Visible Mutable Nullable
Generator VIRTUAL not set yes no yes
State ENUM ACTIVE Value set: ACTIVE, IN_WASTE_MANAGEMENT yes yes no
Supplemented BOOLEAN yes yes no
ExtractionDatetime TIMESTAMP not set yes yes no
Activity FLOAT not set yes yes no
ActivityUnit ENUM MEGA_BEQUEREL Value set: MEGA_BEQUEREL, GIGA_BEQUEREL yes yes no
ExtractedBy VARCHAR 36 not set yes yes yes
ExtractedByName VIRTUAL 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 5 interfaces in class Smartarchivo\Controller\Generator\Api\V1\GeneratorEluatController

Resource: GeneratorEluat, Method: load

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

Endpoint
GET /generator/api/v1/{clientUuid}/{facilityUuid}/generator-eluat/{uuid}/
Example request 
GET /generator/api/v1/{clientUuid}/{facilityUuid}/generator-eluat/{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: 1022
Content-Type: application/json
{
    "GeneratorEluatModel": {
        "Generator": null,
        "State": "ACTIVE",
        "Supplemented": true,
        "ExtractionDatetime": "2013-11-12 16:39:00",
        "Activity": 3.1415926535898,
        "ActivityUnit": "MEGA_BEQUEREL",
        "ExtractedBy": "123e4567-e89b-12d3-a456-426655440000",
        "ExtractedByName": null,
        "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
FilteredGeneratorEluatControllerModel named GeneratorEluatModel

Resource: GeneratorEluat, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1022
Content-Type: application/json
{
    "GeneratorEluatModel": {
        "Generator": null,
        "State": "ACTIVE",
        "Supplemented": true,
        "ExtractionDatetime": "2013-11-12 16:39:00",
        "Activity": 3.1415926535898,
        "ActivityUnit": "MEGA_BEQUEREL",
        "ExtractedBy": "123e4567-e89b-12d3-a456-426655440000",
        "ExtractedByName": null,
        "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
FilteredGeneratorEluatControllerModel named GeneratorEluatModel

Resource: GeneratorEluat, Method: create

Creates model with properties given by request

Endpoint
POST /generator/api/v1/{clientUuid}/{facilityUuid}/generator-eluat/
Example request 
POST /generator/api/v1/{clientUuid}/{facilityUuid}/generator-eluat
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 229
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "State": "ACTIVE",
    "Supplemented": true,
    "ExtractionDatetime": "2013-11-12 16:39:00",
    "Activity": 3.1415926535898,
    "ActivityUnit": "MEGA_BEQUEREL",
    "ExtractedBy": "123e4567-e89b-12d3-a456-426655440000"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1022
Content-Type: application/json
{
    "GeneratorEluatModel": {
        "Generator": null,
        "State": "ACTIVE",
        "Supplemented": true,
        "ExtractionDatetime": "2013-11-12 16:39:00",
        "Activity": 3.1415926535898,
        "ActivityUnit": "MEGA_BEQUEREL",
        "ExtractedBy": "123e4567-e89b-12d3-a456-426655440000",
        "ExtractedByName": null,
        "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
FilteredGeneratorEluatControllerModel
Response data
FilteredGeneratorEluatControllerModel named GeneratorEluatModel

Resource: GeneratorEluat, Method: update

Updates model with properties given by request

Endpoint
PUT /generator/api/v1/{clientUuid}/{facilityUuid}/generator-eluat/{Uuid}/
Example request 
PUT /generator/api/v1/{clientUuid}/{facilityUuid}/generator-eluat/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 229
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "State": "ACTIVE",
    "Supplemented": true,
    "ExtractionDatetime": "2013-11-12 16:39:00",
    "Activity": 3.1415926535898,
    "ActivityUnit": "MEGA_BEQUEREL",
    "ExtractedBy": "123e4567-e89b-12d3-a456-426655440000"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1022
Content-Type: application/json
{
    "GeneratorEluatModel": {
        "Generator": null,
        "State": "ACTIVE",
        "Supplemented": true,
        "ExtractionDatetime": "2013-11-12 16:39:00",
        "Activity": 3.1415926535898,
        "ActivityUnit": "MEGA_BEQUEREL",
        "ExtractedBy": "123e4567-e89b-12d3-a456-426655440000",
        "ExtractedByName": null,
        "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
FilteredGeneratorEluatControllerModel
Response data
FilteredGeneratorEluatControllerModel named GeneratorEluatModel

Resource: GeneratorEluat, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1022
Content-Type: application/json
{
    "GeneratorEluatModel": {
        "Generator": null,
        "State": "ACTIVE",
        "Supplemented": true,
        "ExtractionDatetime": "2013-11-12 16:39:00",
        "Activity": 3.1415926535898,
        "ActivityUnit": "MEGA_BEQUEREL",
        "ExtractedBy": "123e4567-e89b-12d3-a456-426655440000",
        "ExtractedByName": null,
        "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
FilteredGeneratorEluatControllerModel named GeneratorEluatModel