Record View Links

Create Record View Link With Service

Changed on

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

post/api/record-view-links

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Headers

X-Polytomic-Versionstring
X-Polytomic-Harbor-Sessionstring

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

X-Polytomic-Activity-Request-IDstring

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

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

Changes

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added the new optional header request parameter X-Polytomic-Activity-Request-ID

    • info

      added the new optional header request parameter X-Polytomic-Harbor-Session

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status