AlphaAlpha Docs

Type Product Coverage

API calls concerning type product coverages

Queue coverage calculation for a type

POST
/type-product-coverages/calculate/{typeId}
AuthorizationBearer <token>

In: header

Path Parameters

typeId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/type-product-coverages/calculate/string"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "completed": "2019-08-24T14:15:22Z",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currentAgentId": "string",
    "description": "string",
    "id": "string",
    "message": "string",
    "name": "string",
    "priority": "LOW",
    "progress": 0.1,
    "retries": 0,
    "runAfter": "2019-08-24T14:15:22Z",
    "started": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "tenantId": "string",
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "workerName": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Create all missing products for the given query

POST
/type-product-coverages/create-products
AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/type-product-coverages/create-products"
0
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Download Csv_ Type Product Coverage

GET
/type-product-coverages/csv-export
AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of entities by their IDs

DELETE
/type-product-coverages/delete-list
AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/type-product-coverages/delete-list?ids=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Type Product Coverage

GET
/type-product-coverages/dynamic-search
AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/dynamic-search"
{
  "content": [
    {
      "assets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "complete": true,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "glbComplete": true,
      "id": "string",
      "linkedProductId": "string",
      "modelType": "CONCEPT",
      "parameters": [
        {
          "name": "string",
          "type": "string",
          "value": null
        }
      ],
      "productName": "string",
      "projectIds": [
        "string"
      ],
      "rvtComplete": true,
      "staticModelTreeId": "string",
      "tenantId": "string",
      "totalFileSize": 0,
      "typeId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "variantId": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Type Product Coverage

POST
/type-product-coverages/dynamic-search
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/type-product-coverages/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "assets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "complete": true,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "glbComplete": true,
      "id": "string",
      "linkedProductId": "string",
      "modelType": "CONCEPT",
      "parameters": [
        {
          "name": "string",
          "type": "string",
          "value": null
        }
      ],
      "productName": "string",
      "projectIds": [
        "string"
      ],
      "rvtComplete": true,
      "staticModelTreeId": "string",
      "tenantId": "string",
      "totalFileSize": 0,
      "typeId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "variantId": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/type-product-coverages/find
AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/find?ids=string"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "complete": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "glbComplete": true,
    "id": "string",
    "linkedProductId": "string",
    "modelType": "CONCEPT",
    "parameters": [
      {
        "name": "string",
        "type": "string",
        "value": null
      }
    ],
    "productName": "string",
    "projectIds": [
      "string"
    ],
    "rvtComplete": true,
    "staticModelTreeId": "string",
    "tenantId": "string",
    "totalFileSize": 0,
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "variantId": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/type-product-coverages/find-all
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/find-all"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "complete": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "glbComplete": true,
    "id": "string",
    "linkedProductId": "string",
    "modelType": "CONCEPT",
    "parameters": [
      {
        "name": "string",
        "type": "string",
        "value": null
      }
    ],
    "productName": "string",
    "projectIds": [
      "string"
    ],
    "rvtComplete": true,
    "staticModelTreeId": "string",
    "tenantId": "string",
    "totalFileSize": 0,
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "variantId": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find existing product coverages by type ID and a list of product names

POST
/type-product-coverages/find-by-names/{typeId}
AuthorizationBearer <token>

In: header

Path Parameters

typeId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/type-product-coverages/find-by-names/string" \  -H "Content-Type: application/json" \  -d '[    "string"  ]'
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "complete": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "glbComplete": true,
    "id": "string",
    "linkedProductId": "string",
    "modelType": "CONCEPT",
    "parameters": [
      {
        "name": "string",
        "type": "string",
        "value": null
      }
    ],
    "productName": "string",
    "projectIds": [
      "string"
    ],
    "rvtComplete": true,
    "staticModelTreeId": "string",
    "tenantId": "string",
    "totalFileSize": 0,
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "variantId": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/type-product-coverages/find-list
AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/find-list"
[
  {
    "assets": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "complete": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "glbComplete": true,
    "id": "string",
    "linkedProductId": "string",
    "modelType": "CONCEPT",
    "parameters": [
      {
        "name": "string",
        "type": "string",
        "value": null
      }
    ],
    "productName": "string",
    "projectIds": [
      "string"
    ],
    "rvtComplete": true,
    "staticModelTreeId": "string",
    "tenantId": "string",
    "totalFileSize": 0,
    "typeId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "variantId": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/type-product-coverages/find/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/find/string"
{
  "assets": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "complete": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "glbComplete": true,
  "id": "string",
  "linkedProductId": "string",
  "modelType": "CONCEPT",
  "parameters": [
    {
      "name": "string",
      "type": "string",
      "value": null
    }
  ],
  "productName": "string",
  "projectIds": [
    "string"
  ],
  "rvtComplete": true,
  "staticModelTreeId": "string",
  "tenantId": "string",
  "totalFileSize": 0,
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "variantId": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get product coverage by type ID and product name

GET
/type-product-coverages/get-by-name/{typeId}/{productName}
AuthorizationBearer <token>

In: header

Path Parameters

typeId*string
productName*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/get-by-name/string/string"
{
  "assets": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "complete": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "glbComplete": true,
  "id": "string",
  "linkedProductId": "string",
  "modelType": "CONCEPT",
  "parameters": [
    {
      "name": "string",
      "type": "string",
      "value": null
    }
  ],
  "productName": "string",
  "projectIds": [
    "string"
  ],
  "rvtComplete": true,
  "staticModelTreeId": "string",
  "tenantId": "string",
  "totalFileSize": 0,
  "typeId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "variantId": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/type-product-coverages/page
AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/page"
{
  "content": [
    {
      "assets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "complete": true,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "glbComplete": true,
      "id": "string",
      "linkedProductId": "string",
      "modelType": "CONCEPT",
      "parameters": [
        {
          "name": "string",
          "type": "string",
          "value": null
        }
      ],
      "productName": "string",
      "projectIds": [
        "string"
      ],
      "rvtComplete": true,
      "staticModelTreeId": "string",
      "tenantId": "string",
      "totalFileSize": 0,
      "typeId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "variantId": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get unused products for a type

GET
/type-product-coverages/unused-products/{typeId}
AuthorizationBearer <token>

In: header

Path Parameters

typeId*string

Query Parameters

page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string
Default"name"
direction?string
Value in"ASC" | "DESC"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/type-product-coverages/unused-products/string"
{
  "content": [
    {
      "assets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "brand": "string",
      "c02": 0.1,
      "category": "string",
      "cost": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "description": "string",
      "dimensions": {
        "height": 0.1,
        "length": 0.1,
        "width": 0.1
      },
      "discounts": [
        {
          "active": true,
          "clientTypes": [
            "PERSON"
          ],
          "name": "string",
          "regions": [
            "string"
          ],
          "volumeThresholds": [
            {
              "discountPercentage": 1,
              "minAmount": 1
            }
          ]
        }
      ],
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "gtin": {
        "gtin": "string",
        "type": "GTIN8"
      },
      "id": "string",
      "lifetime": 0.1,
      "metaData": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "partCosts": 0.1,
      "parts": [
        {
          "amount": 0.1,
          "product": {},
          "unit": "string"
        }
      ],
      "price": 0.1,
      "reference": "string",
      "reorderPoint": 0.1,
      "revision": 0,
      "revisionCode": "string",
      "safetyStock": 0.1,
      "subsidiaryId": "string",
      "supplierId": "string",
      "taxRate": 0.1,
      "tenantId": "string",
      "totalCosts": 0.1,
      "type": "RAW_MATERIAL",
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ],
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "variant": "string",
      "visibility": "PUBLIC",
      "volume": 0.1,
      "weight": 0.1
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Upload a file for a specific product coverage

POST
/type-product-coverages/upload/{typeId}/{productName}
AuthorizationBearer <token>

In: header

Path Parameters

typeId*string
productName*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/type-product-coverages/upload/string/string" \  -F file="string"
true
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Create a single missing product for the given coverage

POST
/type-product-coverages/{coverageId}/create-product
AuthorizationBearer <token>

In: header

Path Parameters

coverageId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/type-product-coverages/string/create-product"
{
  "assets": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "brand": "string",
  "c02": 0.1,
  "category": "string",
  "cost": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "description": "string",
  "dimensions": {
    "height": 0.1,
    "length": 0.1,
    "width": 0.1
  },
  "discounts": [
    {
      "active": true,
      "clientTypes": [
        "PERSON"
      ],
      "name": "string",
      "regions": [
        "string"
      ],
      "volumeThresholds": [
        {
          "discountPercentage": 1,
          "minAmount": 1
        }
      ]
    }
  ],
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "gtin": {
    "gtin": "string",
    "type": "GTIN8"
  },
  "id": "string",
  "lifetime": 0.1,
  "metaData": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "name": "string",
  "partCosts": 0.1,
  "parts": [
    {
      "amount": 0.1,
      "product": {
        "assets": [
          {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        ],
        "brand": "string",
        "c02": 0.1,
        "category": "string",
        "cost": 0.1,
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "currency": "string",
        "description": "string",
        "dimensions": {
          "height": 0.1,
          "length": 0.1,
          "width": 0.1
        },
        "discounts": [
          {
            "active": true,
            "clientTypes": [
              "PERSON"
            ],
            "name": "string",
            "regions": [
              "string"
            ],
            "volumeThresholds": [
              {
                "discountPercentage": 1,
                "minAmount": 1
              }
            ]
          }
        ],
        "events": [
          {
            "authorId": "string",
            "date": "2019-08-24T14:15:22Z",
            "description": "string",
            "id": "string",
            "type": "CREATE"
          }
        ],
        "gtin": {
          "gtin": "string",
          "type": "GTIN8"
        },
        "id": "string",
        "lifetime": 0.1,
        "metaData": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "name": "string",
        "partCosts": 0.1,
        "parts": [],
        "price": 0.1,
        "reference": "string",
        "reorderPoint": 0.1,
        "revision": 0,
        "revisionCode": "string",
        "safetyStock": 0.1,
        "subsidiaryId": "string",
        "supplierId": "string",
        "taxRate": 0.1,
        "tenantId": "string",
        "totalCosts": 0.1,
        "type": "RAW_MATERIAL",
        "unitsOfMeasurement": [
          {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          }
        ],
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string",
        "variant": "string",
        "visibility": "PUBLIC",
        "volume": 0.1,
        "weight": 0.1
      },
      "unit": "string"
    }
  ],
  "price": 0.1,
  "reference": "string",
  "reorderPoint": 0.1,
  "revision": 0,
  "revisionCode": "string",
  "safetyStock": 0.1,
  "subsidiaryId": "string",
  "supplierId": "string",
  "taxRate": 0.1,
  "tenantId": "string",
  "totalCosts": 0.1,
  "type": "RAW_MATERIAL",
  "unitsOfMeasurement": [
    {
      "baseUnit": true,
      "cost": 0.1,
      "decimal": true,
      "isBaseUnit": true,
      "isDecimal": true,
      "name": "string",
      "quantity": 0.1,
      "salesPrice": 0.1,
      "unit": "string"
    }
  ],
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "variant": "string",
  "visibility": "PUBLIC",
  "volume": 0.1,
  "weight": 0.1
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/type-product-coverages/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/type-product-coverages/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/type-product-coverages/{id}/comment
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/type-product-coverages/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}