API introspection – List packages, resources and their interfaces

Found 9 resources

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

Endpoint to recieve an published or time controlled online article model by its UUID, URI or nice URI

Name Type Size Default Description Visible Mutable Nullable
State ENUM DRAFT Value set: DRAFT, PUBLISHED, TIME_CONTROLLED yes no no
TimeControlledPublishedFrom DATE not set yes no yes
TimeControlledPublishedTo DATE not set yes no yes
Name VARCHAR 128 not set yes no no
Uri VARCHAR 512 not set yes no no
NiceUri VARCHAR 512 not set yes no no
ShortUri VARCHAR 512 not set yes no yes
Href VIRTUAL not set yes no yes
Restricted BOOLEAN false yes no no
Page VIRTUAL not set yes no yes
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\ArticleController

Resource: Article, Method: load

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

Endpoint
GET /api/v1/article/{uuid}/
Example request 
GET /api/v1/article/{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: 9672
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
{
    "ArticleModel": {
        "State": "PUBLISHED",
        "TimeControlledPublishedFrom": "2019-07-09",
        "TimeControlledPublishedTo": "2019-07-09",
        "Name": "Awesome structural element",
        "Restricted": true,
        "Uri": "cb364ed1-13a5-4e03-b6d4-e6bba767b519\/e96b4eb8-6a60-4d16-93f7-ea2aa45179f6",
        "NiceUri": "awesome-space\/parent-structural-element\/awesome-structural-element",
        "ShortUri": "short-string",
        "Href": "\/parent-structural-element\/awesome-structural-element\/",
        "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"
        },
        "Page": {
            "Language": {
                "State": "DRAFT",
                "Fallback": true,
                "Code": "EN_US",
                "TextDirection": "LEFT_TO_RIGHT",
                "FirstDayOfWeek": "SUNDAY",
                "DateFormat": "Y-m-d",
                "TimeFormat": "H:i:s",
                "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"
                }
            },
            "Layout": {
                "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"
                }
            },
            "Author": {
                "Type": "SYSADMIN",
                "MailAddress": "john.doe@mail.com",
                "Username": "jdoe",
                "Realname": "John Doe",
                "AvatarUrl": "\/api\/v1\/author\/123e4567-e89b-12d3-a456-426655440000\/avatar\/512\/",
                "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"
                }
            },
            "State": "DRAFT",
            "TimeControlledPublishedFrom": "2013-11-12",
            "TimeControlledPublishedTo": "2013-11-12",
            "Redirect": "NONE",
            "RedirectArticle": {
                "State": "PUBLISHED",
                "TimeControlledPublishedFrom": "2019-07-09",
                "TimeControlledPublishedTo": "2019-07-09",
                "Name": "Awesome structural element",
                "Restricted": true,
                "Uri": "cb364ed1-13a5-4e03-b6d4-e6bba767b519\/e96b4eb8-6a60-4d16-93f7-ea2aa45179f6",
                "NiceUri": "awesome-space\/parent-structural-element\/awesome-structural-element",
                "ShortUri": "short-string",
                "Href": "\/parent-structural-element\/awesome-structural-element\/",
                "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"
                }
            },
            "RedirectUrl": "https:\/\/markenwerk.net\/",
            "Name": "Awesome content holding element",
            "Keywords": [
                "this",
                "that",
                "other thing"
            ],
            "Summary": "Short summary of the page contents",
            "Uri": "cb364ed1-13a5-4e03-b6d4-e6bba767b519\/e96b4eb8-6a60-4d16-93f7-ea2aa45179f6\/123e4567-e89b-12d3-a456-426655440000",
            "NiceUri": "awesome-space\/parent-structural-element\/awesome-structural-element\/awesome-content-holding-element",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "LayoutSections": [
                {
                    "Name": "Main section",
                    "Identifier": "MAIN",
                    "CreatedAt": "2013-11-12 16:39:00",
                    "UpdatedAt": "2013-11-12 16:39:00",
                    "Uuid": "123e4567-e89b-12d3-a456-426655440000",
                    "BlockInstances": [
                        {
                            "State": "DRAFT",
                            "TimeControlPublishDatetime": "2013-11-12 16:39:00",
                            "TimeControlUnpublishDatetime": "2013-11-12 16:39:00",
                            "Name": "Awesome content holding element",
                            "AttributedContent": {
                                "ImageAsset": null,
                                "ImageTitle": "Image title",
                                "ImageAlternativeText": "Image alternative text",
                                "ImageDescription": "Image short description"
                            },
                            "Modifiers": [
                                "HEADER",
                                "HERO"
                            ],
                            "CreatedAt": "2013-11-12 16:39:00",
                            "UpdatedAt": "2013-11-12 16:39:00",
                            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
                            "Block": {
                                "ClassPath": "ContentVendor\\Block\\Core\\ImageBlock",
                                "DisplayName": "Image block",
                                "IconName": "image",
                                "Version": "4.0.21-rc.12",
                                "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/article/{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: 9672                      

                      Content-Type: application/json
                                              

                        {
    "ArticleModel": {
        "State": "PUBLISHED",
        "TimeControlledPublishedFrom": "2019-07-09",
        "TimeControlledPublishedTo": "2019-07-09",
        "Name": "Awesome structural element",
        "Restricted": true,
        "Uri": "cb364ed1-13a5-4e03-b6d4-e6bba767b519\/e96b4eb8-6a60-4d16-93f7-ea2aa45179f6",
        "NiceUri": "awesome-space\/parent-structural-element\/awesome-structural-element",
        "ShortUri": "short-string",
        "Href": "\/parent-structural-element\/awesome-structural-element\/",
        "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"
        },
        "Page": {
            "Language": {
                "State": "DRAFT",
                "Fallback": true,
                "Code": "EN_US",
                "TextDirection": "LEFT_TO_RIGHT",
                "FirstDayOfWeek": "SUNDAY",
                "DateFormat": "Y-m-d",
                "TimeFormat": "H:i:s",
                "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"
                }
            },
            "Layout": {
                "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"
                }
            },
            "Author": {
                "Type": "SYSADMIN",
                "MailAddress": "john.doe@mail.com",
                "Username": "jdoe",
                "Realname": "John Doe",
                "AvatarUrl": "\/api\/v1\/author\/123e4567-e89b-12d3-a456-426655440000\/avatar\/512\/",
                "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"
                }
            },
            "State": "DRAFT",
            "TimeControlledPublishedFrom": "2013-11-12",
            "TimeControlledPublishedTo": "2013-11-12",
            "Redirect": "NONE",
            "RedirectArticle": {
                "State": "PUBLISHED",
                "TimeControlledPublishedFrom": "2019-07-09",
                "TimeControlledPublishedTo": "2019-07-09",
                "Name": "Awesome structural element",
                "Restricted": true,
                "Uri": "cb364ed1-13a5-4e03-b6d4-e6bba767b519\/e96b4eb8-6a60-4d16-93f7-ea2aa45179f6",
                "NiceUri": "awesome-space\/parent-structural-element\/awesome-structural-element",
                "ShortUri": "short-string",
                "Href": "\/parent-structural-element\/awesome-structural-element\/",
                "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"
                }
            },
            "RedirectUrl": "https:\/\/markenwerk.net\/",
            "Name": "Awesome content holding element",
            "Keywords": [
                "this",
                "that",
                "other thing"
            ],
            "Summary": "Short summary of the page contents",
            "Uri": "cb364ed1-13a5-4e03-b6d4-e6bba767b519\/e96b4eb8-6a60-4d16-93f7-ea2aa45179f6\/123e4567-e89b-12d3-a456-426655440000",
            "NiceUri": "awesome-space\/parent-structural-element\/awesome-structural-element\/awesome-content-holding-element",
            "CreatedAt": "2013-11-12 16:39:00",
            "UpdatedAt": "2013-11-12 16:39:00",
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "LayoutSections": [
                {
                    "Name": "Main section",
                    "Identifier": "MAIN",
                    "CreatedAt": "2013-11-12 16:39:00",
                    "UpdatedAt": "2013-11-12 16:39:00",
                    "Uuid": "123e4567-e89b-12d3-a456-426655440000",
                    "BlockInstances": [
                        {
                            "State": "DRAFT",
                            "TimeControlPublishDatetime": "2013-11-12 16:39:00",
                            "TimeControlUnpublishDatetime": "2013-11-12 16:39:00",
                            "Name": "Awesome content holding element",
                            "AttributedContent": {
                                "ImageAsset": null,
                                "ImageTitle": "Image title",
                                "ImageAlternativeText": "Image alternative text",
                                "ImageDescription": "Image short description"
                            },
                            "Modifiers": [
                                "HEADER",
                                "HERO"
                            ],
                            "CreatedAt": "2013-11-12 16:39:00",
                            "UpdatedAt": "2013-11-12 16:39:00",
                            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
                            "Block": {
                                "ClassPath": "ContentVendor\\Block\\Core\\ImageBlock",
                                "DisplayName": "Image block",
                                "IconName": "image",
                                "Version": "4.0.21-rc.12",
                                "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
Acceptable Languages named Accept-Language
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
FilteredArticleControllerModel named ArticleModel