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

List materials

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

GET/material
Authorization
AuthorizationAPI key · headerrequired

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

Responses
200

OK.

Array of Material
idstring

Material ID (auto-assigned, read-only)

appIdstring

Application ID (auto-assigned, read-only)

customIdstring

Custom identifier

namestring

Material name

descriptionstring

Material description

materialSidstring

Material SID (auto-assigned, read-only)

machineGroupIdsany[]

Array of machine group IDs

materialSeriesIdnumber

Material series ID

materialSeriesNamestring

Material series name

propertiesobject

Object mapping property name to value

createdAtstring

Creation date (ISO date, auto-assigned, read-only)

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/material' \
  -H 'Authorization: YOUR_API_KEY'
Response
[
  {
    "id": "385",
    "appId": "1677",
    "customId": "MATERIAL-0001",
    "name": "Material 1",
    "description": "",
    "materialSid": "X-99-MATERIAL-95000",
    "machineGroupIds": [
      "247",
      "248"
    ],
    "materialSeriesId": 1,
    "materialSeriesName": "TestSeries",
    "properties": {
      "Property": "Material Property"
    },
    "createdAt": "2020-06-22T15:53:00.408Z"
  }
]