The Routing 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.

routing_name string
disabled boolean

Default: false

The Routing object 
{
  "id": "routing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "routing_name": "routing_name_example",
  "disabled": false
}
GET /api/manufacturing/routing/{id}

Retrieve a routing

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

Path parameters

id string required

The identifier of the routing to retrieve.

Returns

Returns the routing object if a valid identifier was provided.

GET /api/manufacturing/routing/{id} 
curl https://api.overplane.dev/api/manufacturing/routing/routing_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "routing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "routing_name": "routing_name_example",
  "disabled": false
}
GET /api/manufacturing/routing

List all routings

Returns a list of routings. 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 routing objects.

GET /api/manufacturing/routing 
curl https://api.overplane.dev/api/manufacturing/routing \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "routing_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "routing_name": "routing_name_example",
      "disabled": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/routing

Create a routing

Creates a new routing object.

Body parameters

routing_name string
disabled boolean

Default: false

Returns

Returns the newly created routing object if the call succeeded.

POST /api/manufacturing/routing 
curl https://api.overplane.dev/api/manufacturing/routing \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "routing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "routing_name": "routing_name_example",
  "disabled": false
}
PATCH /api/manufacturing/routing/{id}

Update a routing

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

Body parameters

routing_name string
disabled boolean

Default: false

Returns

Returns the updated routing object.

PATCH /api/manufacturing/routing/{id} 
curl https://api.overplane.dev/api/manufacturing/routing/routing_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"routing_name":"routing_name_example","disabled":false}'
Response 
{
  "id": "routing_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "routing_name": "routing_name_example",
  "disabled": false
}
DELETE /api/manufacturing/routing/{id}

Delete a routing

Permanently deletes a routing. This cannot be undone.

Path parameters

id string required

The identifier of the routing to delete.

Returns

Returns a confirmation that the routing has been deleted.

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