The Plant Floor 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.

floor_name string
warehouse string
company string
The Plant Floor object 
{
  "id": "plant-floor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "floor_name": "floor_name_example",
  "warehouse": "warehouse_example",
  "company": "Example Corp"
}
GET /api/manufacturing/plant-floor/{id}

Retrieve a plant floor

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

Path parameters

id string required

The identifier of the plant floor to retrieve.

Returns

Returns the plant floor object if a valid identifier was provided.

GET /api/manufacturing/plant-floor/{id} 
curl https://api.overplane.dev/api/manufacturing/plant-floor/plant-floor_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "plant-floor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "floor_name": "floor_name_example",
  "warehouse": "warehouse_example",
  "company": "Example Corp"
}
GET /api/manufacturing/plant-floor

List all plant floors

Returns a list of plant floors. 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 plant floor objects.

GET /api/manufacturing/plant-floor 
curl https://api.overplane.dev/api/manufacturing/plant-floor \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "plant-floor_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "floor_name": "floor_name_example",
      "warehouse": "warehouse_example",
      "company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/plant-floor

Create a plant floor

Creates a new plant floor object.

Body parameters

floor_name string
warehouse string
company string

Returns

Returns the newly created plant floor object if the call succeeded.

POST /api/manufacturing/plant-floor 
curl https://api.overplane.dev/api/manufacturing/plant-floor \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "plant-floor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "floor_name": "floor_name_example",
  "warehouse": "warehouse_example",
  "company": "Example Corp"
}
PATCH /api/manufacturing/plant-floor/{id}

Update a plant floor

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

Body parameters

floor_name string
warehouse string
company string

Returns

Returns the updated plant floor object.

PATCH /api/manufacturing/plant-floor/{id} 
curl https://api.overplane.dev/api/manufacturing/plant-floor/plant-floor_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"floor_name":"floor_name_example","warehouse":"warehouse_example"}'
Response 
{
  "id": "plant-floor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "floor_name": "floor_name_example",
  "warehouse": "warehouse_example",
  "company": "Example Corp"
}
DELETE /api/manufacturing/plant-floor/{id}

Delete a plant floor

Permanently deletes a plant floor. This cannot be undone.

Path parameters

id string required

The identifier of the plant floor to delete.

Returns

Returns a confirmation that the plant floor has been deleted.

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