API introspection – List packages, resources and their interfaces

Found 8 resources

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

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

Name Type Size Default Description Visible Mutable Nullable
Uuid VARCHAR 36 not set yes no no
Orphaned BOOLEAN yes no no
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
Ibnr VARCHAR 5 not set IBNR yes no no
Nart VARCHAR 12 not set Nart yes no no
Title VARCHAR 128 not set yes no no
Dimensions VARCHAR 96 not set yes no yes
Color VARCHAR 64 not set yes no yes
PiecesPerShrink INTEGER 1 yes no no
PiecesPerBox INTEGER 1 yes no no
RecommendedGrossPrice FLOAT not set yes no yes
RecommendedNetPrice FLOAT not set yes no yes
CostPerPiece FLOAT not set yes no yes
ListPricePerUnit FLOAT not set yes no yes
ListPriceConsumerPerUnit FLOAT not set yes no yes
ListPriceCraftsmenPerUnit FLOAT not set yes no yes
ListPriceUnitPieces INTEGER not set yes no yes
ListPricePerSquareMeter FLOAT not set yes no yes
ListPriceAdjustmentFactor FLOAT not set yes no yes
PbsListPriceScaleClass1 FLOAT not set yes no yes
PbsListPriceScaleClass2 FLOAT not set yes no yes
PbsListPriceScaleClass3 FLOAT not set yes no yes

Interfaces

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

Resource: ProductVariant, Method: find

Loads a model collection or throws an exception

Endpoint
GET /business/api/v1/product-variant/
Example request 
GET /business/api/v1/product-variant
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: 2412
Content-Type: application/json
Last-Modified: Wed, 30 Sep 2020 12:55:40 GMT
{
    "ProductVariantModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "Orphaned": true,
            "BusinessModelRelevanceIndustry": false,
            "BusinessModelRelevancePbs": false,
            "BusinessModelRelevanceDiy": false,
            "BusinessModelRelevanceCraftsmen": false,
            "CraftsmenFocusAssortment": false,
            "Ibnr": "04348",
            "Nart": "600420000002",
            "Title": "tesapack 4024 PP, 1000m x 50mm, transparent",
            "Dimensions": "66m × 50mm",
            "Color": "transparent",
            "PiecesPerShrink": 6,
            "PiecesPerBox": 36,
            "RecommendedGrossPrice": 23.67,
            "RecommendedNetPrice": 20.41,
            "CostPerPiece": 2.89,
            "ListPricePerUnit": 23.67,
            "ListPriceConsumerPerUnit": 23.67,
            "ListPriceCraftsmenPerUnit": 23.67,
            "ListPriceUnitPieces": 1,
            "ListPricePerSquareMeter": 0.47,
            "ListPriceAdjustmentFactor": 0.9,
            "PbsListPriceScaleClass1": 21.49,
            "PbsListPriceScaleClass2": 20.89,
            "PbsListPriceScaleClass3": 19.99
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ProductVariantModelCollection",
        "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
FilteredProductVariantControllerModel[] named ProductVariantModelCollection

Resource: ProductVariant, 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-variant/page/{?page}/
Example request 
GET /business/api/v1/product-variant/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: 2412
Content-Type: application/json
Last-Modified: Wed, 30 Sep 2020 12:55:40 GMT
{
    "ProductVariantModelCollection": [
        {
            "Uuid": "123e4567-e89b-12d3-a456-426655440000",
            "Orphaned": true,
            "BusinessModelRelevanceIndustry": false,
            "BusinessModelRelevancePbs": false,
            "BusinessModelRelevanceDiy": false,
            "BusinessModelRelevanceCraftsmen": false,
            "CraftsmenFocusAssortment": false,
            "Ibnr": "04348",
            "Nart": "600420000002",
            "Title": "tesapack 4024 PP, 1000m x 50mm, transparent",
            "Dimensions": "66m × 50mm",
            "Color": "transparent",
            "PiecesPerShrink": 6,
            "PiecesPerBox": 36,
            "RecommendedGrossPrice": 23.67,
            "RecommendedNetPrice": 20.41,
            "CostPerPiece": 2.89,
            "ListPricePerUnit": 23.67,
            "ListPriceConsumerPerUnit": 23.67,
            "ListPriceCraftsmenPerUnit": 23.67,
            "ListPriceUnitPieces": 1,
            "ListPricePerSquareMeter": 0.47,
            "ListPriceAdjustmentFactor": 0.9,
            "PbsListPriceScaleClass1": 21.49,
            "PbsListPriceScaleClass2": 20.89,
            "PbsListPriceScaleClass3": 19.99
        }
    ],
    "CollectionConfiguration": {
        "CollectionModelName": "ProductVariantModelCollection",
        "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
FilteredProductVariantControllerModel[] named ProductVariantModelCollection