Skip to navigation
API ReferenceRecord View Links

Create Record View Link With Service

Beta

Creates a short-lived capability link for viewing one stored record snapshot.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Headers

X-Polytomic-VersionstringOptional
X-Polytomic-Harbor-SessionstringOptional

Harbor session token; when supplied, the session must be active and bound to this credential and Harbor.

X-Polytomic-Activity-Request-IDstringOptional

New nonzero UUID for each request, required for scoped credentials; a reused value is rejected.

Request

This endpoint expects an object.
connection_idstringRequiredformat: "uuid"
Connection containing the record
lookup_key_fieldstringRequired

The schema lookup-key field used to identify the record. V1 only accepts the schema’s single effective primary key.

lookup_key_valuestringRequired

The lookup-key value for the record

schema_idstringRequired
Schema containing the record
expires_atdatetime or nullOptional
Optional expiry timestamp. Defaults to 72 hours and cannot exceed 7 days.
fieldslist of stringsOptional
Optional field IDs to include. If omitted, all eligible readable fields are included.
sourcestringOptional

Optional creator/source label

Response

OK
dataobjectOptional

The created record-view link

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error