API introspection – List packages, resources and their interfaces

Found 9 resources

Resource class ContentVendor\Controller\Api\V1\NavigationController of type CollectionController
Access controlled by ContentVendor\Core\Api\AccessRule\ApiAccessRule

Endpoint to recieve a collection of all provided navigation models

Name Type Size Default Description Visible Mutable Nullable
Article VIRTUAL not set yes no yes
Identifier VARCHAR 128 not set yes no no
Fallback BOOLEAN false yes no no
CreatedAt TIMESTAMP not set yes no yes
UpdatedAt TIMESTAMP not set yes no yes
Uuid VARCHAR 36 not set yes no no
CustomAttributes VIRTUAL not set yes no yes

Interfaces

Found 2 interfaces in class ContentVendor\Controller\Api\V1\NavigationController

Resource: Navigation, Method: find

Loads a model collection or throws an exception

Endpoint
GET /api/v1/navigation/
Example request 
GET /api/v1/navigation
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: 3459
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
{
    "NavigationModelCollection": [
        {
            "Article": {
                "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"
                }
            },
            "Identifier": "MAIN",
            "Fallback": true,
            "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"
            }
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "NavigationModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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/navigation
                      

                      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: 3459                      

                      Content-Type: application/json
                                              

                        {
    "NavigationModelCollection": [
        {
            "Article": {
                "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"
                }
            },
            "Identifier": "MAIN",
            "Fallback": true,
            "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"
            }
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "NavigationModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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
FilteredNavigationControllerModel[] named NavigationModelCollection

Resource: Navigation, Method: page

Loads an paginated model collection or throws an exception

The number of items per page is defined in the class property $modelsPerPage

Endpoint
GET /api/v1/navigation/page/{?page}/
Example request 
GET /api/v1/navigation/page/{?page}
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: 3459
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
{
    "NavigationModelCollection": [
        {
            "Article": {
                "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"
                }
            },
            "Identifier": "MAIN",
            "Fallback": true,
            "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"
            }
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "NavigationModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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/navigation/page/{?page}
                      

                      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: 3459                      

                      Content-Type: application/json
                                              

                        {
    "NavigationModelCollection": [
        {
            "Article": {
                "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"
                }
            },
            "Identifier": "MAIN",
            "Fallback": true,
            "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"
            }
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "NavigationModelCollection",
        "IsPaginated": true,
        "MaxItemsPerPage": 100,
        "CurrentPage": 1,
        "FirstPage": 1,
        "LastPage": 5,
        "PreviousPage": 1,
        "NextPage": 2,
        "CurrentPageEndpoint": "Endpoint to get this page",
        "FirstPageEndpoint": "Endpoint to get the first page",
        "LastPageEndpoint": "Endpoint to get the last page",
        "PreviousPageEndpoint": "Endpoint to get the previous page",
        "NextPageEndpoint": "Endpoint to get the next page",
        "FirstIndex": 0,
        "LastIndex": 99,
        "TotalCount": 469
    },
    "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
FilteredNavigationControllerModel[] named NavigationModelCollection