Post Work Orders Id Documents

POST

https://app.hindsiteind.com/api/v2/work_orders/:id/documents

POST

/api/v2/work_orders/:id/documents

curl -X POST https://app.hindsiteind.com/api/v2/work_orders/id/documents \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "signed_id": "string",
  "category_id": "string"
}'

201Created

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

Attaches a file to the work order from a signed blob ID obtained via the direct-upload flow, under one of the organisation’s file categories.

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

Request

This endpoint expects an object.

signed_idstringRequired

Signed blob ID from the direct-upload flow

category_idstringRequired

A file category ID from GET /api/v2/work_order_document_categories

Response

created WorkOrderDocument

idstringOptional

ULID

categoryobjectOptional

userobjectOptional

fileobjectOptional

created_atintegerOptional

Epoch seconds

updated_atintegerOptional

Epoch seconds