API introspection – List packages, resources and their interfaces

Found 9 resources

Resource class ContentVendor\Controller\Api\V1\LayoutController of type EntityController
Access controlled by ContentVendor\Core\Api\AccessRule\ApiAccessRule

Endpoint to recieve a layout model by its UUID

Name Type Size Default Description Visible Mutable Nullable
Fallback BOOLEAN false yes no no
Name VARCHAR 128 not set yes no no
Identifier VARCHAR 128 not set yes no no
CustomAttributes 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 1 interfaces in class ContentVendor\Controller\Api\V1\LayoutController

Resource: Layout, Method: load

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

Endpoint
GET /api/v1/layout/{uuid}/
Example request 
GET /api/v1/layout/{uuid}
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
Accept-Language: de-DE,de;q=0.8,en-US;q=0.5,en;q=0.3

HTTP/1.1 200 Ok
Date: Sat, 15 Feb 2020 13:52:06 +0000
Content-Length: 1336
Content-Type: application/json
Cache-Control: public, max-age=86400
Expires: Sun, 16 Feb 2020 13:52:06 GMT
Last-Modified: Sat, 15 Feb 2020 13:52:06 GMT
{
    "LayoutModel": {
        "Fallback": true,
        "Name": "Awesome three column deisgn",
        "Identifier": "THREE_COLUMN",
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000",
        "CustomAttributes": {
            "CUSTOM_ATTRIBUTE_IDENTIFIER_1": "Custom attribute string value",
            "CUSTOM_ATTRIBUTE_IDENTIFIER_2": true,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_3": 1279,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_4": 23.194687,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_5": [
                "Custom",
                "attribute list",
                "value"
            ],
            "CUSTOM_ATTRIBUTE_IDENTIFIER_6": "Custom attribute selected value from enum value set"
        }
    },
    "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
        }
    ]
}
GET /api/v1/layout/{uuid}
                      

                      Host: /                      

                      Accept: application/json
                                                                                              

                          Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=                                                  

                          Accept-Language: de-DE,de;q=0.8,en-US;q=0.5,en;q=0.3                                              
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Sat, 15 Feb 2020 13:52:06 +0000                      

                      Content-Length: 1336                      

                      Content-Type: application/json
                                              

                        {
    "LayoutModel": {
        "Fallback": true,
        "Name": "Awesome three column deisgn",
        "Identifier": "THREE_COLUMN",
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000",
        "CustomAttributes": {
            "CUSTOM_ATTRIBUTE_IDENTIFIER_1": "Custom attribute string value",
            "CUSTOM_ATTRIBUTE_IDENTIFIER_2": true,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_3": 1279,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_4": 23.194687,
            "CUSTOM_ATTRIBUTE_IDENTIFIER_5": [
                "Custom",
                "attribute list",
                "value"
            ],
            "CUSTOM_ATTRIBUTE_IDENTIFIER_6": "Custom attribute selected value from enum value set"
        }
    },
    "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 Token named Authorization
The Clients Last Modified Date Time As HTTP Date (RFC 2616) named If-Modified-Since
Response header
The Servers Cache Control Instruction named Cache-Control
The Servers Cache Expiration Instruction As HTTP Date (RFC 2616) named Expires
The Servers Last Modified Date Time As HTTP Date (RFC 2616) named Last-Modified
Response data
FilteredLayoutControllerModel named LayoutModel