Skip to navigation
HINDSITE APIwork_orders

Post Work Orders Id Relationships

View as Markdown

Links this work order to another. Requires manage access to the work order; the counterpart must be open and in the same organisation. A pair can only be linked once.

Authentication

AuthorizationBearer

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
  1. The response will contain your access token:
{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}
  1. Include the token in subsequent API requests:
Authorization: Bearer your_access_token_here

Path parameters

idstringRequired

Request

This endpoint expects an object.
related_work_order_idstringRequired

ULID of the counterpart work order. Must be open (not completed, not cancelled) and accessible to the caller.

kindenumRequired

blocked_by stores the inverse blocks link on the counterpart.

Allowed values:

Response

created relationship
idstringOptional
ULID
kindenumOptional
Allowed values:
work_orderobjectOptional
The work order at the other end of the link
created_atintegerOptional
Unix timestamp
updated_atintegerOptional
Unix timestamp