solarOSsolarOS Docs

Create an External Reference

Creates or replays one tenant-scoped External Reference for a solarOS resource. Replays return the existing reference when the tuple already points at the same resource; conflicts return 409. Required scope: external_references:write.

POST
/external-references

Creates or replays one tenant-scoped External Reference for a solarOS resource. Replays return the existing reference when the tuple already points at the same resource; conflicts return 409. Required scope: external_references:write.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Request Body

application/json

JSON request payload for createExternalReference.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/external-references" \  -H "Content-Type: application/json" \  -d '{    "resourceType": "WorkOrder",    "resourceId": "work_order_123",    "externalSystem": "salesforce",    "externalObject": "WorkOrder",    "externalId": "0WO123"  }'
{  "data": {},  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}