> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api-docs.hindsiteind.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.hindsiteind.com/_mcp/server. # Delete Work Orders Id Hold DELETE https://app.hindsiteind.com/api/v2/work_orders/{id}/hold Resumes a work order that is on hold. Open to managers, assigned users, assigned technicians and members of the work order's location. Returns the work order with its tasks, documents, links, assignments, forms, reviewers and status details. Reference: https://api-docs.hindsiteind.com/hindsite-api/work-orders/delete-work-orders-id-hold ## Authentication - `Authorization` header (bearer token, required) — OAuth 2.0 Client Credentials Flow. To obtain an access token: 1. Request API credentials from HINDSITE support to receive your `client_id` and `client_secret` 2. Make a POST request to obtain an access token: ``` POST https://app.hindsiteind.com/oauth/token Content-Type: application/x-www-form-urlencoded grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET ``` 3. The response will contain your access token: ```json { "access_token": "your_access_token_here", "token_type": "Bearer", "expires_in": 7200, "created_at": 1234567890 } ``` 4. Include the token in subsequent API requests: ``` Authorization: Bearer your_access_token_here ``` ## Request ### Path parameters - `id` (string, required) ## Response ### 200 Resumed work order - `id` (string, optional) — ULID - `title` (string, optional) - `description` (string, optional) - `template` (boolean, optional) - `shared` (boolean, optional) - `archived` (boolean, optional) - `approved` (boolean, optional) - `completed` (boolean, optional) - `completed_at` (long, optional) — Unix timestamp (seconds since epoch) - `progress` (double, optional) — Completion rate 0-100 - `work_order_tasks_count` (integer, optional) - `assigned_users` (list of User, optional) - `manager_ids` (list of string, optional) - `participant_ids` (list of string, optional) - `operational_lead_ids` (list of string, optional) - `location_ids` (list of string, optional) - `location` (Location, optional) — Only present when include_location=true is requested, and on POST /api/v2/my_work/search. Use this when the caller cannot read the location directly, such as a user assigned to the work order who has no access to its location. - `project_ids` (list of string, optional) - `tracked_time` (integer, optional) — Total tracked minutes - `links` (list of WorkOrderLinksItems, optional) - `work_order_tasks_approved` (boolean, optional) - `started_at` (long, optional, nullable) — Unix timestamp (seconds since epoch); null when unset - `start_date` (long, optional, nullable) — Unix timestamp (seconds since epoch); null when unset - `finish_date` (long, optional, nullable) — Unix timestamp (seconds since epoch); null when unset - `scheduled_at` (datetime, optional, nullable) — The work order's start, the earlier of `start_date` and `started_at`, as ISO 8601 in its location's time zone (e.g. `2026-09-24T14:00:00.000+08:00` for 2pm in Perth); null when neither is set - `location_timezone` (string, optional) - `creator_id` (string, optional) — ULID - `asset_id` (string, optional) — ULID - `asset` (Asset, optional, nullable) — Only present when include_asset=true is requested, and on POST /api/v2/my_work/search; null when the work order has no asset. Use this when the caller cannot read the asset directly, such as a user assigned to the work order who has no access to the asset's location. - `work_order_template_id` (string, optional) — ULID - `flagged` (boolean, optional) - `priority` (enum, optional, nullable) — null when the work order has no priority - Allowed values: `low`, `medium`, `high`, `critical` - `editable` (boolean, optional) - `work_order_tasks` (list of WorkOrderTask, optional) - `reviewers` (list of Reviewer, optional) — Present when include_reviewers is set - `organisation_id` (string, optional) — ULID - `user_can_review` (boolean, optional) - `documents` (list of WorkOrderDocument, optional) - `custom_fields` (list of CustomFieldValue, optional) — Only present when include_custom_fields=true is requested. - `custom_field_definitions` (list of CustomFieldDefinition, optional) — Only present when include_custom_fields=true is requested and the organisation has custom fields defined for work orders. - `accepts_reviews` (boolean, optional) — Whether reviews can be submitted right now - `reviews_viewable` (boolean, optional) — Whether the reviews panel applies. Returned with `include_reviewers`. - `potential_reviewers` (list of User, optional) — Users who can be requested as reviewers. Returned with `include_reviewers`. - `reviewable_by` (boolean, optional) — Whether the caller can review. Replaces the deprecated `user_can_review`. - `review_validations` (list of ReviewValidation, optional) — Reasons the caller cannot review yet; empty when they can. Returned with `include_reviewers`. - `can_manage_reviewers` (boolean, optional) — Whether the caller can add or remove reviewers. Returned with `include_reviewers`. - `external_review_validations` (list of ReviewValidation, optional) — Reasons an external review cannot be requested yet. Returned with `include_reviewers`. - `external_reviews_offered` (boolean, optional) — Whether the caller can request an external review. Returned with `include_reviewers`. - `requestable_external_reviewers` (list of User, optional) — External reviewers the caller can request. Returned only when `external_reviews_offered` is true. - `status` (enum, optional) — Lifecycle status. `cancelled` wins over `completed`, which wins over `on_hold`, then `in_progress`, `backlog`, `scheduled` (start date in the future) and `to_do`. - Allowed values: `to_do`, `scheduled`, `backlog`, `in_progress`, `on_hold`, `completed`, `cancelled` - `on_hold` (WorkOrderHold, optional, nullable) — Hold details; null unless the work order is on hold. Returned by the single work order endpoints. - `cancellation` (WorkOrderCancellation, optional, nullable) — Cancellation details; null unless cancelled. Returned by the single work order endpoints. - `sections` (list of WorkOrderSection, optional) — Task sections in order. Returned with the work order's tasks. - `all_reviewers_approved` (boolean, optional) — Whether every requested reviewer has approved. Returned with `include_reviewers`. - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ## Errors ### 403 Forbidden Error Caller cannot work the work order - `any` ### 404 Not Found Error Work order not found or not visible to the caller - `any` ## Types ### User - `id` (string, optional) — ULID - `email` (string, optional) - `name` (string, optional) - `is_admin` (boolean, optional) - `location_manager` (boolean, optional) - `last_active_at` (long, optional) — Unix timestamp (seconds since epoch) - `archived` (boolean, optional) - `organisation_id` (string, optional) — ULID - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### Location - `id` (string, optional) — ULID - `name` (string, optional) - `address` (string, optional) - `company_id` (string, optional) — ULID - `company_name` (string, optional) - `archived` (boolean, optional) - `external_id` (string, optional) - `custom_fields` (list of CustomFieldValue, optional) - `can_manage` (boolean, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### WorkOrderLinksItems ### Asset - `id` (string, optional) — ULID - `identifier` (string, optional) - `serial` (string, optional) - `location_id` (string, optional) — ULID - `parent_id` (string, optional) — ULID - `manufacturer_detail_id` (string, optional) — ULID - `make_detail_id` (string, optional) — ULID - `model_detail_id` (string, optional) — ULID - `editable` (boolean, optional) - `location` (Location, optional) - `make_detail` (MakeDetail, optional) - `manufacturer_detail` (ManufacturerDetail, optional) - `model_detail` (ModelDetail, optional) - `status` (AssetStatus, optional) - `parent` (Asset, optional) - `custom_fields` (list of CustomFieldValue, optional) - `custom_field_definitions` (list of CustomFieldDefinition, optional) - `related_assets` (list of Asset, optional) - `documents` (list of AssetDocument, optional) — Present when include_documents=true - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### WorkOrderTask - `id` (string, optional) — ULID - `title` (string, optional) - `instruction_id` (string, optional, nullable) — ULID. Null for uninstructed tasks. - `work_order_id` (string, optional) — ULID - `sort_order` (integer, optional) - `flagged` (boolean, optional) - `published_instruction_revision_id` (string, optional) — ULID - `users` (list of User, optional) - `started_at` (long, optional, nullable) — Unix timestamp (seconds since epoch); null until the task is started - `completed` (boolean, optional) - `approved` (boolean, optional) - `asset_id` (string, optional) — ULID - `asset` (Asset, optional, nullable) — Only present when include_asset=true is requested on the parent work order, and on POST /api/v2/my_work/search; null when the task has no asset. When the work order has an asset, every task carries that same asset and it cannot be changed per task; tasks only carry their own assets on a work order with no asset. - `tracked_time` (integer, optional) - `defects_count` (integer, optional) - `active_defects_count` (integer, optional) - `started_by` (User, optional) - `editable` (boolean, optional) - `reviewers` (list of Reviewer, optional) - `form` (Form, optional) - `published_instruction_revision` (InstructionRevision, optional) - `position` (integer, optional) - `planned_start_at` (long, optional) - `planned_finish_at` (long, optional) - `scheduled_at` (datetime, optional, nullable) — The task's start, the earlier of `planned_start_at` and `started_at`, as ISO 8601 in its work order's location's time zone (e.g. `2026-09-24T14:00:00.000+08:00` for 2pm in Perth); null when neither is set - `location` (Location, optional) — The location of the task's work order. Returned by POST /api/v2/my_work/search. - `work_order` (WorkOrder, optional) — The task's work order. Returned by POST /api/v2/my_work/search. - `user_can_review` (boolean, optional) - `attachments` (list of Attachment, optional) - `custom_fields` (list of CustomFieldValue, optional) — Present when include_custom_fields=true is requested, and always on the POST /api/v2/work_order_tasks response. - `custom_field_definitions` (list of CustomFieldDefinition, optional) — Present when include_custom_fields=true is requested, and always on the POST /api/v2/work_order_tasks response. The organisation's definitions for work order tasks; empty when it has none. - `accepts_reviews` (boolean, optional) — Whether reviews can be submitted right now - `reviews_viewable` (boolean, optional) — Whether the reviews panel applies. Returned with `include_reviewers`. - `potential_reviewers` (list of User, optional) — Users who can be requested as reviewers. Returned with `include_reviewers`. - `reviewable_by` (boolean, optional) — Whether the caller can review. Replaces the deprecated `user_can_review`. - `review_validations` (list of ReviewValidation, optional) — Reasons the caller cannot review yet; empty when they can. Returned with `include_reviewers`. - `can_manage_reviewers` (boolean, optional) — Whether the caller can add or remove reviewers. Returned with `include_reviewers`. - `external_review_validations` (list of ReviewValidation, optional) — Reasons an external review cannot be requested yet. Returned with `include_reviewers`. - `external_reviews_offered` (boolean, optional) — Whether the caller can request an external review. Returned with `include_reviewers`. - `requestable_external_reviewers` (list of User, optional) — External reviewers the caller can request. Returned only when `external_reviews_offered` is true. - `work_order_section_id` (string, optional) — ULID of the section the task sits in - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### Reviewer - `id` (string, optional) — ULID - `user` (User, optional) — The reviewer, including `last_active_at` and `archived` - `reviewable_id` (string, optional) — ULID of the work order or work order task under review - `reviewable_type` (enum, optional) - Allowed values: `WorkOrder`, `WorkOrderTask` - `status` (enum, optional) — `pending` while awaiting a response (including after a reminder), `approved` or `rejected` once they respond, `commented` for someone who only commented without being asked to review - Allowed values: `pending`, `approved`, `rejected`, `commented` - `requested_at` (datetime, optional, nullable) — When the review request was last emailed (ISO 8601); null if no request was emailed, such as someone who reviewed without being asked - `stale` (boolean, optional) — true when the reviewer's latest approval or rejection is older than the latest change to the work - `external` (boolean, optional) — true for an external (non-member) reviewer - `remindable` (boolean, optional) — true when the caller can send this reviewer a reminder: they are not the caller, their access is not revoked, and they can receive email - `removable` (boolean, optional) — true while the reviewer has not reviewed, so can be removed - `revocable` (boolean, optional) — true for an external reviewer who has reviewed and whose access is not yet revoked - `revocation` (ReviewerRevocation, optional, nullable) — null unless the reviewer's access has been revoked - `reviews` (list of Review, optional) — Oldest first - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) ### WorkOrderDocument - `id` (string, optional) — ULID - `category` (WorkOrderDocumentCategory, optional) - `user` (User, optional) - `file` (ActiveStorageBlob, optional) - `created_at` (integer, optional) — Epoch seconds - `updated_at` (integer, optional) — Epoch seconds ### CustomFieldValue - `id` (string, optional) — ULID - `custom_field_definition_id` (string, optional) — ULID - `name` (string, optional) - `value` (string, optional) — Checkbox fields are "1" (ticked) or "0". - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### CustomFieldDefinition - `id` (string, optional) — ULID - `name` (string, optional) - `customisable_entity_name` (string, optional) - `field_type` (string, optional) - `required` (boolean, optional) - `options` (list of string, optional) — Choices for dropdown fields; empty for other field types - `sort_order` (integer, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) - `position` (integer, optional) — Display order among the entity's custom fields. Same value as sort_order. ### ReviewValidation - `validation_type` (string, optional) — Machine-readable reason the review is refused - `error_message` (string, optional) — Human-readable reason ### WorkOrderHold Why and when a work order was put on hold. - `reason` (string, optional, nullable) - `set_by_id` (string, optional) — ULID of the user who put the work order on hold - `set_at` (long, optional) — Unix timestamp (seconds since epoch) when the hold was placed - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the hold record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the hold record was last updated ### WorkOrderCancellation Why and when a work order was cancelled. - `reason` (string, optional, nullable) - `set_by_id` (string, optional) — ULID of the user who cancelled the work order - `set_at` (long, optional) — Unix timestamp (seconds since epoch) when the work order was cancelled - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the cancellation record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the cancellation record was last updated ### WorkOrderSection A group of tasks on a work order. - `id` (string, optional) — ULID - `title` (string, optional) - `position` (integer, optional) — 1-based order of the section on the work order - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the section was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the section was last updated ### MakeDetail - `id` (string, optional) — ULID - `value` (string, optional) - `detail_type` (string, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### ManufacturerDetail - `id` (string, optional) — ULID - `value` (string, optional) - `detail_type` (string, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### ModelDetail - `id` (string, optional) — ULID - `value` (string, optional) - `detail_type` (string, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### AssetStatus - `id` (string, optional) — ULID - `description` (string, optional) - `downtime_type` (string, optional) - `status_name` (string, optional) - `status_type` (string, optional) - `normalised_status_name` (string, optional) - `started_at` (long, optional) — Unix timestamp (seconds since epoch) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `user` (User, optional) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### AssetDocument - `id` (string, optional) — ULID - `category` (AssetDocumentCategory, optional) - `user` (User, optional, nullable) — null for files backfilled from the previous asset attachments - `file` (ActiveStorageBlob, optional) - `created_at` (integer, optional) — Epoch seconds - `updated_at` (integer, optional) — Epoch seconds ### Form - `id` (string, optional) — ULID - `title` (string, optional) - `instruction_revision_id` (string, optional) — ULID - `contributor_ids` (list of string, optional) - `approved` (boolean, optional) - `started_at` (long, optional) — Unix timestamp (seconds since epoch) - `completed_at` (long, optional) — Unix timestamp (seconds since epoch) - `work_order_task_id` (string, optional) — ULID - `taken_over_from_form_id` (string, optional) — ULID - `in_progress_user_id` (string, optional) — ULID - `note` (string, optional) - `co_author_ids` (list of string, optional) — Deprecated, use contributor_ids - `user_id` (string, optional) — ULID - `in_progress_user` (User, optional) - `work_order_task` (WorkOrderTask, optional) - `steps` (list of FormStep, optional) - `flagged_steps` (list of FormStep, optional) - `user` (User, optional) - `contributors` (list of User, optional) - `connected_users` (list of User, optional) - `co_authors` (list of User, optional) — Deprecated, use contributors - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) - `editable` (boolean, optional) — Whether the requesting user can update the form ### InstructionRevision - `id` (string, optional) — ULID - `title` (string, optional) - `description` (string, optional) - `archived` (boolean, optional) - `first_instruction_step_id` (string, optional) — ULID - `location_ids` (list of string, optional) - `group_ids` (list of string, optional) - `user_id` (string, optional) — ULID - `is_template` (boolean, optional) - `instruction_id` (string, optional) — ULID - `is_latest_in_collection` (boolean, optional) - `organisation_wide` (boolean, optional) - `planned_parts` (list of PlannedPart, optional) - `part_confirmation_required` (boolean, optional) - `links` (list of Link, optional) - `steps` (list of InstructionStep, optional) - `published_at` (long, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### WorkOrder - `id` (string, optional) — ULID - `title` (string, optional) - `description` (string, optional) - `template` (boolean, optional) - `shared` (boolean, optional) - `archived` (boolean, optional) - `approved` (boolean, optional) - `completed` (boolean, optional) - `completed_at` (long, optional) — Unix timestamp (seconds since epoch) - `progress` (double, optional) — Completion rate 0-100 - `work_order_tasks_count` (integer, optional) - `assigned_users` (list of User, optional) - `manager_ids` (list of string, optional) - `participant_ids` (list of string, optional) - `operational_lead_ids` (list of string, optional) - `location_ids` (list of string, optional) - `location` (Location, optional) — Only present when include_location=true is requested, and on POST /api/v2/my_work/search. Use this when the caller cannot read the location directly, such as a user assigned to the work order who has no access to its location. - `project_ids` (list of string, optional) - `tracked_time` (integer, optional) — Total tracked minutes - `links` (list of WorkOrderLinksItems, optional) - `work_order_tasks_approved` (boolean, optional) - `started_at` (long, optional, nullable) — Unix timestamp (seconds since epoch); null when unset - `start_date` (long, optional, nullable) — Unix timestamp (seconds since epoch); null when unset - `finish_date` (long, optional, nullable) — Unix timestamp (seconds since epoch); null when unset - `scheduled_at` (datetime, optional, nullable) — The work order's start, the earlier of `start_date` and `started_at`, as ISO 8601 in its location's time zone (e.g. `2026-09-24T14:00:00.000+08:00` for 2pm in Perth); null when neither is set - `location_timezone` (string, optional) - `creator_id` (string, optional) — ULID - `asset_id` (string, optional) — ULID - `asset` (Asset, optional, nullable) — Only present when include_asset=true is requested, and on POST /api/v2/my_work/search; null when the work order has no asset. Use this when the caller cannot read the asset directly, such as a user assigned to the work order who has no access to the asset's location. - `work_order_template_id` (string, optional) — ULID - `flagged` (boolean, optional) - `priority` (enum, optional, nullable) — null when the work order has no priority - Allowed values: `low`, `medium`, `high`, `critical` - `editable` (boolean, optional) - `work_order_tasks` (list of WorkOrderTask, optional) - `reviewers` (list of Reviewer, optional) — Present when include_reviewers is set - `organisation_id` (string, optional) — ULID - `user_can_review` (boolean, optional) - `documents` (list of WorkOrderDocument, optional) - `custom_fields` (list of CustomFieldValue, optional) — Only present when include_custom_fields=true is requested. - `custom_field_definitions` (list of CustomFieldDefinition, optional) — Only present when include_custom_fields=true is requested and the organisation has custom fields defined for work orders. - `accepts_reviews` (boolean, optional) — Whether reviews can be submitted right now - `reviews_viewable` (boolean, optional) — Whether the reviews panel applies. Returned with `include_reviewers`. - `potential_reviewers` (list of User, optional) — Users who can be requested as reviewers. Returned with `include_reviewers`. - `reviewable_by` (boolean, optional) — Whether the caller can review. Replaces the deprecated `user_can_review`. - `review_validations` (list of ReviewValidation, optional) — Reasons the caller cannot review yet; empty when they can. Returned with `include_reviewers`. - `can_manage_reviewers` (boolean, optional) — Whether the caller can add or remove reviewers. Returned with `include_reviewers`. - `external_review_validations` (list of ReviewValidation, optional) — Reasons an external review cannot be requested yet. Returned with `include_reviewers`. - `external_reviews_offered` (boolean, optional) — Whether the caller can request an external review. Returned with `include_reviewers`. - `requestable_external_reviewers` (list of User, optional) — External reviewers the caller can request. Returned only when `external_reviews_offered` is true. - `status` (enum, optional) — Lifecycle status. `cancelled` wins over `completed`, which wins over `on_hold`, then `in_progress`, `backlog`, `scheduled` (start date in the future) and `to_do`. - Allowed values: `to_do`, `scheduled`, `backlog`, `in_progress`, `on_hold`, `completed`, `cancelled` - `on_hold` (WorkOrderHold, optional, nullable) — Hold details; null unless the work order is on hold. Returned by the single work order endpoints. - `cancellation` (WorkOrderCancellation, optional, nullable) — Cancellation details; null unless cancelled. Returned by the single work order endpoints. - `sections` (list of WorkOrderSection, optional) — Task sections in order. Returned with the work order's tasks. - `all_reviewers_approved` (boolean, optional) — Whether every requested reviewer has approved. Returned with `include_reviewers`. - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### Attachment - `id` (string, optional) — ULID - `blob_url` (string, optional) - `signed_id` (string, optional) - `filename` (string, optional) - `byte_size` (integer, optional) - `content_type` (string, optional) - `preview_url` (string, optional) — Poster image URL. Present only for previewable blobs (e.g. video). - `key` (string, optional) — Storage key of the file in Hindsite's file store. Opaque; download the file with blob_url. ### ReviewerRevocation - `created_at` (datetime, optional) — When access was revoked (ISO 8601) - `revoked_by` (User, optional, nullable) — The user who revoked access; null if that user no longer exists - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) ### Review - `id` (string, optional) — ULID - `status` (enum, optional) - Allowed values: `comment`, `approved`, `rejected` - `comment` (string, optional, nullable) — null when the review was submitted without a comment - `created_at` (datetime, optional) — ISO 8601 - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) ### WorkOrderDocumentCategory - `id` (string, optional) — ULID - `name` (string, optional) - `created_at` (integer, optional) — Epoch seconds - `updated_at` (integer, optional) — Epoch seconds ### ActiveStorageBlob - `blob_url` (string, optional) - `signed_id` (string, optional) - `filename` (string, optional) - `byte_size` (integer, optional) - `content_type` (string, optional) - `preview_url` (string, optional) — Poster image URL. Present only for previewable blobs (e.g. video). - `key` (string, optional) — Storage key of the file in Hindsite's file store. Opaque; download the file with blob_url. - `direct_upload` (ActiveStorageBlobDirectUpload, optional) — Only present on the POST /api/v2/active_storage/presign and POST /api/v2/active_storage/direct_uploads responses, which omit preview_url. PUT the file bytes to url with headers, then reference the blob by signed_id. ### AssetDocumentCategory - `id` (string, optional) — ULID - `name` (string, optional) - `created_at` (integer, optional) — Epoch seconds - `updated_at` (integer, optional) — Epoch seconds ### FormStep - `id` (string, optional) — ULID - `instruction_step_id` (string, optional) — ULID - `form_id` (string, optional) — ULID - `started_at` (long, optional) — Unix timestamp (seconds since epoch) - `next_instruction_step_id` (string, optional) — ULID - `decision_value` (string, optional) - `instruction_decision_id` (string, optional) — ULID - `decision_colour` (string, optional) - `flagged` (boolean, optional) - `instruction_step_title` (string, optional) - `instruction_step_section_title` (string, optional) - `instruction_step_description` (string, optional) - `report_description` (string, optional) - `terminal` (boolean, optional) - `completed_by_user_id` (string, optional) — ULID - `first_step` (boolean, optional) - `defects_count` (integer, optional) - `active_defects_count` (integer, optional) - `inputs` (list of FormInput, optional) - `actions` (list of Action, optional) - `comment` (FormComment, optional) - `completed_by_user` (User, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) ### PlannedPart - `id` (string, optional) — ULID - `quantity` (integer, optional) - `instruction_revision_id` (string, optional) — ULID - `part` (Part, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### Link - `id` (string, optional) — ULID - `name` (string, optional) - `location_id` (string, optional) - `organisation_id` (string, optional) - `linkable_id` (string, optional) - `linkable_type` (string, optional) - `resource` (LinkResource, optional, nullable) — Only present on GET /api/v2/links/\{id}, the shared link lookup. The linked Instruction (with published) or WorkOrder (with its tasks, documents, links, assignments, instruction revisions and forms), matching linkable\_type. Null for any other linkable type, such as a project. - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### InstructionStep - `id` (string, optional) — ULID - `step_uuid` (string, optional) - `title` (string, optional) - `section_title` (string, optional) - `report_only` (boolean, optional) - `description` (string, optional) - `inputs` (list of InstructionInput, optional) - `decisions` (list of InstructionDecision, optional) - `attachments` (list of InstructionAttachment, optional) - `table` (InstructionStepTable, optional, nullable) — Null unless the step is tabular. On a tabular step the step's inputs are the table's columns and each row repeats them; answers are form inputs carrying the row's id as instruction_row_id. - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### ActiveStorageBlobDirectUpload Only present on the POST /api/v2/active_storage/presign and POST /api/v2/active_storage/direct_uploads responses, which omit preview_url. PUT the file bytes to url with headers, then reference the blob by signed_id. - `url` (string, optional) — Pre-signed upload URL, valid for 30 minutes - `headers` (map from string to string, optional) — HTTP headers to send with the upload, such as Content-Type and Content-MD5 ### FormInput - `id` (string, optional) — ULID - `input` (string, optional) - `unformatted_date_input` (string, optional) - `selected_multi_options` (list of FormOption, optional) - `selected_input_records` (list of FormRecord, optional) - `failed_validations` (list of string, optional) - `prefix` (string, optional) - `suffix` (string, optional) - `instruction_input_title` (string, optional) - `instruction_input_id` (string, optional) — ULID - `attachments` (list of FormAttachment, optional) - `form_step_id` (string, optional) — ULID - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) - `conditional` (boolean, optional) — True when the input only applies if another input's answer meets its precondition (see InstructionInput.precondition) - `condition_met` (boolean, optional) — Whether the answer to the triggering input currently meets this input's precondition. Always true for inputs that are not conditional; a conditional input with condition_met false does not currently apply. - `instruction_row_id` (string, optional, nullable) — ULID of the table row this input is a cell of, on tabular steps (see InstructionStep.table). Null for regular inputs. ### Action - `id` (string, optional) — ULID - `title` (string, optional) - `description` (string, optional) - `status` (enum, optional) - Allowed values: `todo`, `in_progress`, `ready_for_review`, `completed`, `cancelled` - `priority` (enum, optional) - Allowed values: `no_priority`, `low`, `medium`, `high`, `critical` - `actionable_type` (enum, optional) - Allowed values: `WorkOrder`, `Form`, `FormStep`, `FormInput::Option`, `Noticed::Event`, `Asset` - `actionable_id` (string, optional) — ULID - `assigned_to_id` (string, optional) — ULID - `user_id` (string, optional) — ULID - `organisation_id` (string, optional) — ULID - `due_date` (long, optional, nullable) — Unix timestamp (seconds since epoch); null when the action has no due date - `scheduled_at` (datetime, optional, nullable) — The due date as ISO 8601 in the organisation's time zone; null when the action has no due date - `completed_at` (long, optional, nullable) — Unix timestamp (seconds since epoch); null until the action is completed - `notes` (list of Note, optional) - `user` (User, optional) - `contents` (list of Content, optional) - `assigned_to` (ActionAssignedTo, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) - `actionable` (ActionActionable, optional) — The FormStep the action belongs to; present when actionable_type is FormStep or FormInput::Option ### FormComment - `id` (string, optional) — ULID - `description` (string, optional) - `user` (User, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) ### Part - `id` (string, optional) — ULID - `number` (string, optional) - `description` (string, optional) - `unit` (string, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### LinkResource Only present on GET /api/v2/links/\{id}, the shared link lookup. The linked Instruction (with published) or WorkOrder (with its tasks, documents, links, assignments, instruction revisions and forms), matching linkable\_type. Null for any other linkable type, such as a project. ### InstructionInput - `id` (string, optional) — ULID - `title` (string, optional) - `input_type` (string, optional) - `sort_order` (integer, optional) - `required` (boolean, optional) - `hold_point` (boolean, optional) - `validations` (list of InstructionValidation, optional) - `options` (list of InstructionOption, optional) - `prefix` (string, optional) - `suffix` (string, optional) - `settings` (InstructionInputSettings, optional) - `position` (integer, optional) — Display order within the step. Same value as sort_order. - `precondition` (InstructionCondition, optional) — Only present on conditional inputs: the condition on another input in the same step that decides whether this input applies. Regular inputs omit this key. - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### InstructionDecision - `id` (string, optional) — ULID - `next_instruction_step_id` (string, optional) — ULID - `instruction_step_id` (string, optional) — ULID - `label` (string, optional) - `colour` (string, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### InstructionAttachment Extends Content with additional report inclusion flag - `id` (string, optional) — ULID - `original` (string, optional) — Presigned URL - `versions` (list of string, optional) - `thumbnails` (list of string, optional) - `title` (string, optional) - `include_in_report` (boolean, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### InstructionStepTable Null unless the step is tabular. On a tabular step the step's inputs are the table's columns and each row repeats them; answers are form inputs carrying the row's id as instruction_row_id. - `id` (string, optional) — ULID - `column_header` (string, optional, nullable) — Heading for the column of row names - `rows` (list of InstructionStepTableRowsItems, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) ### FormOption - `id` (string, optional) — ULID - `value` (string, optional) - `colour` (string, optional) - `instruction_option_id` (string, optional) — ULID - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### FormRecord - `id` (string, optional) — ULID - `title` (string, optional) — Display name of the selected record, saved when it was selected - `recordable_id` (string, optional) — ULID of the selected record - `recordable_type` (string, optional) — Type of the selected record: Asset, Company, Contact, Location or User, matching the record selector input's record_type setting - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### FormAttachment - `id` (string, optional) — ULID - `content` (Content, optional) - `excluded_from_export` (boolean, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### Note - `id` (string, optional) — ULID - `content` (string, optional) — Sanitized HTML content - `plain_text_content` (string, optional) - `user` (User, optional) - `noteable_type` (string, optional) - `noteable_id` (string, optional) — ULID - `attachments` (list of ActiveStorageBlob, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### Content - `id` (long, optional) — Content ID. An integer, not a ULID. - `original` (string, optional) — Presigned URL - `versions` (list of string, optional) - `thumbnails` (list of string, optional) - `title` (string, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### ActionAssignedTo - `id` (string, optional) — ULID - `name` (string, optional) ### ActionActionable The FormStep the action belongs to; present when actionable_type is FormStep or FormInput::Option ### Instruction - `id` (string, optional) — ULID - `title` (string, optional) - `description` (string, optional) - `published_id` (string, optional) — ULID - `draft_id` (string, optional) — ULID - `template` (boolean, optional) - `user_id` (string, optional) — ULID - `organisation_id` (string, optional) — ULID - `archived` (boolean, optional) - `shared` (boolean, optional) - `external_id` (string, optional) - `links` (list of Link, optional) - `published` (InstructionRevision, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) - `has_unpublished_changes` (boolean, optional) — True when the draft has edits that have not been published yet ### InstructionValidation - `id` (string, optional) — ULID - `validation_type` (string, optional) - `value` (string, optional) - `restricted` (boolean, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### InstructionOption - `id` (string, optional) — ULID - `value` (string, optional) - `colour` (string, optional) - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### InstructionInputSettings ### InstructionCondition - `id` (string, optional) — ULID - `condition_type` (string, optional) - `condition_value` (string, optional) - `triggered_by_input_id` (string, optional) — ULID of the input whose answer is tested. The condition belongs to the conditional input that carries it as its precondition. - `created_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was created - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) when the record was last updated ### InstructionStepTableRowsItems - `id` (string, optional) — ULID - `name` (string, optional) - `position` (integer, optional) — Display order of the row - `created_at` (long, optional) — Unix timestamp (seconds since epoch) - `updated_at` (long, optional) — Unix timestamp (seconds since epoch) ## Examples **Response** ```json { "id": "string", "title": "string", "description": "string", "template": true, "shared": true, "archived": true, "approved": true, "completed": true, "completed_at": 1, "progress": 1.1, "work_order_tasks_count": 1, "assigned_users": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "manager_ids": [ "string" ], "participant_ids": [ "string" ], "operational_lead_ids": [ "string" ], "location_ids": [ "string" ], "location": { "id": "string", "name": "string", "address": "string", "company_id": "string", "company_name": "string", "archived": true, "external_id": "string", "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "can_manage": true, "created_at": 1, "updated_at": 1 }, "project_ids": [ "string" ], "tracked_time": 1, "links": [ {} ], "work_order_tasks_approved": true, "started_at": 1, "start_date": 1, "finish_date": 1, "scheduled_at": "2024-01-15T09:30:00Z", "location_timezone": "string", "creator_id": "string", "asset_id": "string", "asset": { "id": "string", "identifier": "string", "serial": "string", "location_id": "string", "parent_id": "string", "manufacturer_detail_id": "string", "make_detail_id": "string", "model_detail_id": "string", "editable": true, "location": { "id": "string", "name": "string", "address": "string", "company_id": "string", "company_name": "string", "archived": true, "external_id": "string", "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "can_manage": true, "created_at": 1, "updated_at": 1 }, "make_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "manufacturer_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "model_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "status": { "id": "string", "description": "string", "downtime_type": "string", "status_name": "string", "status_type": "string", "normalised_status_name": "string", "started_at": 1, "created_at": 1, "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "updated_at": 1 }, "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "custom_field_definitions": [ { "id": "string", "name": "string", "customisable_entity_name": "string", "field_type": "string", "required": true, "options": [ "string" ], "sort_order": 1, "created_at": 1, "updated_at": 1, "position": 1 } ], "related_assets": [ null ], "documents": [ { "id": "string", "category": { "id": "string", "name": "string", "created_at": 1, "updated_at": 1 }, "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "file": { "blob_url": "string", "signed_id": "string", "filename": "string", "byte_size": 1, "content_type": "string", "preview_url": "string", "key": "string", "direct_upload": { "url": "string", "headers": {} } }, "created_at": 1, "updated_at": 1 } ], "created_at": 1, "updated_at": 1 }, "work_order_template_id": "string", "flagged": true, "priority": "low", "editable": true, "work_order_tasks": [ { "id": "string", "title": "string", "instruction_id": "string", "work_order_id": "string", "sort_order": 1, "flagged": true, "published_instruction_revision_id": "string", "users": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "started_at": 1, "completed": true, "approved": true, "asset_id": "string", "asset": { "id": "string", "identifier": "string", "serial": "string", "location_id": "string", "parent_id": "string", "manufacturer_detail_id": "string", "make_detail_id": "string", "model_detail_id": "string", "editable": true, "location": { "id": "string", "name": "string", "address": "string", "company_id": "string", "company_name": "string", "archived": true, "external_id": "string", "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "can_manage": true, "created_at": 1, "updated_at": 1 }, "make_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "manufacturer_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "model_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "status": { "id": "string", "description": "string", "downtime_type": "string", "status_name": "string", "status_type": "string", "normalised_status_name": "string", "started_at": 1, "created_at": 1, "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "updated_at": 1 }, "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "custom_field_definitions": [ { "id": "string", "name": "string", "customisable_entity_name": "string", "field_type": "string", "required": true, "options": [ "string" ], "sort_order": 1, "created_at": 1, "updated_at": 1, "position": 1 } ], "related_assets": [ null ], "documents": [ { "id": "string", "category": { "id": "string", "name": "string", "created_at": 1, "updated_at": 1 }, "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "file": { "blob_url": "string", "signed_id": "string", "filename": "string", "byte_size": 1, "content_type": "string", "preview_url": "string", "key": "string", "direct_upload": { "url": "string", "headers": {} } }, "created_at": 1, "updated_at": 1 } ], "created_at": 1, "updated_at": 1 }, "tracked_time": 1, "defects_count": 1, "active_defects_count": 1, "started_by": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "editable": true, "reviewers": [ { "id": "string", "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "reviewable_id": "string", "reviewable_type": "WorkOrder", "status": "pending", "requested_at": "2024-01-15T09:30:00Z", "stale": true, "external": true, "remindable": true, "removable": true, "revocable": true, "revocation": { "created_at": "2024-01-15T09:30:00Z", "revoked_by": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "updated_at": 1 }, "reviews": [ { "id": "string", "status": "comment", "comment": "string", "created_at": "2024-01-15T09:30:00Z", "updated_at": 1 } ], "created_at": 1, "updated_at": 1 } ], "form": { "id": "string", "title": "string", "instruction_revision_id": "string", "contributor_ids": [ "string" ], "approved": true, "started_at": 1, "completed_at": 1, "work_order_task_id": "string", "taken_over_from_form_id": "string", "in_progress_user_id": "string", "note": "string", "co_author_ids": [ "string" ], "user_id": "string", "in_progress_user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "steps": [ { "id": "string", "instruction_step_id": "string", "form_id": "string", "started_at": 1, "next_instruction_step_id": "string", "decision_value": "string", "instruction_decision_id": "string", "decision_colour": "string", "flagged": true, "instruction_step_title": "string", "instruction_step_section_title": "string", "instruction_step_description": "string", "report_description": "string", "terminal": true, "completed_by_user_id": "string", "first_step": true, "defects_count": 1, "active_defects_count": 1, "inputs": [ { "id": "string", "input": "string", "unformatted_date_input": "string", "selected_multi_options": [ { "id": "string", "value": "string", "colour": "string", "instruction_option_id": "string", "created_at": 1, "updated_at": 1 } ], "selected_input_records": [ { "id": "string", "title": "string", "recordable_id": "string", "recordable_type": "string", "created_at": 1, "updated_at": 1 } ], "failed_validations": [ "string" ], "prefix": "string", "suffix": "string", "instruction_input_title": "string", "instruction_input_id": "string", "attachments": [ { "id": "string", "content": { "id": 1, "original": "string", "versions": [ "string" ], "thumbnails": [ "string" ], "title": "string", "created_at": 1, "updated_at": 1 }, "excluded_from_export": true, "created_at": 1, "updated_at": 1 } ], "form_step_id": "string", "created_at": 1, "updated_at": 1, "conditional": true, "condition_met": true, "instruction_row_id": "string" } ], "actions": [ { "id": "string", "title": "string", "description": "string", "status": "todo", "priority": "no_priority", "actionable_type": "WorkOrder", "actionable_id": "string", "assigned_to_id": "string", "user_id": "string", "organisation_id": "string", "due_date": 1, "scheduled_at": "2024-01-15T09:30:00Z", "completed_at": 1, "notes": [ { "id": "string", "content": "string", "plain_text_content": "string", "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "noteable_type": "string", "noteable_id": "string", "attachments": [ { "blob_url": "string", "signed_id": "string", "filename": "string", "byte_size": 1, "content_type": "string", "preview_url": "string", "key": "string", "direct_upload": { "url": "string", "headers": {} } } ], "created_at": 1, "updated_at": 1 } ], "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "contents": [ { "id": 1, "original": "string", "versions": [ "string" ], "thumbnails": [ "string" ], "title": "string", "created_at": 1, "updated_at": 1 } ], "assigned_to": { "id": "string", "name": "string" }, "created_at": 1, "updated_at": 1, "actionable": {} } ], "comment": { "id": "string", "description": "string", "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "created_at": 1, "updated_at": 1 }, "completed_by_user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "created_at": 1, "updated_at": 1 } ], "flagged_steps": [ { "id": "string", "instruction_step_id": "string", "form_id": "string", "started_at": 1, "next_instruction_step_id": "string", "decision_value": "string", "instruction_decision_id": "string", "decision_colour": "string", "flagged": true, "instruction_step_title": "string", "instruction_step_section_title": "string", "instruction_step_description": "string", "report_description": "string", "terminal": true, "completed_by_user_id": "string", "first_step": true, "defects_count": 1, "active_defects_count": 1, "inputs": [ { "id": "string", "input": "string", "unformatted_date_input": "string", "selected_multi_options": [ { "id": "string", "value": "string", "colour": "string", "instruction_option_id": "string", "created_at": 1, "updated_at": 1 } ], "selected_input_records": [ { "id": "string", "title": "string", "recordable_id": "string", "recordable_type": "string", "created_at": 1, "updated_at": 1 } ], "failed_validations": [ "string" ], "prefix": "string", "suffix": "string", "instruction_input_title": "string", "instruction_input_id": "string", "attachments": [ { "id": "string", "content": { "id": 1, "original": "string", "versions": [ "string" ], "thumbnails": [ "string" ], "title": "string", "created_at": 1, "updated_at": 1 }, "excluded_from_export": true, "created_at": 1, "updated_at": 1 } ], "form_step_id": "string", "created_at": 1, "updated_at": 1, "conditional": true, "condition_met": true, "instruction_row_id": "string" } ], "actions": [ { "id": "string", "title": "string", "description": "string", "status": "todo", "priority": "no_priority", "actionable_type": "WorkOrder", "actionable_id": "string", "assigned_to_id": "string", "user_id": "string", "organisation_id": "string", "due_date": 1, "scheduled_at": "2024-01-15T09:30:00Z", "completed_at": 1, "notes": [ { "id": "string", "content": "string", "plain_text_content": "string", "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "noteable_type": "string", "noteable_id": "string", "attachments": [ { "blob_url": "string", "signed_id": "string", "filename": "string", "byte_size": 1, "content_type": "string", "preview_url": "string", "key": "string", "direct_upload": { "url": "string", "headers": {} } } ], "created_at": 1, "updated_at": 1 } ], "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "contents": [ { "id": 1, "original": "string", "versions": [ "string" ], "thumbnails": [ "string" ], "title": "string", "created_at": 1, "updated_at": 1 } ], "assigned_to": { "id": "string", "name": "string" }, "created_at": 1, "updated_at": 1, "actionable": {} } ], "comment": { "id": "string", "description": "string", "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "created_at": 1, "updated_at": 1 }, "completed_by_user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "created_at": 1, "updated_at": 1 } ], "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "contributors": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "connected_users": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "co_authors": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "created_at": 1, "updated_at": 1, "editable": true }, "published_instruction_revision": { "id": "string", "title": "string", "description": "string", "archived": true, "first_instruction_step_id": "string", "location_ids": [ "string" ], "group_ids": [ "string" ], "user_id": "string", "is_template": true, "instruction_id": "string", "is_latest_in_collection": true, "organisation_wide": true, "planned_parts": [ { "id": "string", "quantity": 1, "instruction_revision_id": "string", "part": { "id": "string", "number": "string", "description": "string", "unit": "string", "created_at": 1, "updated_at": 1 }, "created_at": 1, "updated_at": 1 } ], "part_confirmation_required": true, "links": [ { "id": "string", "name": "string", "location_id": "string", "organisation_id": "string", "linkable_id": "string", "linkable_type": "string", "resource": { "id": "string", "title": "string", "description": "string", "published_id": "string", "draft_id": "string", "template": true, "user_id": "string", "organisation_id": "string", "archived": true, "shared": true, "external_id": "string", "links": [ null ], "created_at": 1, "updated_at": 1, "has_unpublished_changes": true }, "created_at": 1, "updated_at": 1 } ], "steps": [ { "id": "string", "step_uuid": "string", "title": "string", "section_title": "string", "report_only": true, "description": "string", "inputs": [ { "id": "string", "title": "string", "input_type": "string", "sort_order": 1, "required": true, "hold_point": true, "validations": [ { "id": "string", "validation_type": "string", "value": "string", "restricted": true, "created_at": 1, "updated_at": 1 } ], "options": [ { "id": "string", "value": "string", "colour": "string", "created_at": 1, "updated_at": 1 } ], "prefix": "string", "suffix": "string", "settings": {}, "position": 1, "precondition": { "id": "string", "condition_type": "string", "condition_value": "string", "triggered_by_input_id": "string", "created_at": 1, "updated_at": 1 }, "created_at": 1, "updated_at": 1 } ], "decisions": [ { "id": "string", "next_instruction_step_id": "string", "instruction_step_id": "string", "label": "string", "colour": "string", "created_at": 1, "updated_at": 1 } ], "attachments": [ { "id": "string", "original": "string", "versions": [ "string" ], "thumbnails": [ "string" ], "title": "string", "include_in_report": true, "created_at": 1, "updated_at": 1 } ], "table": { "id": "string", "column_header": "string", "rows": [ { "id": "string", "name": "string", "position": 1, "created_at": 1, "updated_at": 1 } ], "created_at": 1, "updated_at": 1 }, "created_at": 1, "updated_at": 1 } ], "published_at": 1, "created_at": 1, "updated_at": 1 }, "position": 1, "planned_start_at": 1, "planned_finish_at": 1, "scheduled_at": "2024-01-15T09:30:00Z", "location": { "id": "string", "name": "string", "address": "string", "company_id": "string", "company_name": "string", "archived": true, "external_id": "string", "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "can_manage": true, "created_at": 1, "updated_at": 1 }, "work_order": { "id": "string", "title": "string", "description": "string", "template": true, "shared": true, "archived": true, "approved": true, "completed": true, "completed_at": 1, "progress": 1.1, "work_order_tasks_count": 1, "assigned_users": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "manager_ids": [ "string" ], "participant_ids": [ "string" ], "operational_lead_ids": [ "string" ], "location_ids": [ "string" ], "location": { "id": "string", "name": "string", "address": "string", "company_id": "string", "company_name": "string", "archived": true, "external_id": "string", "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "can_manage": true, "created_at": 1, "updated_at": 1 }, "project_ids": [ "string" ], "tracked_time": 1, "links": [ {} ], "work_order_tasks_approved": true, "started_at": 1, "start_date": 1, "finish_date": 1, "scheduled_at": "2024-01-15T09:30:00Z", "location_timezone": "string", "creator_id": "string", "asset_id": "string", "asset": { "id": "string", "identifier": "string", "serial": "string", "location_id": "string", "parent_id": "string", "manufacturer_detail_id": "string", "make_detail_id": "string", "model_detail_id": "string", "editable": true, "location": { "id": "string", "name": "string", "address": "string", "company_id": "string", "company_name": "string", "archived": true, "external_id": "string", "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "can_manage": true, "created_at": 1, "updated_at": 1 }, "make_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "manufacturer_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "model_detail": { "id": "string", "value": "string", "detail_type": "string", "created_at": 1, "updated_at": 1 }, "status": { "id": "string", "description": "string", "downtime_type": "string", "status_name": "string", "status_type": "string", "normalised_status_name": "string", "started_at": 1, "created_at": 1, "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "updated_at": 1 }, "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "custom_field_definitions": [ { "id": "string", "name": "string", "customisable_entity_name": "string", "field_type": "string", "required": true, "options": [ "string" ], "sort_order": 1, "created_at": 1, "updated_at": 1, "position": 1 } ], "related_assets": [ null ], "documents": [ { "id": "string", "category": { "id": "string", "name": "string", "created_at": 1, "updated_at": 1 }, "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "file": { "blob_url": "string", "signed_id": "string", "filename": "string", "byte_size": 1, "content_type": "string", "preview_url": "string", "key": "string", "direct_upload": { "url": "string", "headers": {} } }, "created_at": 1, "updated_at": 1 } ], "created_at": 1, "updated_at": 1 }, "work_order_template_id": "string", "flagged": true, "priority": "low", "editable": true, "work_order_tasks": [ null ], "reviewers": [ { "id": "string", "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "reviewable_id": "string", "reviewable_type": "WorkOrder", "status": "pending", "requested_at": "2024-01-15T09:30:00Z", "stale": true, "external": true, "remindable": true, "removable": true, "revocable": true, "revocation": { "created_at": "2024-01-15T09:30:00Z", "revoked_by": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "updated_at": 1 }, "reviews": [ { "id": "string", "status": "comment", "comment": "string", "created_at": "2024-01-15T09:30:00Z", "updated_at": 1 } ], "created_at": 1, "updated_at": 1 } ], "organisation_id": "string", "user_can_review": true, "documents": [ { "id": "string", "category": { "id": "string", "name": "string", "created_at": 1, "updated_at": 1 }, "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "file": { "blob_url": "string", "signed_id": "string", "filename": "string", "byte_size": 1, "content_type": "string", "preview_url": "string", "key": "string", "direct_upload": { "url": "string", "headers": {} } }, "created_at": 1, "updated_at": 1 } ], "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "custom_field_definitions": [ { "id": "string", "name": "string", "customisable_entity_name": "string", "field_type": "string", "required": true, "options": [ "string" ], "sort_order": 1, "created_at": 1, "updated_at": 1, "position": 1 } ], "accepts_reviews": true, "reviews_viewable": true, "potential_reviewers": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "reviewable_by": true, "review_validations": [ { "validation_type": "string", "error_message": "string" } ], "can_manage_reviewers": true, "external_review_validations": [ { "validation_type": "string", "error_message": "string" } ], "external_reviews_offered": true, "requestable_external_reviewers": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "status": "to_do", "on_hold": { "reason": "string", "set_by_id": "string", "set_at": 1, "created_at": 1, "updated_at": 1 }, "cancellation": { "reason": "string", "set_by_id": "string", "set_at": 1, "created_at": 1, "updated_at": 1 }, "sections": [ { "id": "string", "title": "string", "position": 1, "created_at": 1, "updated_at": 1 } ], "all_reviewers_approved": true, "created_at": 1, "updated_at": 1 }, "user_can_review": true, "attachments": [ { "id": "string", "blob_url": "string", "signed_id": "string", "filename": "string", "byte_size": 1, "content_type": "string", "preview_url": "string", "key": "string" } ], "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "custom_field_definitions": [ { "id": "string", "name": "string", "customisable_entity_name": "string", "field_type": "string", "required": true, "options": [ "string" ], "sort_order": 1, "created_at": 1, "updated_at": 1, "position": 1 } ], "accepts_reviews": true, "reviews_viewable": true, "potential_reviewers": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "reviewable_by": true, "review_validations": [ { "validation_type": "string", "error_message": "string" } ], "can_manage_reviewers": true, "external_review_validations": [ { "validation_type": "string", "error_message": "string" } ], "external_reviews_offered": true, "requestable_external_reviewers": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "work_order_section_id": "string", "created_at": 1, "updated_at": 1 } ], "reviewers": [ { "id": "string", "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "reviewable_id": "string", "reviewable_type": "WorkOrder", "status": "pending", "requested_at": "2024-01-15T09:30:00Z", "stale": true, "external": true, "remindable": true, "removable": true, "revocable": true, "revocation": { "created_at": "2024-01-15T09:30:00Z", "revoked_by": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "updated_at": 1 }, "reviews": [ { "id": "string", "status": "comment", "comment": "string", "created_at": "2024-01-15T09:30:00Z", "updated_at": 1 } ], "created_at": 1, "updated_at": 1 } ], "organisation_id": "string", "user_can_review": true, "documents": [ { "id": "string", "category": { "id": "string", "name": "string", "created_at": 1, "updated_at": 1 }, "user": { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 }, "file": { "blob_url": "string", "signed_id": "string", "filename": "string", "byte_size": 1, "content_type": "string", "preview_url": "string", "key": "string", "direct_upload": { "url": "string", "headers": {} } }, "created_at": 1, "updated_at": 1 } ], "custom_fields": [ { "id": "string", "custom_field_definition_id": "string", "name": "string", "value": "string", "created_at": 1, "updated_at": 1 } ], "custom_field_definitions": [ { "id": "string", "name": "string", "customisable_entity_name": "string", "field_type": "string", "required": true, "options": [ "string" ], "sort_order": 1, "created_at": 1, "updated_at": 1, "position": 1 } ], "accepts_reviews": true, "reviews_viewable": true, "potential_reviewers": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "reviewable_by": true, "review_validations": [ { "validation_type": "string", "error_message": "string" } ], "can_manage_reviewers": true, "external_review_validations": [ { "validation_type": "string", "error_message": "string" } ], "external_reviews_offered": true, "requestable_external_reviewers": [ { "id": "string", "email": "string", "name": "string", "is_admin": true, "location_manager": true, "last_active_at": 1, "archived": true, "organisation_id": "string", "created_at": 1, "updated_at": 1 } ], "status": "to_do", "on_hold": { "reason": "string", "set_by_id": "string", "set_at": 1, "created_at": 1, "updated_at": 1 }, "cancellation": { "reason": "string", "set_by_id": "string", "set_at": 1, "created_at": 1, "updated_at": 1 }, "sections": [ { "id": "string", "title": "string", "position": 1, "created_at": 1, "updated_at": 1 } ], "all_reviewers_approved": true, "created_at": 1, "updated_at": 1 } ``` **SDK Code** ```python import requests url = "https://app.hindsiteind.com/api/v2/work_orders/id/hold" headers = {"Authorization": "Bearer "} response = requests.delete(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.hindsiteind.com/api/v2/work_orders/id/hold'; const options = {method: 'DELETE', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://app.hindsiteind.com/api/v2/work_orders/id/hold" req, _ := http.NewRequest("DELETE", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.hindsiteind.com/api/v2/work_orders/id/hold") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.delete("https://app.hindsiteind.com/api/v2/work_orders/id/hold") .header("Authorization", "Bearer ") .asString(); ``` ```php request('DELETE', 'https://app.hindsiteind.com/api/v2/work_orders/id/hold', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.hindsiteind.com/api/v2/work_orders/id/hold"); var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://app.hindsiteind.com/api/v2/work_orders/id/hold")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "DELETE" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```