API introspection – List packages, resources and their interfaces

Found 4 resources

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

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

Controller providing report 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
Name VARCHAR 128 not set yes yes no
State ENUM ACTIVE Value set: ACTIVE, DISPATCHED yes yes no
Isotope ENUM MOLYBDENUM_99_MO Value set: MOLYBDENUM_99_MO, GERMANIUM_68_GE yes yes no
Manufacturer VARCHAR 128 not set yes yes no
BatchNumber VARCHAR 64 not set yes yes no
SerialNumber VARCHAR 64 not set yes yes no
DeliveryDate DATE not set yes yes no
CalibrationDatetime TIMESTAMP not set yes yes no
ActivityUnit ENUM MEGA_BEQUEREL Value set: MEGA_BEQUEREL, GIGA_BEQUEREL yes yes no
NominalActivity FLOAT not set yes yes no
AcceptedBy VARCHAR 36 not set yes yes no
AcceptedByName VIRTUAL not set yes no yes
CurrentActivity VIRTUAL not set yes no yes
DispatchDatetime TIMESTAMP not set yes yes yes
DispatchedBy VARCHAR 36 not set yes yes yes
DispatchedActivity FLOAT not set yes yes yes
DispatchedSurfaceContamination FLOAT not set yes yes yes
DispatchedDoseRate FLOAT not set yes yes yes
DispatchedByName 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\GeneratorController

Resource: Generator, Method: load

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

Endpoint
GET /generator/api/v1/{clientUuid}/{facilityUuid}/generator/{uuid}/
Example request 
GET /generator/api/v1/{clientUuid}/{facilityUuid}/generator/{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: 1649
Content-Type: application/json
{
    "GeneratorModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Generator 5000",
        "State": "ACTIVE",
        "Isotope": "MOLYBDENUM_99_MO",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "SerialNumber": "3654987-123abc",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "MEGA_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": null,
        "DispatchDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedActivity": 3.1415926535898,
        "DispatchedSurfaceContamination": 3.1415926535898,
        "DispatchedDoseRate": 3.1415926535898,
        "DispatchedByName": 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
FilteredGeneratorControllerModel named GeneratorModel

Resource: Generator, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1649
Content-Type: application/json
{
    "GeneratorModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Generator 5000",
        "State": "ACTIVE",
        "Isotope": "MOLYBDENUM_99_MO",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "SerialNumber": "3654987-123abc",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "MEGA_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": null,
        "DispatchDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedActivity": 3.1415926535898,
        "DispatchedSurfaceContamination": 3.1415926535898,
        "DispatchedDoseRate": 3.1415926535898,
        "DispatchedByName": 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
FilteredGeneratorControllerModel named GeneratorModel

Resource: Generator, Method: create

Creates model with properties given by request

Endpoint
POST /generator/api/v1/{clientUuid}/{facilityUuid}/generator/
Example request 
POST /generator/api/v1/{clientUuid}/{facilityUuid}/generator
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 664
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Name": "Generator 5000",
    "State": "ACTIVE",
    "Isotope": "MOLYBDENUM_99_MO",
    "Manufacturer": "ACME inc",
    "BatchNumber": "123abc-3654987",
    "SerialNumber": "3654987-123abc",
    "DeliveryDate": "2013-11-12",
    "CalibrationDatetime": "2013-11-12 16:39:00",
    "ActivityUnit": "MEGA_BEQUEREL",
    "NominalActivity": 3.1415926535898,
    "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
    "DispatchDatetime": "2013-11-12 16:39:00",
    "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
    "DispatchedActivity": 3.1415926535898,
    "DispatchedSurfaceContamination": 3.1415926535898,
    "DispatchedDoseRate": 3.1415926535898
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1649
Content-Type: application/json
{
    "GeneratorModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Generator 5000",
        "State": "ACTIVE",
        "Isotope": "MOLYBDENUM_99_MO",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "SerialNumber": "3654987-123abc",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "MEGA_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": null,
        "DispatchDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedActivity": 3.1415926535898,
        "DispatchedSurfaceContamination": 3.1415926535898,
        "DispatchedDoseRate": 3.1415926535898,
        "DispatchedByName": 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
FilteredGeneratorControllerModel
Response data
FilteredGeneratorControllerModel named GeneratorModel

Resource: Generator, Method: update

Updates model with properties given by request

Endpoint
PUT /generator/api/v1/{clientUuid}/{facilityUuid}/generator/{Uuid}/
Example request 
PUT /generator/api/v1/{clientUuid}/{facilityUuid}/generator/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 664
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Name": "Generator 5000",
    "State": "ACTIVE",
    "Isotope": "MOLYBDENUM_99_MO",
    "Manufacturer": "ACME inc",
    "BatchNumber": "123abc-3654987",
    "SerialNumber": "3654987-123abc",
    "DeliveryDate": "2013-11-12",
    "CalibrationDatetime": "2013-11-12 16:39:00",
    "ActivityUnit": "MEGA_BEQUEREL",
    "NominalActivity": 3.1415926535898,
    "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
    "DispatchDatetime": "2013-11-12 16:39:00",
    "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
    "DispatchedActivity": 3.1415926535898,
    "DispatchedSurfaceContamination": 3.1415926535898,
    "DispatchedDoseRate": 3.1415926535898
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1649
Content-Type: application/json
{
    "GeneratorModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Generator 5000",
        "State": "ACTIVE",
        "Isotope": "MOLYBDENUM_99_MO",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "SerialNumber": "3654987-123abc",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "MEGA_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": null,
        "DispatchDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedActivity": 3.1415926535898,
        "DispatchedSurfaceContamination": 3.1415926535898,
        "DispatchedDoseRate": 3.1415926535898,
        "DispatchedByName": 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
FilteredGeneratorControllerModel
Response data
FilteredGeneratorControllerModel named GeneratorModel

Resource: Generator, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1649
Content-Type: application/json
{
    "GeneratorModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Generator 5000",
        "State": "ACTIVE",
        "Isotope": "MOLYBDENUM_99_MO",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "SerialNumber": "3654987-123abc",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "MEGA_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": null,
        "DispatchDatetime": "2013-11-12 16:39:00",
        "DispatchedBy": "123e4567-e89b-12d3-a456-426655440000",
        "DispatchedActivity": 3.1415926535898,
        "DispatchedSurfaceContamination": 3.1415926535898,
        "DispatchedDoseRate": 3.1415926535898,
        "DispatchedByName": 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
FilteredGeneratorControllerModel named GeneratorModel