Rename a canonical Library document
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. Requires expected_record_version from the current document. A successful title change increments record_version; an unchanged title returns unchanged. Stale revisions return a409 command-result receipt.
curl --request PATCH \
--url https://api.gratona.com/v1/admin/workspace-library/documents/{document} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"title": "<string>",
"expected_record_version": 2
}
'import requests
url = "https://api.gratona.com/v1/admin/workspace-library/documents/{document}"
payload = {
"title": "<string>",
"expected_record_version": 2
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({title: '<string>', expected_record_version: 2})
};
fetch('https://api.gratona.com/v1/admin/workspace-library/documents/{document}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'expected_record_version' => 2
]),
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}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"expected_record_version\": 2\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.gratona.com/v1/admin/workspace-library/documents/{document}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"expected_record_version\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/workspace-library/documents/{document}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"expected_record_version\": 2\n}"
response = http.request(request)
puts response.read_body{
"contract_version": "<string>",
"outcome": "<string>",
"command_receipt_id": "<string>",
"document_id": "<string>",
"idempotency_key_sha256": "<string>",
"request_sha256": "<string>",
"recorded_at": "2023-11-07T05:31:56Z",
"result_sha256": "<string>",
"document": {
"contract_version": "<string>",
"id": "<string>",
"title": "<string>",
"document_type": "<string>",
"owning_domain": "<string>",
"sensitivity_class": "<string>",
"lifecycle_status": "<string>",
"retention_class": "<string>",
"record_version": 123,
"current_version_id": "<string>",
"current_version_number": 123,
"content_directive": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"archived_at": "2023-11-07T05:31:56Z"
},
"failure": {}
}{
"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>"
}
}{
"contract_version": "<string>",
"outcome": "<string>",
"command_receipt_id": "<string>",
"document_id": "<string>",
"idempotency_key_sha256": "<string>",
"request_sha256": "<string>",
"recorded_at": "2023-11-07T05:31:56Z",
"result_sha256": "<string>",
"document": {
"contract_version": "<string>",
"id": "<string>",
"title": "<string>",
"document_type": "<string>",
"owning_domain": "<string>",
"sensitivity_class": "<string>",
"lifecycle_status": "<string>",
"retention_class": "<string>",
"record_version": 123,
"current_version_id": "<string>",
"current_version_number": 123,
"content_directive": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"archived_at": "2023-11-07T05:31:56Z"
},
"failure": {}
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Headers
Request key; replay the same key only with the same payload.
8 - 128^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$Path Parameters
Document.
Body
Request fields accepted by this operation. Omitted optional properties retain the behavior described above.
Response
Rename a canonical Library document response.
Show child attributes
Show child attributes
Domain rejection code and information, when outcome is conflict.
curl --request PATCH \
--url https://api.gratona.com/v1/admin/workspace-library/documents/{document} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"title": "<string>",
"expected_record_version": 2
}
'import requests
url = "https://api.gratona.com/v1/admin/workspace-library/documents/{document}"
payload = {
"title": "<string>",
"expected_record_version": 2
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({title: '<string>', expected_record_version: 2})
};
fetch('https://api.gratona.com/v1/admin/workspace-library/documents/{document}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'expected_record_version' => 2
]),
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}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"expected_record_version\": 2\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.gratona.com/v1/admin/workspace-library/documents/{document}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"expected_record_version\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/workspace-library/documents/{document}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"expected_record_version\": 2\n}"
response = http.request(request)
puts response.read_body{
"contract_version": "<string>",
"outcome": "<string>",
"command_receipt_id": "<string>",
"document_id": "<string>",
"idempotency_key_sha256": "<string>",
"request_sha256": "<string>",
"recorded_at": "2023-11-07T05:31:56Z",
"result_sha256": "<string>",
"document": {
"contract_version": "<string>",
"id": "<string>",
"title": "<string>",
"document_type": "<string>",
"owning_domain": "<string>",
"sensitivity_class": "<string>",
"lifecycle_status": "<string>",
"retention_class": "<string>",
"record_version": 123,
"current_version_id": "<string>",
"current_version_number": 123,
"content_directive": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"archived_at": "2023-11-07T05:31:56Z"
},
"failure": {}
}{
"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>"
}
}{
"contract_version": "<string>",
"outcome": "<string>",
"command_receipt_id": "<string>",
"document_id": "<string>",
"idempotency_key_sha256": "<string>",
"request_sha256": "<string>",
"recorded_at": "2023-11-07T05:31:56Z",
"result_sha256": "<string>",
"document": {
"contract_version": "<string>",
"id": "<string>",
"title": "<string>",
"document_type": "<string>",
"owning_domain": "<string>",
"sensitivity_class": "<string>",
"lifecycle_status": "<string>",
"retention_class": "<string>",
"record_version": 123,
"current_version_id": "<string>",
"current_version_number": 123,
"content_directive": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"archived_at": "2023-11-07T05:31:56Z"
},
"failure": {}
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}