API introspection – List packages, resources and their interfaces

Found 8 resources

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

Skeleton class for controlling a collection of rows from the 'ProductModel' 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 yes
ProductGroupCode VARCHAR 4 not set APG number yes no yes
BusinessModelRelevanceIndustry BOOLEAN yes no no
BusinessModelRelevancePbs BOOLEAN yes no no
BusinessModelRelevanceDiy BOOLEAN yes no no
BusinessModelRelevanceCraftsmen BOOLEAN yes no no
CraftsmenFocusAssortment BOOLEAN yes no no
Bnr VARCHAR 5 not set BNR yes no yes
Ibnr VARCHAR 5 not set IBNR yes no no
Title VARCHAR 128 not set yes no no
ShowpadProfileId TINYINT not set yes no yes
ShowpadChannelId VARCHAR 96 not set yes no yes

Interfaces

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

Resource: Product, Method: find

Loads a model collection or throws an exception

Endpoint
GET /business/api/v1/product/
Example request 
GET /business/api/v1/product
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: 1923
Content-Type: application/json
Last-Modified: Wed, 30 Sep 2020 12:55:40 GMT
{
    "ProductModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "Orphaned": true,
            "ProductCategoryCode": "2300",
            "ProductGroupCode": "0070",
            "BusinessModelRelevanceIndustry": false,
            "BusinessModelRelevancePbs": false,
            "BusinessModelRelevanceDiy": false,
            "BusinessModelRelevanceCraftsmen": false,
            "CraftsmenFocusAssortment": false,
            "Bnr": "04348",
            "Ibnr": "04348",
            "Title": "Klebstoff-Entferner",
            "ShowpadProfileId": 17,
            "ShowpadChannelId": "17bc3e5986d70ce457c826f92002da38\/00e74ba4575cad0c70bfa586cf0f06cb"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ProductModelCollection",
        "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
FilteredProductControllerModel[] named ProductModelCollection

Resource: Product, 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/page/{?page}/
Example request 
GET /business/api/v1/product/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: 1923
Content-Type: application/json
Last-Modified: Wed, 30 Sep 2020 12:55:40 GMT
{
    "ProductModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "Orphaned": true,
            "ProductCategoryCode": "2300",
            "ProductGroupCode": "0070",
            "BusinessModelRelevanceIndustry": false,
            "BusinessModelRelevancePbs": false,
            "BusinessModelRelevanceDiy": false,
            "BusinessModelRelevanceCraftsmen": false,
            "CraftsmenFocusAssortment": false,
            "Bnr": "04348",
            "Ibnr": "04348",
            "Title": "Klebstoff-Entferner",
            "ShowpadProfileId": 17,
            "ShowpadChannelId": "17bc3e5986d70ce457c826f92002da38\/00e74ba4575cad0c70bfa586cf0f06cb"
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ProductModelCollection",
        "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
FilteredProductControllerModel[] named ProductModelCollection