The BOM Update Log 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.

status string

Default: draft

current_bom string
new_bom string
update_type string
error_log string
processed_boms string
current_level integer
The BOM Update Log object 
{
  "id": "b-o-m-update-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "current_bom": "current_bom_example",
  "new_bom": "new_bom_example",
  "update_type": "2024-01-15",
  "error_log": "error_log_example",
  "processed_boms": "processed_boms_example",
  "current_level": 0
}
GET /api/manufacturing/b-o-m-update-log/{id}

Retrieve a bom update log

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

Path parameters

id string required

The identifier of the bom update log to retrieve.

Returns

Returns the bom update log object if a valid identifier was provided.

GET /api/manufacturing/b-o-m-update-log/{id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-update-log/b-o-m-update-log_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "b-o-m-update-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "current_bom": "current_bom_example",
  "new_bom": "new_bom_example",
  "update_type": "2024-01-15",
  "error_log": "error_log_example",
  "processed_boms": "processed_boms_example",
  "current_level": 0
}
GET /api/manufacturing/b-o-m-update-log

List all bom update logs

Returns a list of bom update logs. 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 bom update log objects.

GET /api/manufacturing/b-o-m-update-log 
curl https://api.overplane.dev/api/manufacturing/b-o-m-update-log \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "b-o-m-update-log_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "current_bom": "current_bom_example",
      "new_bom": "new_bom_example",
      "update_type": "2024-01-15",
      "error_log": "error_log_example",
      "processed_boms": "processed_boms_example",
      "current_level": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/b-o-m-update-log

Create a bom update log

Creates a new bom update log object.

Body parameters

status string

Default: draft

current_bom string
new_bom string
update_type string
error_log string
processed_boms string
current_level integer

Returns

Returns the newly created bom update log object if the call succeeded.

POST /api/manufacturing/b-o-m-update-log 
curl https://api.overplane.dev/api/manufacturing/b-o-m-update-log \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "b-o-m-update-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "current_bom": "current_bom_example",
  "new_bom": "new_bom_example",
  "update_type": "2024-01-15",
  "error_log": "error_log_example",
  "processed_boms": "processed_boms_example",
  "current_level": 0
}
PATCH /api/manufacturing/b-o-m-update-log/{id}

Update a bom update log

Updates the specified bom update log 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 bom update log to update.

Body parameters

status string

Default: draft

current_bom string
new_bom string
update_type string
error_log string
processed_boms string
current_level integer

Returns

Returns the updated bom update log object.

PATCH /api/manufacturing/b-o-m-update-log/{id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-update-log/b-o-m-update-log_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","current_bom":"current_bom_example"}'
Response 
{
  "id": "b-o-m-update-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "current_bom": "current_bom_example",
  "new_bom": "new_bom_example",
  "update_type": "2024-01-15",
  "error_log": "error_log_example",
  "processed_boms": "processed_boms_example",
  "current_level": 0
}
DELETE /api/manufacturing/b-o-m-update-log/{id}

Delete a bom update log

Permanently deletes a bom update log. This cannot be undone.

Path parameters

id string required

The identifier of the bom update log to delete.

Returns

Returns a confirmation that the bom update log has been deleted.

DELETE /api/manufacturing/b-o-m-update-log/{id} 
curl https://api.overplane.dev/api/manufacturing/b-o-m-update-log/b-o-m-update-log_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "b-o-m-update-log_abc123",
  "deleted": true
}
POST /api/manufacturing/b-o-m-update-log/{id}/submit

Submit a bom update log

Submits a draft bom update log, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the bom update log to act on.

Returns

Returns the bom update log object with updated status.

POST /api/manufacturing/b-o-m-update-log/{id}/submit 
curl https://api.overplane.dev/api/manufacturing/b-o-m-update-log/b-o-m-update-log_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "b-o-m-update-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "current_bom": "current_bom_example",
  "new_bom": "new_bom_example",
  "update_type": "2024-01-15",
  "error_log": "error_log_example",
  "processed_boms": "processed_boms_example",
  "current_level": 0
}
POST /api/manufacturing/b-o-m-update-log/{id}/cancel

Cancel a bom update log

Cancels a submitted bom update log, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the bom update log to act on.

Returns

Returns the bom update log object with updated status.

POST /api/manufacturing/b-o-m-update-log/{id}/cancel 
curl https://api.overplane.dev/api/manufacturing/b-o-m-update-log/b-o-m-update-log_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "b-o-m-update-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "current_bom": "current_bom_example",
  "new_bom": "new_bom_example",
  "update_type": "2024-01-15",
  "error_log": "error_log_example",
  "processed_boms": "processed_boms_example",
  "current_level": 0
}