Post Work Orders Id Reviewers Reviewer Id Revocation

POST

https://app.hindsiteind.com/api/v2/work_orders/:id/reviewers/:reviewer_id/revocation

POST

/api/v2/work_orders/:id/reviewers/:reviewer_id/revocation

curl -X POST https://app.hindsiteind.com/api/v2/work_orders/id/reviewers/reviewer_id/revocation \
     -H "Authorization: Bearer <token>"

{
  "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
}

Revokes an external reviewer’s access to the work order once they have reviewed it, so they can no longer see or review it and no longer count towards approval; only admins, the work order’s assigned managers and leads, location managers and its creator may call it.

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

Request API credentials from HINDSITE support to receive your client_id and client_secret
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

The response will contain your access token:

{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}

Include the token in subsequent API requests:

Authorization: Bearer your_access_token_here

Path parameters

idstringRequired

reviewer_idstringRequired

Response

The reviewer, with revocation set

idstringOptional

ULID

userobjectOptional

The reviewer, including last_active_at and archived

reviewable_idstringOptional

ULID of the work order or work order task under review

reviewable_typeenumOptional

Allowed values:

statusenumOptional

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:

requested_atdatetime or nullOptional

When the review request was last emailed (ISO 8601); null if no request was emailed, such as someone who reviewed without being asked

stalebooleanOptional

true when the reviewer's latest approval or rejection is older than the latest change to the work

externalbooleanOptional

true for an external (non-member) reviewer

remindablebooleanOptional

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

removablebooleanOptional

true while the reviewer has not reviewed, so can be removed

revocablebooleanOptional

true for an external reviewer who has reviewed and whose access is not yet revoked

revocationobject or nullOptional

null unless the reviewer's access has been revoked

reviewslist of objectsOptional

Oldest first

created_atlongOptional

Unix timestamp (seconds since epoch)

updated_atlongOptional

Unix timestamp (seconds since epoch)

Errors

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error