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

Get a service job

GET/service-job/{id}
Authorization
AuthorizationAPI key · headerrequired

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

Path parameters
idstringrequired
Responses
200

OK. A missing id returns 200 with an empty body — check for an id in the response.

idstring

Service job id (read-only, autoassigned)

appIdstring

App id (read-only, autoassigned)

serviceJobSidstring

Autogenerated user-friendly id of the service job (read-only, autoassigned)

namestring

Service job name

statusNamestring

Service job status name

stateNamestring

Current service job state name, e.g. "Scheduled" — derived from dev01.public.service_job_state.name (read-only). Filterable in list, e.g. ?stateName=Scheduled.

scheduleStartstring

Scheduled start (ISO date)

scheduleEndstring

Scheduled end (ISO date)

durationnumber

Duration in minutes

zHeightnumber

Z height of the service job

materialConsumptionnumber

Material consumption

machineIdstring

Machine id

materialIdstring

Material id (create-only)

ticketModelsobject

Map of ticketModelId to quantity (update-only)

machineConfigurationNamestring

Machine configuration name (create-only)

materialBatchstring

Material batch (read-only)

serviceJobNotesstring

Service job notes (read-only)

nestedServiceJobUrlsobject

Map of fileName to {url, headers} for nested service job files (update-only)

slicedServiceJobUrlsobject

Map of fileName to {url, headers} for sliced service job files (update-only)

nestedServiceJobUrlstring

Link to archived nested service job files (read-only)

slicedServiceJobUrlstring

Link to archived sliced service job files (read-only)

createdAtstring

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

shipping_deadlinestring

Shipping deadline (ISO date)

thumbnailUrlstring

Thumbnail link (read-only)

additional_filesobject

Additional files

production_notesobject

Production notes

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
Parameters
Request
curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/service-job/string' \
  -H 'Authorization: YOUR_API_KEY'
Response
{
  "id": "232",
  "appId": "1677",
  "serviceJobSid": "X-147-BUILD-95000",
  "name": "X-147-BUILD-95000",
  "statusName": "In preparation",
  "stateName": "Scheduled",
  "scheduleStart": "2021-09-23T08:51:00.000Z",
  "scheduleEnd": "2021-09-23T08:55:00.000Z",
  "duration": 4,
  "materialId": "384",
  "machineId": "164",
  "nestedServiceJobUrl": "https://...",
  "slicedServiceJobUrl": "https://...",
  "createdAt": "2022-07-01T08:01:47.575Z"
}