API docs by Redocly

CMMS Client APP API (v1)

Download OpenAPI specification:

Assets

Create new asset

Authorizations:
bearer_auth
header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Asset to create

required
object

Responses

Request samples

Content type
application/json
{
  • "asset": {
    • "name": "Air Purifier",
    • "asset_code": "AST-001",
    • "description": "Machine used to purify the air in a shop by removing particles, allergens, and contaminants",
    • "model": "Dyson Pure Cool Link Tower",
    • "manufacturer": "Dyson",
    • "serial_number": "H8tG5nWp",
    • "purchase_date": "2023-08-24",
    • "warranty_exp_date": "2026-08-24",
    • "warranty_expiration_notification": 30,
    • "life_expectancy": 36,
    • "purchase_cost": 549.99,
    • "replacement_cost": 599.99,
    • "salvage_value": 150,
    • "location_id": 12,
    • "parent_id": 44,
    • "asset_types_ids": [
      ],
    • "technicians_ids": [
      ],
    • "parts_ids": [
      ],
    • "vendors_ids": [
      ],
    • "qr_code_attributes": {
      },
    • "uploads_attributes": [
      ],
    • "urls_attributes": []
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 102,
    • "name": "Air Purifier",
    • "description": "Machine used to purify the air in a shop by removing particles, allergens, and contaminants",
    • "model": "Dyson Pure Cool Link Tower",
    • "manufacturer": "Dyson",
    • "serial_number": "H8tG5nWp",
    • "warranty_expiration_notification": 30,
    • "life_expectancy": 36,
    • "root_id": 44,
    • "asset_code": "AHU-BLD1-01-001",
    • "status": "online",
    • "purchase_cost": 549.99,
    • "replacement_cost": 599.99,
    • "salvage_value": 150,
    • "parent": {
      },
    • "location": {
      },
    • "technicians": [
      ],
    • "asset_types": [
      ],
    • "parts": [
      ],
    • "urls": [],
    • "vendors": [
      ],
    • "has_children": false,
    • "purchase_date": "2023-08-24",
    • "warranty_exp_date": "2026-08-24",
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

List assets

Returns a paginated list of assets with optional search and sorting capabilities

Authorizations:
bearer_auth
query Parameters
search
string
sort
string
Default: "name asc"
Example: sort=created_at desc

Sort by field ascending or descending

object
Example: filter[name_cont]=building

Filter using filter[field_matcher] syntax

page
integer
Default: 1

Page number

per_page
integer
Default: 50

Items per page

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    • {
      }
    ],
  • "meta": {
    • "entity": {
      },
    • "customer": {
      },
    • "pagination": {
      },
    • "sort": [
      ],
    • "search": "Building A",
    • "filter": {
      }
    }
}

Get asset

Authorizations:
bearer_auth
path Parameters
id
required
integer

Asset ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 102,
    • "name": "Air Purifier",
    • "description": "Machine used to purify the air in a shop by removing particles, allergens, and contaminants",
    • "model": "Dyson Pure Cool Link Tower",
    • "manufacturer": "Dyson",
    • "serial_number": "H8tG5nWp",
    • "warranty_expiration_notification": 30,
    • "life_expectancy": 36,
    • "root_id": 44,
    • "asset_code": "AHU-BLD1-01-001",
    • "status": "online",
    • "purchase_cost": 549.99,
    • "replacement_cost": 599.99,
    • "salvage_value": 150,
    • "parent": {
      },
    • "location": {
      },
    • "technicians": [
      ],
    • "asset_types": [
      ],
    • "parts": [
      ],
    • "urls": [],
    • "vendors": [
      ],
    • "has_children": false,
    • "purchase_date": "2023-08-24",
    • "warranty_exp_date": "2026-08-24",
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Update asset

Authorizations:
bearer_auth
path Parameters
id
required
integer

Asset ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Asset to update

required
object

Responses

Request samples

Content type
application/json
{
  • "asset": {
    • "name": "Air Purifier",
    • "asset_code": "AST-001",
    • "description": "Machine used to purify the air in a shop by removing particles, allergens, and contaminants",
    • "model": "Dyson Pure Cool Link Tower",
    • "manufacturer": "Dyson",
    • "serial_number": "H8tG5nWp",
    • "purchase_date": "2023-08-24",
    • "warranty_exp_date": "2026-08-24",
    • "warranty_expiration_notification": 30,
    • "life_expectancy": 36,
    • "purchase_cost": 549.99,
    • "replacement_cost": 599.99,
    • "salvage_value": 150,
    • "location_id": 12,
    • "parent_id": 44,
    • "asset_types_ids": [
      ],
    • "technicians_ids": [
      ],
    • "parts_ids": [
      ],
    • "vendors_ids": [
      ],
    • "qr_code_attributes": {
      },
    • "uploads_attributes": [
      ],
    • "urls_attributes": []
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 102,
    • "name": "Air Purifier",
    • "description": "Machine used to purify the air in a shop by removing particles, allergens, and contaminants",
    • "model": "Dyson Pure Cool Link Tower",
    • "manufacturer": "Dyson",
    • "serial_number": "H8tG5nWp",
    • "warranty_expiration_notification": 30,
    • "life_expectancy": 36,
    • "root_id": 44,
    • "asset_code": "AHU-BLD1-01-001",
    • "status": "online",
    • "purchase_cost": 549.99,
    • "replacement_cost": 599.99,
    • "salvage_value": 150,
    • "parent": {
      },
    • "location": {
      },
    • "technicians": [
      ],
    • "asset_types": [
      ],
    • "parts": [
      ],
    • "urls": [],
    • "vendors": [
      ],
    • "has_children": false,
    • "purchase_date": "2023-08-24",
    • "warranty_exp_date": "2026-08-24",
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Delete asset

Authorizations:
bearer_auth
path Parameters
id
required
integer

Asset ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "error",
  • "message": "string"
}

Locations

Create new location

Authorizations:
bearer_auth
header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Location to create

required
object

Responses

Request samples

Content type
application/json
{
  • "location": {
    • "name": "Main Conference Room",
    • "description": "Large conference room with projector and whiteboard. Seats up to 12 people.",
    • "address": "101-123 Example St",
    • "parent_id": 55,
    • "qr_code_attributes": {
      },
    • "uploads_attributes": [
      ]
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 56,
    • "name": "Main Conference Room",
    • "description": "Large conference room with projector and whiteboard. Seats up to 12 people.",
    • "address": "101-123 Example St",
    • "parent": {
      },
    • "root_id": 55,
    • "path": "Building A > Main Conference Room",
    • "has_children": false,
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by_id": 15,
    • "updated_by_id": 22
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

List locations

Returns a paginated list of locations with optional search and sorting capabilities

Authorizations:
bearer_auth
query Parameters
search
string
sort
string
Default: "name asc"
Example: sort=created_at desc

Sort by field ascending or descending

object
Example: filter[name_cont]=building

Filter using filter[field_matcher] syntax

page
integer
Default: 1

Page number

per_page
integer
Default: 50

Items per page

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    • {
      }
    ],
  • "meta": {
    • "entity": {
      },
    • "customer": {
      },
    • "pagination": {
      },
    • "sort": [
      ],
    • "search": "Building A",
    • "filter": {
      }
    }
}

Get location

Authorizations:
bearer_auth
path Parameters
id
required
integer

Location ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 56,
    • "name": "Main Conference Room",
    • "description": "Large conference room with projector and whiteboard. Seats up to 12 people.",
    • "address": "101-123 Example St",
    • "parent": {
      },
    • "root_id": 55,
    • "path": "Building A > Main Conference Room",
    • "has_children": false,
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by_id": 15,
    • "updated_by_id": 22
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Update location

Authorizations:
bearer_auth
path Parameters
id
required
integer

Location ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Location to update

required
object

Responses

Request samples

Content type
application/json
{
  • "location": {
    • "name": "Main Conference Room",
    • "description": "Large conference room with projector and whiteboard. Seats up to 12 people.",
    • "address": "101-123 Example St",
    • "parent_id": 55,
    • "qr_code_attributes": {
      },
    • "uploads_attributes": [
      ]
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 56,
    • "name": "Main Conference Room",
    • "description": "Large conference room with projector and whiteboard. Seats up to 12 people.",
    • "address": "101-123 Example St",
    • "parent": {
      },
    • "root_id": 55,
    • "path": "Building A > Main Conference Room",
    • "has_children": false,
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by_id": 15,
    • "updated_by_id": 22
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Delete location

Authorizations:
bearer_auth
path Parameters
id
required
integer

Location ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "error",
  • "message": "string"
}

Part Transactions

Create new part transaction

Authorizations:
bearer_auth
header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Part transaction to create

One of
part_id
required
integer
type
required
string
Enum: "restock" "cost_update"
  • restock - Restock inventory for stock part
  • cost_update - Cost update for non-stock part
quantity
number <decimal> decimal places <= 3 >= 0
Default: 0

Not used for cost_update type and has no effect if set.

cost
number <decimal> decimal places <= 2 >= 0
note
string
Array of objects

Array of file uploads (images and documents).

  • Image size limit - 150MB
  • Document size limit - 100MB

Responses

Request samples

Content type
application/json
Example
{
  • "part_id": 102,
  • "type": "restock",
  • "quantity": 2,
  • "cost": 26.15,
  • "note": "Purchase order PO-12345 received",
  • "uploads_attributes": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 102,
    • "note": "Purchase order PO-12345 received",
    • "type": "restock",
    • "work_order_id": null,
    • "cost": 26.15,
    • "total_cost": 52.3,
    • "quantity": 2,
    • "part": {
      },
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by_id": 15,
    • "updated_by_id": 22
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

List part transactions

Authorizations:
bearer_auth
query Parameters
search
string
sort
string
Example: sort=created_at desc

Sort by field ascending or descending

object
Example: filter[part_id_eq]=1

Filter using filter[field_matcher] syntax

page
integer
Default: 1

Page number

per_page
integer
Default: 50

Items per page

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    • {
      }
    ],
  • "meta": {
    • "entity": {
      },
    • "customer": {
      },
    • "pagination": {
      },
    • "sort": [
      ],
    • "search": "Building A",
    • "filter": {
      },
    • "total_used": 2
    }
}

Get part transaction

Authorizations:
bearer_auth
path Parameters
id
required
integer

Part Transaction ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 102,
    • "note": "Purchase order PO-12345 received",
    • "type": "restock",
    • "work_order_id": null,
    • "cost": 26.15,
    • "total_cost": 52.3,
    • "quantity": 2,
    • "part": {
      },
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by_id": 15,
    • "updated_by_id": 22
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Parts

Create new part

Authorizations:
bearer_auth
header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Part to create

required
object

Responses

Request samples

Content type
application/json
{
  • "part": {
    • "name": "Air Filter",
    • "description": "Fiberglass panel filter",
    • "is_non_stock": false,
    • "on_hand_qty": 6,
    • "min_qty": 5,
    • "desired_qty": 8,
    • "unit_cost": 26.15,
    • "number": "FL_A",
    • "area": "Filters bin",
    • "lead_time": 7,
    • "part_type_id": 3,
    • "storeroom_id": 1,
    • "measurement_unit_id": 2,
    • "assets_ids": [
      ],
    • "vendor_parts_attributes": [
      ],
    • "qr_code_attributes": {
      },
    • "urls_attributes": [],
    • "uploads_attributes": [
      ]
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 102,
    • "name": "Air Filter",
    • "description": "Fiberglass panel filter",
    • "is_non_stock": false,
    • "number": "FL_A",
    • "area": "Filters bin",
    • "lead_time": 7,
    • "on_hand_qty": 6,
    • "min_qty": 5,
    • "desired_qty": 8,
    • "unit_cost": 26.15,
    • "avg_unit_cost": 26.15,
    • "part_type": {
      },
    • "storeroom": {
      },
    • "measurement_unit": {
      },
    • "urls": [],
    • "available": 5,
    • "reserved": 1,
    • "assets": [
      ],
    • "vendors": [
      ],
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

List parts

Authorizations:
bearer_auth
query Parameters
search
string
sort
string
Example: sort=created_at desc

Sort by field ascending or descending

object
Example: filter[name_cont]=building

Filter using filter[field_matcher] syntax

page
integer
Default: 1

Page number

per_page
integer
Default: 50

Items per page

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    • {
      }
    ],
  • "meta": {
    • "entity": {
      },
    • "customer": {
      },
    • "pagination": {
      },
    • "sort": [
      ],
    • "search": "Building A",
    • "filter": {
      }
    }
}

Get part

Authorizations:
bearer_auth
path Parameters
id
required
integer

Part ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 102,
    • "name": "Air Filter",
    • "description": "Fiberglass panel filter",
    • "is_non_stock": false,
    • "number": "FL_A",
    • "area": "Filters bin",
    • "lead_time": 7,
    • "on_hand_qty": 6,
    • "min_qty": 5,
    • "desired_qty": 8,
    • "unit_cost": 26.15,
    • "avg_unit_cost": 26.15,
    • "part_type": {
      },
    • "storeroom": {
      },
    • "measurement_unit": {
      },
    • "urls": [],
    • "available": 5,
    • "reserved": 1,
    • "assets": [
      ],
    • "vendors": [
      ],
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Update part

Authorizations:
bearer_auth
path Parameters
id
required
integer

Part ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Part to update

required
object

Responses

Request samples

Content type
application/json
{
  • "part": {
    • "name": "Air Filter",
    • "description": "Fiberglass panel filter",
    • "is_non_stock": false,
    • "min_qty": 5,
    • "desired_qty": 8,
    • "unit_cost": 26.15,
    • "number": "FL_A",
    • "area": "Filters bin",
    • "lead_time": 7,
    • "part_type_id": 3,
    • "storeroom_id": 1,
    • "measurement_unit_id": 2,
    • "assets_ids": [
      ],
    • "vendor_parts_attributes": [
      ],
    • "qr_code_attributes": {
      },
    • "urls_attributes": [],
    • "uploads_attributes": [
      ]
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 102,
    • "name": "Air Filter",
    • "description": "Fiberglass panel filter",
    • "is_non_stock": false,
    • "number": "FL_A",
    • "area": "Filters bin",
    • "lead_time": 7,
    • "on_hand_qty": 6,
    • "min_qty": 5,
    • "desired_qty": 8,
    • "unit_cost": 26.15,
    • "avg_unit_cost": 26.15,
    • "part_type": {
      },
    • "storeroom": {
      },
    • "measurement_unit": {
      },
    • "urls": [],
    • "available": 5,
    • "reserved": 1,
    • "assets": [
      ],
    • "vendors": [
      ],
    • "qr_code": "guVT5ngMeZ9xPBIk8db4dCGXVU",
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Delete part

Authorizations:
bearer_auth
path Parameters
id
required
integer

Part ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "error",
  • "message": "string"
}

Work Orders

Create new work order

Authorizations:
bearer_auth
header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Work order to create

required
object

Responses

Request samples

Content type
application/json
{
  • "work_order": {
    • "title": "Fix water leakage in Freezer",
    • "type": "reactive",
    • "description": "Water leakage due to blocked defrost drain",
    • "priority": "high",
    • "due_date": "2025-07-17T12:00:00Z",
    • "completed_at": "2025-07-15T09:30:00Z",
    • "location_id": 122,
    • "asset_id": 45,
    • "status_id": 5,
    • "categories_ids": [
      ],
    • "account_codes_ids": [
      ],
    • "procedure_template_ids": [
      ],
    • "technicians_ids": [
      ],
    • "vendors_ids": [
      ],
    • "notify_vendors_on_create": "yes",
    • "notify_vendors_on_update": "yes",
    • "checklist": [
      ],
    • "uploads_attributes": [
      ]
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 1126,
    • "title": "Fix water leakage in Freezer",
    • "description": "Water leakage due to blocked defrost drain",
    • "priority": "high",
    • "type": "reactive",
    • "work_order_request_id": 864,
    • "pm_schedule_id": 78,
    • "checklist": [
      ],
    • "procedures": [
      ],
    • "notify_vendors_on_create": "yes",
    • "notify_vendors_on_update": "yes",
    • "status": {
      },
    • "comments": [
      ],
    • "asset": {
      },
    • "downtime_tracking": {
      },
    • "categories": [
      ],
    • "account_codes": [
      ],
    • "technicians": [
      ],
    • "vendors": [
      ],
    • "location": {
      },
    • "due_date": "2025-07-17T12:00:00Z",
    • "completed_at": "2025-07-15T09:30:00Z",
    • "total_costs": {
      },
    • "active_timer_current_user": {
      },
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

List work orders

Authorizations:
bearer_auth
query Parameters
search
string
sort
string
Default: "created_at desc"
Example: sort=created_at desc

Sort by field ascending or descending

object
Example: filter[name_cont]=building

Filter using filter[field_matcher] syntax

page
integer
Default: 1

Page number

per_page
integer
Default: 50

Items per page

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    • {
      }
    ],
  • "meta": {
    • "entity": {
      },
    • "customer": {
      },
    • "pagination": {
      },
    • "sort": [
      ],
    • "search": "Building A",
    • "filter": {
      }
    }
}

Get work order

Authorizations:
bearer_auth
path Parameters
id
required
integer

Work Order ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 1126,
    • "title": "Fix water leakage in Freezer",
    • "description": "Water leakage due to blocked defrost drain",
    • "priority": "high",
    • "type": "reactive",
    • "work_order_request_id": 864,
    • "pm_schedule_id": 78,
    • "checklist": [
      ],
    • "procedures": [
      ],
    • "notify_vendors_on_create": "yes",
    • "notify_vendors_on_update": "yes",
    • "status": {
      },
    • "comments": [
      ],
    • "asset": {
      },
    • "downtime_tracking": {
      },
    • "categories": [
      ],
    • "account_codes": [
      ],
    • "technicians": [
      ],
    • "vendors": [
      ],
    • "location": {
      },
    • "due_date": "2025-07-17T12:00:00Z",
    • "completed_at": "2025-07-15T09:30:00Z",
    • "total_costs": {
      },
    • "active_timer_current_user": {
      },
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Update work order

Authorizations:
bearer_auth
path Parameters
id
required
integer

Work Order ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Request Body schema: application/json

Work order to update

required
object

Responses

Request samples

Content type
application/json
{
  • "work_order": {
    • "title": "Fix water leakage in Freezer",
    • "description": "Water leakage due to blocked defrost drain",
    • "priority": "none",
    • "due_date": "2019-08-24T14:15:22Z",
    • "completed_at": "2019-08-24T14:15:22Z",
    • "location_id": 122,
    • "asset_id": 45,
    • "status_id": 1,
    • "categories_ids": [
      ],
    • "account_codes_ids": [
      ],
    • "procedure_template_ids": [
      ],
    • "technicians_ids": [
      ],
    • "vendors_ids": [
      ],
    • "notify_vendors_on_create": "yes",
    • "notify_vendors_on_update": "yes",
    • "checklist": [
      ],
    • "uploads_attributes": [
      ]
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    • "id": 1126,
    • "title": "Fix water leakage in Freezer",
    • "description": "Water leakage due to blocked defrost drain",
    • "priority": "high",
    • "type": "reactive",
    • "work_order_request_id": 864,
    • "pm_schedule_id": 78,
    • "checklist": [
      ],
    • "procedures": [
      ],
    • "notify_vendors_on_create": "yes",
    • "notify_vendors_on_update": "yes",
    • "status": {
      },
    • "comments": [
      ],
    • "asset": {
      },
    • "downtime_tracking": {
      },
    • "categories": [
      ],
    • "account_codes": [
      ],
    • "technicians": [
      ],
    • "vendors": [
      ],
    • "location": {
      },
    • "due_date": "2025-07-17T12:00:00Z",
    • "completed_at": "2025-07-15T09:30:00Z",
    • "total_costs": {
      },
    • "active_timer_current_user": {
      },
    • "images": [
      ],
    • "documents": [
      ],
    • "created_at": "2025-07-17T19:19:20Z",
    • "updated_at": "2025-09-24T14:20:25Z",
    • "created_by": {
      },
    • "updated_by": {
      }
    },
  • "meta": {
    • "entity": {
      },
    • "customer": {
      }
    }
}

Delete work order

Authorizations:
bearer_auth
path Parameters
id
required
integer

Work Order ID

header Parameters
X-Entity-Id
required
integer

Entity ID

Responses

Response samples

Content type
application/json
{
  • "status": "error",
  • "message": "string"
}