API introspection – List packages, resources and their interfaces

Found 2 resources

Resource class Smartarchivo\Controller\CyclotronProduct\Api\V1\CyclotronProductController of type EntityController
No access control

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

Controller providing cyclotron product 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, COMPLETELY_APPLIED, IN_WASTE_MANAGED yes yes no
Manufacturer VARCHAR 128 not set yes yes no
BatchNumber VARCHAR 64 not set yes yes no
Isotope ENUM not set Value set: NITROGEN_13_N, FLUORINE_18_F, COBALT_58_CO, YTTRIUM_90_Y, INDIUM_111_IN, IODINE_123_I, IODINE_131_I, CESIUM_137_CS, ERBIUM_169_ER, LUTETIUM_177_LU, RHENIUM_186_RE yes yes no
Radiopharmaceutical VARCHAR 128 not set yes yes no
DeliveryDate DATE not set yes yes no
CalibrationDatetime TIMESTAMP not set yes yes no
ActivityUnit ENUM not set Value set: KILO_BEQUEREL, 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
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\CyclotronProduct\Api\V1\CyclotronProductController

Resource: CyclotronProduct, Method: load

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

Endpoint
GET /cyclotron-product/api/v1/{clientUuid}/{facilityUuid}/cyclotron-product/{uuid}/
Example request 
GET /cyclotron-product/api/v1/{clientUuid}/{facilityUuid}/cyclotron-product/{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: 1376
Content-Type: application/json
{
    "CyclotronProductModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Cyclotron product plus",
        "State": "ACTIVE",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "Isotope": "NITROGEN_13_N",
        "Radiopharmaceutical": "Radium 224 RA whatsoever",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "KILO_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": 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
FilteredCyclotronProductControllerModel named CyclotronProductModel

Resource: CyclotronProduct, Method: loadDefault

Loads an item holding the default attributes

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1376
Content-Type: application/json
{
    "CyclotronProductModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Cyclotron product plus",
        "State": "ACTIVE",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "Isotope": "NITROGEN_13_N",
        "Radiopharmaceutical": "Radium 224 RA whatsoever",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "KILO_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": 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
FilteredCyclotronProductControllerModel named CyclotronProductModel

Resource: CyclotronProduct, Method: create

Creates model with properties given by request

Endpoint
POST /cyclotron-product/api/v1/{clientUuid}/{facilityUuid}/cyclotron-product/
Example request 
POST /cyclotron-product/api/v1/{clientUuid}/{facilityUuid}/cyclotron-product
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 438
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Name": "Cyclotron product plus",
    "State": "ACTIVE",
    "Manufacturer": "ACME inc",
    "BatchNumber": "123abc-3654987",
    "Isotope": "NITROGEN_13_N",
    "Radiopharmaceutical": "Radium 224 RA whatsoever",
    "DeliveryDate": "2013-11-12",
    "CalibrationDatetime": "2013-11-12 16:39:00",
    "ActivityUnit": "KILO_BEQUEREL",
    "NominalActivity": 3.1415926535898,
    "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1376
Content-Type: application/json
{
    "CyclotronProductModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Cyclotron product plus",
        "State": "ACTIVE",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "Isotope": "NITROGEN_13_N",
        "Radiopharmaceutical": "Radium 224 RA whatsoever",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "KILO_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": 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
FilteredCyclotronProductControllerModel
Response data
FilteredCyclotronProductControllerModel named CyclotronProductModel

Resource: CyclotronProduct, Method: update

Updates model with properties given by request

Endpoint
PUT /cyclotron-product/api/v1/{clientUuid}/{facilityUuid}/cyclotron-product/{Uuid}/
Example request 
PUT /cyclotron-product/api/v1/{clientUuid}/{facilityUuid}/cyclotron-product/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 438
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Name": "Cyclotron product plus",
    "State": "ACTIVE",
    "Manufacturer": "ACME inc",
    "BatchNumber": "123abc-3654987",
    "Isotope": "NITROGEN_13_N",
    "Radiopharmaceutical": "Radium 224 RA whatsoever",
    "DeliveryDate": "2013-11-12",
    "CalibrationDatetime": "2013-11-12 16:39:00",
    "ActivityUnit": "KILO_BEQUEREL",
    "NominalActivity": 3.1415926535898,
    "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1376
Content-Type: application/json
{
    "CyclotronProductModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Cyclotron product plus",
        "State": "ACTIVE",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "Isotope": "NITROGEN_13_N",
        "Radiopharmaceutical": "Radium 224 RA whatsoever",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "KILO_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": 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
FilteredCyclotronProductControllerModel
Response data
FilteredCyclotronProductControllerModel named CyclotronProductModel

Resource: CyclotronProduct, Method: delete

Deletes the loaded model

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

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1376
Content-Type: application/json
{
    "CyclotronProductModel": {
        "Client": "123e4567-e89b-12d3-a456-426655440000",
        "Facility": "123e4567-e89b-12d3-a456-426655440000",
        "Name": "Cyclotron product plus",
        "State": "ACTIVE",
        "Manufacturer": "ACME inc",
        "BatchNumber": "123abc-3654987",
        "Isotope": "NITROGEN_13_N",
        "Radiopharmaceutical": "Radium 224 RA whatsoever",
        "DeliveryDate": "2013-11-12",
        "CalibrationDatetime": "2013-11-12 16:39:00",
        "ActivityUnit": "KILO_BEQUEREL",
        "NominalActivity": 3.1415926535898,
        "AcceptedBy": "123e4567-e89b-12d3-a456-426655440000",
        "AcceptedByName": null,
        "CurrentActivity": 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
FilteredCyclotronProductControllerModel named CyclotronProductModel