The Operation object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

workstation string
description string
total_operation_time number
batch_size integer

Default: 1

create_job_card_based_on_batch_size boolean

Default: false

is_corrective_operation boolean

Default: false

quality_inspection_template string
The Operation object 
{
  "id": "operation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation": "workstation_example",
  "description": "description_example",
  "total_operation_time": 0,
  "batch_size": 1,
  "create_job_card_based_on_batch_size": false,
  "is_corrective_operation": false,
  "quality_inspection_template": "quality_inspection_template_example"
}
GET /api/manufacturing/operation/{id}

Retrieve a operation

Retrieves the details of an existing operation. Supply the unique operation ID that was returned from a previous request.

Path parameters

id string required

The identifier of the operation to retrieve.

Returns

Returns the operation object if a valid identifier was provided.

GET /api/manufacturing/operation/{id} 
curl https://api.overplane.dev/api/manufacturing/operation/operation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "operation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation": "workstation_example",
  "description": "description_example",
  "total_operation_time": 0,
  "batch_size": 1,
  "create_job_card_based_on_batch_size": false,
  "is_corrective_operation": false,
  "quality_inspection_template": "quality_inspection_template_example"
}
GET /api/manufacturing/operation

List all operations

Returns a list of operations. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of operation objects.

GET /api/manufacturing/operation 
curl https://api.overplane.dev/api/manufacturing/operation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "operation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "workstation": "workstation_example",
      "description": "description_example",
      "total_operation_time": 0,
      "batch_size": 1,
      "create_job_card_based_on_batch_size": false,
      "is_corrective_operation": false,
      "quality_inspection_template": "quality_inspection_template_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/operation

Create a operation

Creates a new operation object.

Body parameters

workstation string
description string
total_operation_time number
batch_size integer

Default: 1

create_job_card_based_on_batch_size boolean

Default: false

is_corrective_operation boolean

Default: false

quality_inspection_template string

Returns

Returns the newly created operation object if the call succeeded.

POST /api/manufacturing/operation 
curl https://api.overplane.dev/api/manufacturing/operation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "operation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation": "workstation_example",
  "description": "description_example",
  "total_operation_time": 0,
  "batch_size": 1,
  "create_job_card_based_on_batch_size": false,
  "is_corrective_operation": false,
  "quality_inspection_template": "quality_inspection_template_example"
}
PATCH /api/manufacturing/operation/{id}

Update a operation

Updates the specified operation by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the operation to update.

Body parameters

workstation string
description string
total_operation_time number
batch_size integer

Default: 1

create_job_card_based_on_batch_size boolean

Default: false

is_corrective_operation boolean

Default: false

quality_inspection_template string

Returns

Returns the updated operation object.

PATCH /api/manufacturing/operation/{id} 
curl https://api.overplane.dev/api/manufacturing/operation/operation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"workstation":"workstation_example","description":"description_example"}'
Response 
{
  "id": "operation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation": "workstation_example",
  "description": "description_example",
  "total_operation_time": 0,
  "batch_size": 1,
  "create_job_card_based_on_batch_size": false,
  "is_corrective_operation": false,
  "quality_inspection_template": "quality_inspection_template_example"
}
DELETE /api/manufacturing/operation/{id}

Delete a operation

Permanently deletes a operation. This cannot be undone.

Path parameters

id string required

The identifier of the operation to delete.

Returns

Returns a confirmation that the operation has been deleted.

DELETE /api/manufacturing/operation/{id} 
curl https://api.overplane.dev/api/manufacturing/operation/operation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "operation_abc123",
  "deleted": true
}

Line items

Child objects that belong to this operation. These are accessed via the parent's ID.

Sub Operation

Attributes

idx integer
operation_id string required
operation string required
time_in_mins number
description string

Endpoints

GET /api/manufacturing/sub-operation?parent_id={id}
POST /api/manufacturing/sub-operation
PATCH /api/manufacturing/sub-operation/{id}
DELETE /api/manufacturing/sub-operation/{id}
POST /api/manufacturing/sub-operation/reorder
Sub Operation object 
{
  "id": "sub-operation_abc123",
  "idx": 1,
  "operation_id": "operation_id_example",
  "operation": "operation_example",
  "time_in_mins": 0,
  "description": "description_example"
}