API introspection – List packages, resources and their interfaces

Found 8 resources

Resource class Tesa\Flow\Controller\Business\Api\V1\ProductGroupController of type CollectionController
No access control

Skeleton class for controlling a collection of rows from the 'ProductGroupModel' table.

Name Type Size Default Description Visible Mutable Nullable
Uuid VARCHAR 36 not set yes no no
Orphaned BOOLEAN yes no no
ProductCategoryCode VARCHAR 4 not set APC number yes no no
ProductGroupCode VARCHAR 4 not set APG number yes no no
Title VARCHAR 128 not set yes no no

Interfaces

Found 2 interfaces in class Tesa\Flow\Controller\Business\Api\V1\ProductGroupController

Resource: ProductGroup, Method: find

Loads a model collection or throws an exception

Endpoint
GET /business/api/v1/product-group/
Example request 
GET /business/api/v1/product-group
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
If-Modified-Since: Wed, 30 Sep 2020 12:55:40 GMT

HTTP/1.1 200 Ok
Date: Wed, 30 Sep 2020 12:55:40 +0000
Content-Length: 1478
Content-Type: application/json
Last-Modified: Wed, 30 Sep 2020 12:55:40 GMT
{
    "ProductGroupModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "Orphaned": true,
            "ProductCategoryCode": "2300",
            "ProductGroupCode": "0070",
            "Title": "Packaging"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ProductGroupModelCollection",
        "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
ISO 8601 Timestamp Provided By The `Last-Modified` Response Header Of The Last Reqeust named If-Modified-Since // Optional
Response header
ISO 8601 Timestamp named Last-Modified // Optional
Response data
FilteredProductGroupControllerModel[] named ProductGroupModelCollection

Resource: ProductGroup, 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 /business/api/v1/product-group/page/{?page}/
Example request 
GET /business/api/v1/product-group/page/{?page}
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
If-Modified-Since: Wed, 30 Sep 2020 12:55:40 GMT

HTTP/1.1 200 Ok
Date: Wed, 30 Sep 2020 12:55:40 +0000
Content-Length: 1478
Content-Type: application/json
Last-Modified: Wed, 30 Sep 2020 12:55:40 GMT
{
    "ProductGroupModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "Orphaned": true,
            "ProductCategoryCode": "2300",
            "ProductGroupCode": "0070",
            "Title": "Packaging"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ProductGroupModelCollection",
        "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
ISO 8601 Timestamp Provided By The `Last-Modified` Response Header Of The Last Reqeust named If-Modified-Since // Optional
Response header
ISO 8601 Timestamp named Last-Modified // Optional
Response data
FilteredProductGroupControllerModel[] named ProductGroupModelCollection