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

maintenance_team_name string required
maintenance_manager string
maintenance_manager_name string
company string required
The Asset Maintenance Team object 
{
  "id": "asset-maintenance-team_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "maintenance_team_name": "maintenance_team_name_example",
  "maintenance_manager": "maintenance_manager_example",
  "maintenance_manager_name": "maintenance_manager_name_example",
  "company": "Example Corp"
}
GET /api/assets/asset-maintenance-team/{id}

Retrieve a asset maintenance team

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

Path parameters

id string required

The identifier of the asset maintenance team to retrieve.

Returns

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

GET /api/assets/asset-maintenance-team/{id} 
curl https://api.overplane.dev/api/assets/asset-maintenance-team/asset-maintenance-team_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-maintenance-team_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "maintenance_team_name": "maintenance_team_name_example",
  "maintenance_manager": "maintenance_manager_example",
  "maintenance_manager_name": "maintenance_manager_name_example",
  "company": "Example Corp"
}
GET /api/assets/asset-maintenance-team

List all asset maintenance teams

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

GET /api/assets/asset-maintenance-team 
curl https://api.overplane.dev/api/assets/asset-maintenance-team \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-maintenance-team_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "maintenance_team_name": "maintenance_team_name_example",
      "maintenance_manager": "maintenance_manager_example",
      "maintenance_manager_name": "maintenance_manager_name_example",
      "company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-maintenance-team

Create a asset maintenance team

Creates a new asset maintenance team object.

Body parameters

maintenance_team_name string required
maintenance_manager string
maintenance_manager_name string
company string required

Returns

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

POST /api/assets/asset-maintenance-team 
curl https://api.overplane.dev/api/assets/asset-maintenance-team \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"maintenance_team_name":"maintenance_team_name_example","company":"Example Corp"}'
Response 
{
  "id": "asset-maintenance-team_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "maintenance_team_name": "maintenance_team_name_example",
  "maintenance_manager": "maintenance_manager_example",
  "maintenance_manager_name": "maintenance_manager_name_example",
  "company": "Example Corp"
}
PATCH /api/assets/asset-maintenance-team/{id}

Update a asset maintenance team

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

Body parameters

maintenance_team_name string
maintenance_manager string
maintenance_manager_name string
company string

Returns

Returns the updated asset maintenance team object.

PATCH /api/assets/asset-maintenance-team/{id} 
curl https://api.overplane.dev/api/assets/asset-maintenance-team/asset-maintenance-team_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"maintenance_team_name":"maintenance_team_name_example","maintenance_manager":"maintenance_manager_example"}'
Response 
{
  "id": "asset-maintenance-team_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "maintenance_team_name": "maintenance_team_name_example",
  "maintenance_manager": "maintenance_manager_example",
  "maintenance_manager_name": "maintenance_manager_name_example",
  "company": "Example Corp"
}
DELETE /api/assets/asset-maintenance-team/{id}

Delete a asset maintenance team

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

Path parameters

id string required

The identifier of the asset maintenance team to delete.

Returns

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

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

Line items

Child objects that belong to this asset maintenance team. These are accessed via the parent's ID.

Maintenance Team Member

Attributes

idx integer
asset_maintenance_team_id string required
team_member string required
full_name string
maintenance_role string required

Endpoints

GET /api/assets/maintenance-team-member?parent_id={id}
POST /api/assets/maintenance-team-member
PATCH /api/assets/maintenance-team-member/{id}
DELETE /api/assets/maintenance-team-member/{id}
POST /api/assets/maintenance-team-member/reorder
Maintenance Team Member object 
{
  "id": "maintenance-team-member_abc123",
  "idx": 1,
  "asset_maintenance_team_id": "asset_maintenance_team_id_example",
  "team_member": "team_member_example",
  "full_name": "full_name_example",
  "maintenance_role": "maintenance_role_example"
}