v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Record View Links

Create Record View Link With Service

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

post/api/record-view-links

Headers

X-Polytomic-Versionstring

Request body

connection_idstring uuid required

Connection containing the record.

expires_atstring date-time nullable

Optional expiry timestamp. Defaults to 72 hours and cannot exceed 7 days.

fieldsstring[]

Optional field IDs to include. If omitted, all eligible readable fields are included.

lookup_key_fieldstring required

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

lookup_key_valuestring required

The lookup-key value for the record.

schema_idstring required

Schema containing the record.

sourcestring

Optional creator/source label.

Example request

{
  "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
}

Response

OK

Example response

{
  "data": {
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}