The Asset Maintenance 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

asset_maintenance string
asset_name string
item_code string
item_name string
task string
maintenance_type string
periodicity string
assign_to_name string
due_date string
completion_date string
maintenance_status string required
has_certificate boolean

Default: false

certificate_attachement string
description string
actions_performed string
task_name string
task_assignee_email string
The Asset Maintenance Log object 
{
  "id": "asset-maintenance-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset_maintenance": "asset_maintenance_example",
  "asset_name": "asset_name_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "task": "task_example",
  "maintenance_type": "maintenance_type_example",
  "periodicity": "periodicity_example",
  "assign_to_name": "assign_to_name_example",
  "due_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "maintenance_status": "maintenance_status_example",
  "has_certificate": false,
  "certificate_attachement": "certificate_attachement_example",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "task_name": "task_name_example",
  "task_assignee_email": "user@example.com"
}
GET /api/assets/asset-maintenance-log/{id}

Retrieve a asset maintenance log

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

Path parameters

id string required

The identifier of the asset maintenance log to retrieve.

Returns

Returns the asset maintenance log object if a valid identifier was provided.

GET /api/assets/asset-maintenance-log/{id} 
curl https://api.overplane.dev/api/assets/asset-maintenance-log/asset-maintenance-log_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-maintenance-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset_maintenance": "asset_maintenance_example",
  "asset_name": "asset_name_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "task": "task_example",
  "maintenance_type": "maintenance_type_example",
  "periodicity": "periodicity_example",
  "assign_to_name": "assign_to_name_example",
  "due_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "maintenance_status": "maintenance_status_example",
  "has_certificate": false,
  "certificate_attachement": "certificate_attachement_example",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "task_name": "task_name_example",
  "task_assignee_email": "user@example.com"
}
GET /api/assets/asset-maintenance-log

List all asset maintenance logs

Returns a list of asset maintenance 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 asset maintenance log objects.

GET /api/assets/asset-maintenance-log 
curl https://api.overplane.dev/api/assets/asset-maintenance-log \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-maintenance-log_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "asset_maintenance": "asset_maintenance_example",
      "asset_name": "asset_name_example",
      "item_code": "item_code_example",
      "item_name": "item_name_example",
      "task": "task_example",
      "maintenance_type": "maintenance_type_example",
      "periodicity": "periodicity_example",
      "assign_to_name": "assign_to_name_example",
      "due_date": "2024-01-15",
      "completion_date": "2024-01-15",
      "maintenance_status": "maintenance_status_example",
      "has_certificate": false,
      "certificate_attachement": "certificate_attachement_example",
      "description": "description_example",
      "actions_performed": "actions_performed_example",
      "task_name": "task_name_example",
      "task_assignee_email": "user@example.com"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-maintenance-log

Create a asset maintenance log

Creates a new asset maintenance log object.

Body parameters

status string

Default: draft

asset_maintenance string
asset_name string
item_code string
item_name string
task string
maintenance_type string
periodicity string
assign_to_name string
due_date string
completion_date string
maintenance_status string required
has_certificate boolean

Default: false

certificate_attachement string
description string
actions_performed string
task_name string
task_assignee_email string

Returns

Returns the newly created asset maintenance log object if the call succeeded.

POST /api/assets/asset-maintenance-log 
curl https://api.overplane.dev/api/assets/asset-maintenance-log \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"maintenance_status":"maintenance_status_example"}'
Response 
{
  "id": "asset-maintenance-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset_maintenance": "asset_maintenance_example",
  "asset_name": "asset_name_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "task": "task_example",
  "maintenance_type": "maintenance_type_example",
  "periodicity": "periodicity_example",
  "assign_to_name": "assign_to_name_example",
  "due_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "maintenance_status": "maintenance_status_example",
  "has_certificate": false,
  "certificate_attachement": "certificate_attachement_example",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "task_name": "task_name_example",
  "task_assignee_email": "user@example.com"
}
PATCH /api/assets/asset-maintenance-log/{id}

Update a asset maintenance log

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

Body parameters

status string

Default: draft

asset_maintenance string
asset_name string
item_code string
item_name string
task string
maintenance_type string
periodicity string
assign_to_name string
due_date string
completion_date string
maintenance_status string
has_certificate boolean

Default: false

certificate_attachement string
description string
actions_performed string
task_name string
task_assignee_email string

Returns

Returns the updated asset maintenance log object.

PATCH /api/assets/asset-maintenance-log/{id} 
curl https://api.overplane.dev/api/assets/asset-maintenance-log/asset-maintenance-log_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","asset_maintenance":"asset_maintenance_example"}'
Response 
{
  "id": "asset-maintenance-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset_maintenance": "asset_maintenance_example",
  "asset_name": "asset_name_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "task": "task_example",
  "maintenance_type": "maintenance_type_example",
  "periodicity": "periodicity_example",
  "assign_to_name": "assign_to_name_example",
  "due_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "maintenance_status": "maintenance_status_example",
  "has_certificate": false,
  "certificate_attachement": "certificate_attachement_example",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "task_name": "task_name_example",
  "task_assignee_email": "user@example.com"
}
DELETE /api/assets/asset-maintenance-log/{id}

Delete a asset maintenance log

Permanently deletes a asset maintenance log. This cannot be undone.

Path parameters

id string required

The identifier of the asset maintenance log to delete.

Returns

Returns a confirmation that the asset maintenance log has been deleted.

DELETE /api/assets/asset-maintenance-log/{id} 
curl https://api.overplane.dev/api/assets/asset-maintenance-log/asset-maintenance-log_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "asset-maintenance-log_abc123",
  "deleted": true
}
POST /api/assets/asset-maintenance-log/{id}/submit

Submit a asset maintenance log

Submits a draft asset maintenance log, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the asset maintenance log to act on.

Returns

Returns the asset maintenance log object with updated status.

POST /api/assets/asset-maintenance-log/{id}/submit 
curl https://api.overplane.dev/api/assets/asset-maintenance-log/asset-maintenance-log_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-maintenance-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset_maintenance": "asset_maintenance_example",
  "asset_name": "asset_name_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "task": "task_example",
  "maintenance_type": "maintenance_type_example",
  "periodicity": "periodicity_example",
  "assign_to_name": "assign_to_name_example",
  "due_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "maintenance_status": "maintenance_status_example",
  "has_certificate": false,
  "certificate_attachement": "certificate_attachement_example",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "task_name": "task_name_example",
  "task_assignee_email": "user@example.com"
}
POST /api/assets/asset-maintenance-log/{id}/cancel

Cancel a asset maintenance log

Cancels a submitted asset maintenance log, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the asset maintenance log to act on.

Returns

Returns the asset maintenance log object with updated status.

POST /api/assets/asset-maintenance-log/{id}/cancel 
curl https://api.overplane.dev/api/assets/asset-maintenance-log/asset-maintenance-log_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "asset-maintenance-log_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "asset_maintenance": "asset_maintenance_example",
  "asset_name": "asset_name_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "task": "task_example",
  "maintenance_type": "maintenance_type_example",
  "periodicity": "periodicity_example",
  "assign_to_name": "assign_to_name_example",
  "due_date": "2024-01-15",
  "completion_date": "2024-01-15",
  "maintenance_status": "maintenance_status_example",
  "has_certificate": false,
  "certificate_attachement": "certificate_attachement_example",
  "description": "description_example",
  "actions_performed": "actions_performed_example",
  "task_name": "task_name_example",
  "task_assignee_email": "user@example.com"
}