Create Machine

Beta
POST/v1/operations/machines

Idempotent with Idempotency-Key header. Learn more

Creates a machine and assigns it to a department.

Returns a conflict error if another machine in your account already uses the same name, and a not-found error if the department does not belong to your account. The department cannot be changed once the machine exists.

Permissions requiredValues:machines:create
The role behind your API key or agent must grant every one of these permissions.
include[]optional arrayenumValues:department

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestring

Display name of the machine.

Must be unique within your account; maximum 255 characters.

serial_numberstring

Serial number of the machine.

Maximum 255 characters.

notesoptional string

Free-form notes about the machine.

department_idstring

ID of the department this machine belongs to.

Must reference a department in your account.

idstring

Machine ID.

objectstringenumValues:machine

Resource type identifier.

namestring

Display name of the machine.

Unique within the account.

serial_numberstring

Serial number of the machine.

notesstringnullable

Free-form notes about the machine.

departmentdepartmentExpandablenullable

The department this machine belongs to.

Set when the machine is created; a machine cannot be moved to another department afterwards.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationlocationnullable

The storage location where this department operates.

Always returned as null in this endpoint.
scanning_stationslistnullable

Scanning stations in this department.

Always returned as null in this endpoint.
machineslistnullable

Machines in this department.

Always returned as null in this endpoint.
labor_rateratenullable

Hourly labor rate for work done in this department, such as a changeover technician.

Production scheduling costs changeovers with the constraint department's rate when one is set, falling back to the account-wide changeover labor rate setting.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Machine