The Downtime Entry 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 required
from_time string required
to_time string required
operator string required
downtime number
stop_reason string required
remarks string
The Downtime Entry object 
{
  "id": "downtime-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation": "workstation_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "operator": "operator_example",
  "downtime": 0,
  "stop_reason": "stop_reason_example",
  "remarks": "remarks_example"
}
GET /api/manufacturing/downtime-entry/{id}

Retrieve a downtime entry

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

Path parameters

id string required

The identifier of the downtime entry to retrieve.

Returns

Returns the downtime entry object if a valid identifier was provided.

GET /api/manufacturing/downtime-entry/{id} 
curl https://api.overplane.dev/api/manufacturing/downtime-entry/downtime-entry_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "downtime-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation": "workstation_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "operator": "operator_example",
  "downtime": 0,
  "stop_reason": "stop_reason_example",
  "remarks": "remarks_example"
}
GET /api/manufacturing/downtime-entry

List all downtime entrys

Returns a list of downtime entrys. 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 downtime entry objects.

GET /api/manufacturing/downtime-entry 
curl https://api.overplane.dev/api/manufacturing/downtime-entry \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "downtime-entry_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "workstation": "workstation_example",
      "from_time": "from_time_example",
      "to_time": "to_time_example",
      "operator": "operator_example",
      "downtime": 0,
      "stop_reason": "stop_reason_example",
      "remarks": "remarks_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/downtime-entry

Create a downtime entry

Creates a new downtime entry object.

Body parameters

workstation string required
from_time string required
to_time string required
operator string required
downtime number
stop_reason string required
remarks string

Returns

Returns the newly created downtime entry object if the call succeeded.

POST /api/manufacturing/downtime-entry 
curl https://api.overplane.dev/api/manufacturing/downtime-entry \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"workstation":"workstation_example","from_time":"from_time_example","to_time":"to_time_example","operator":"operator_example","stop_reason":"stop_reason_example"}'
Response 
{
  "id": "downtime-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation": "workstation_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "operator": "operator_example",
  "downtime": 0,
  "stop_reason": "stop_reason_example",
  "remarks": "remarks_example"
}
PATCH /api/manufacturing/downtime-entry/{id}

Update a downtime entry

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

Body parameters

workstation string
from_time string
to_time string
operator string
downtime number
stop_reason string
remarks string

Returns

Returns the updated downtime entry object.

PATCH /api/manufacturing/downtime-entry/{id} 
curl https://api.overplane.dev/api/manufacturing/downtime-entry/downtime-entry_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"workstation":"workstation_example","from_time":"from_time_example"}'
Response 
{
  "id": "downtime-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation": "workstation_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "operator": "operator_example",
  "downtime": 0,
  "stop_reason": "stop_reason_example",
  "remarks": "remarks_example"
}
DELETE /api/manufacturing/downtime-entry/{id}

Delete a downtime entry

Permanently deletes a downtime entry. This cannot be undone.

Path parameters

id string required

The identifier of the downtime entry to delete.

Returns

Returns a confirmation that the downtime entry has been deleted.

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