Skip to content
Public API
Esc
↑↓navigate↵open⌘Jpreview

List catalogue models

List filters are passed as query parameters — see the conventions in the introduction.

GET/catalogue-model
Authorization
AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Responses
200

OK.

Array of CatalogueModel
idinteger

Internal catalogue model id (read-only, autoassigned)

appIdstring

Application id (read-only, autoassigned)

catalogueModelSidstring

Autogenerated user-friendly id, e.g. CATALOGUE-MODEL-5000 (read-only, autoassigned)

customIdstring

Custom id specified by user

namestring

Catalogue model name

modelEndpointobject

Object with url and headers for the model file (create-only, cannot be updated)

configurationsany[]

Array of configuration objects: id, quantity (number), productionParameters (object, for unmanaged entities e.g. custom fields), productionParameterIds (object, for managed production entities e.g. Material, Technology)

createdAtstring

Creation timestamp (ISO date, read-only, autoassigned)

401

Authentication failed. All causes return this identical response.

codeinteger
messagestring
typestring
default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger
messagestring
typestring
Try it
Server
Authorization
Request
curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/catalogue-model' \
  -H 'Authorization: YOUR_API_KEY'
Response
[
  {
    "id": 232,
    "appId": "1677",
    "catalogueModelSid": "CATALOGUE-MODEL-5000",
    "customId": "CM-0001",
    "name": "Catalogue model name",
    "configurations": [
      {
        "id": "50",
        "quantity": 20,
        "productionParameters": {
          "Machine": "Machine Group 1",
          "Material": "Material 1",
          "Post Processing Services": [
            "GOLD POLISH",
            "CERAMIC BLASTING"
          ],
          "GOLD POLISH": {
            "TTT": "TTT value"
          },
          "Production Time": "2 work days",
          "Build Time": "100",
          "Material Quantity": "1000",
          "Auto-eject": "true",
          "Nozzle": "10",
          "Technology": "Laser Metal Deposition"
        },
        "productionParameterIds": {
          "Machine": "247",
          "Material": "385",
          "Post Processing Services": [
            "137",
            "78"
          ],
          "Production Time": 12533,
          "Technology": "276"
        }
      }
    ],
    "createdAt": "2022-07-21T13:28:44.375Z"
  }
]