Library

Link a canonical document to a record

Requires current Library authority and tenant ownership. Content directives are full, masked_identifiers or none; masked documents omit protected identity values. Commands accept only their documented JSON keys and reject query-string fields. Required Idempotency-Key is 8-128 URL-safe characters; changed payload under the same key conflicts. Both current-version boundary fields must be present and either both null or both populated. subject_id is a string; subject and relationship types must be registered and accessible. is_primary must be a JSON boolean. Stale document boundaries or idempotency conflicts return 409.

POST

admin

workspace-library

documents

{document}

links

Link a canonical document to a record

curl --request POST \
  --url https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "expected_document_record_version": 2,
  "expected_current_document_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_current_document_version_number": 2,
  "subject_type": "<string>",
  "subject_id": "<string>",
  "relationship_type": "<string>",
  "is_primary": true
}
'

import requests

url = "https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links"

payload = {
    "expected_document_record_version": 2,
    "expected_current_document_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_current_document_version_number": 2,
    "subject_type": "<string>",
    "subject_id": "<string>",
    "relationship_type": "<string>",
    "is_primary": True
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    expected_document_record_version: 2,
    expected_current_document_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expected_current_document_version_number: 2,
    subject_type: '<string>',
    subject_id: '<string>',
    relationship_type: '<string>',
    is_primary: true
  })
};

fetch('https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expected_document_record_version' => 2,
    'expected_current_document_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'expected_current_document_version_number' => 2,
    'subject_type' => '<string>',
    'subject_id' => '<string>',
    'relationship_type' => '<string>',
    'is_primary' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links"

	payload := strings.NewReader("{\n  \"expected_document_record_version\": 2,\n  \"expected_current_document_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_current_document_version_number\": 2,\n  \"subject_type\": \"<string>\",\n  \"subject_id\": \"<string>\",\n  \"relationship_type\": \"<string>\",\n  \"is_primary\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_document_record_version\": 2,\n  \"expected_current_document_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_current_document_version_number\": 2,\n  \"subject_type\": \"<string>\",\n  \"subject_id\": \"<string>\",\n  \"relationship_type\": \"<string>\",\n  \"is_primary\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expected_document_record_version\": 2,\n  \"expected_current_document_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_current_document_version_number\": 2,\n  \"subject_type\": \"<string>\",\n  \"subject_id\": \"<string>\",\n  \"relationship_type\": \"<string>\",\n  \"is_primary\": true\n}"

response = http.request(request)
puts response.read_body

{
  "contract_family": "<string>",
  "contract_version": "<string>",
  "command_receipt_id": "<string>",
  "content_directive": "<string>",
  "operation": "<string>",
  "outcome": "<string>",
  "idempotency_key_sha256": "<string>",
  "request_sha256": "<string>",
  "recorded_at": "2023-11-07T05:31:56Z",
  "result_sha256": "<string>",
  "link": {
    "link_id": "<string>",
    "document_id": "<string>",
    "subject_type": "<string>",
    "subject_id": "<string>",
    "subject_version": "<string>",
    "relationship_type": "<string>",
    "label_snapshot": "<string>",
    "is_primary": true,
    "status": "<string>",
    "record_version": 123,
    "linked_at": "2023-11-07T05:31:56Z",
    "unlinked_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Headers

Idempotency-Key

string

required

Request key; replay the same key only with the same payload.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$

Path Parameters

document

string<uuid>

required

Document.

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

expected_document_record_version

integer

required

Validation: required|integer|min:1.

Required range: x >= 1

expected_current_document_version_id

string<uuid> | null

required

Validation: present|nullable|uuid.

expected_current_document_version_number

integer | null

required

Validation: present|nullable|integer|min:1.

Required range: x >= 1

subject_type

string

required

Validation: required|string|max:128.

Maximum string length: 128

Pattern: ^[a-z][a-z0-9._:-]{0,127}$

subject_id

string

required

Validation: required|string|max:128.

Maximum string length: 128

relationship_type

string

required

Validation: required|string|max:64.

Maximum string length: 64

Pattern: ^[a-z][a-z0-9._:-]{0,63}$

is_primary

boolean

required

Validation: required|boolean.

Response

Link a canonical document to a record response.

contract_family

string

contract_version

string

command_receipt_id

string

content_directive

string

operation

string

outcome

string

idempotency_key_sha256

string

request_sha256

string

recorded_at

string<date-time>

result_sha256

string

link

object

Show child attributes

Link a canonical document to a record

curl --request POST \
  --url https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "expected_document_record_version": 2,
  "expected_current_document_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_current_document_version_number": 2,
  "subject_type": "<string>",
  "subject_id": "<string>",
  "relationship_type": "<string>",
  "is_primary": true
}
'

import requests

url = "https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links"

payload = {
    "expected_document_record_version": 2,
    "expected_current_document_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_current_document_version_number": 2,
    "subject_type": "<string>",
    "subject_id": "<string>",
    "relationship_type": "<string>",
    "is_primary": True
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    expected_document_record_version: 2,
    expected_current_document_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expected_current_document_version_number: 2,
    subject_type: '<string>',
    subject_id: '<string>',
    relationship_type: '<string>',
    is_primary: true
  })
};

fetch('https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expected_document_record_version' => 2,
    'expected_current_document_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'expected_current_document_version_number' => 2,
    'subject_type' => '<string>',
    'subject_id' => '<string>',
    'relationship_type' => '<string>',
    'is_primary' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links"

	payload := strings.NewReader("{\n  \"expected_document_record_version\": 2,\n  \"expected_current_document_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_current_document_version_number\": 2,\n  \"subject_type\": \"<string>\",\n  \"subject_id\": \"<string>\",\n  \"relationship_type\": \"<string>\",\n  \"is_primary\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_document_record_version\": 2,\n  \"expected_current_document_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_current_document_version_number\": 2,\n  \"subject_type\": \"<string>\",\n  \"subject_id\": \"<string>\",\n  \"relationship_type\": \"<string>\",\n  \"is_primary\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/workspace-library/documents/{document}/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expected_document_record_version\": 2,\n  \"expected_current_document_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_current_document_version_number\": 2,\n  \"subject_type\": \"<string>\",\n  \"subject_id\": \"<string>\",\n  \"relationship_type\": \"<string>\",\n  \"is_primary\": true\n}"

response = http.request(request)
puts response.read_body

{
  "contract_family": "<string>",
  "contract_version": "<string>",
  "command_receipt_id": "<string>",
  "content_directive": "<string>",
  "operation": "<string>",
  "outcome": "<string>",
  "idempotency_key_sha256": "<string>",
  "request_sha256": "<string>",
  "recorded_at": "2023-11-07T05:31:56Z",
  "result_sha256": "<string>",
  "link": {
    "link_id": "<string>",
    "document_id": "<string>",
    "subject_type": "<string>",
    "subject_id": "<string>",
    "subject_version": "<string>",
    "relationship_type": "<string>",
    "label_snapshot": "<string>",
    "is_primary": true,
    "status": "<string>",
    "record_version": 123,
    "linked_at": "2023-11-07T05:31:56Z",
    "unlinked_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}