Update ContentObject
curl --request PUT \
--url https://platform.kodexa.ai/api/content-objects/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"contentMetadata": {},
"contentType": 123,
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"docTransitionType": "<string>",
"documentFamilyId": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": true,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": true,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": true,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"documentVersion": "<string>",
"id": "<string>",
"index": 123,
"metadata": {},
"mixins": [
"<string>"
],
"modified": "2023-11-07T05:31:56Z",
"name": "<string>",
"size": 123,
"source": {
"checksum": "<string>",
"cid": "<string>",
"connector": "<string>",
"created": "<string>",
"document_family_id": "<string>",
"headers": {},
"last_modified": "<string>",
"lineage_document_uuid": "<string>",
"mime_type": "<string>",
"original_filename": "<string>",
"original_path": "<string>",
"source_document_uuid": "<string>"
},
"sourceContentObjectId": "<string>",
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/content-objects/{id}"
payload = {
"changeSequence": 123,
"contentMetadata": {},
"contentType": 123,
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"docTransitionType": "<string>",
"documentFamilyId": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": True,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": True,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": True,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"documentVersion": "<string>",
"id": "<string>",
"index": 123,
"metadata": {},
"mixins": ["<string>"],
"modified": "2023-11-07T05:31:56Z",
"name": "<string>",
"size": 123,
"source": {
"checksum": "<string>",
"cid": "<string>",
"connector": "<string>",
"created": "<string>",
"document_family_id": "<string>",
"headers": {},
"last_modified": "<string>",
"lineage_document_uuid": "<string>",
"mime_type": "<string>",
"original_filename": "<string>",
"original_path": "<string>",
"source_document_uuid": "<string>"
},
"sourceContentObjectId": "<string>",
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
contentMetadata: {},
contentType: 123,
created: '2023-11-07T05:31:56Z',
createdOn: '2023-11-07T05:31:56Z',
docTransitionType: '<string>',
documentFamilyId: '<string>',
documentTaxonValidations: [
{
taxonPath: '<string>',
taxonomyRef: '<string>',
validation: {
conditional: true,
conditionalFormula: '<string>',
description: '<string>',
detailFormula: '<string>',
disabled: true,
exceptionId: '<string>',
messageFormula: '<string>',
name: '<string>',
overridable: true,
ruleFormula: '<string>',
supportArticleId: '<string>'
}
}
],
documentVersion: '<string>',
id: '<string>',
index: 123,
metadata: {},
mixins: ['<string>'],
modified: '2023-11-07T05:31:56Z',
name: '<string>',
size: 123,
source: {
checksum: '<string>',
cid: '<string>',
connector: '<string>',
created: '<string>',
document_family_id: '<string>',
headers: {},
last_modified: '<string>',
lineage_document_uuid: '<string>',
mime_type: '<string>',
original_filename: '<string>',
original_path: '<string>',
source_document_uuid: '<string>'
},
sourceContentObjectId: '<string>',
storeRef: '<string>',
summary: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/content-objects/{id}', 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://platform.kodexa.ai/api/content-objects/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'changeSequence' => 123,
'contentMetadata' => [
],
'contentType' => 123,
'created' => '2023-11-07T05:31:56Z',
'createdOn' => '2023-11-07T05:31:56Z',
'docTransitionType' => '<string>',
'documentFamilyId' => '<string>',
'documentTaxonValidations' => [
[
'taxonPath' => '<string>',
'taxonomyRef' => '<string>',
'validation' => [
'conditional' => true,
'conditionalFormula' => '<string>',
'description' => '<string>',
'detailFormula' => '<string>',
'disabled' => true,
'exceptionId' => '<string>',
'messageFormula' => '<string>',
'name' => '<string>',
'overridable' => true,
'ruleFormula' => '<string>',
'supportArticleId' => '<string>'
]
]
],
'documentVersion' => '<string>',
'id' => '<string>',
'index' => 123,
'metadata' => [
],
'mixins' => [
'<string>'
],
'modified' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'size' => 123,
'source' => [
'checksum' => '<string>',
'cid' => '<string>',
'connector' => '<string>',
'created' => '<string>',
'document_family_id' => '<string>',
'headers' => [
],
'last_modified' => '<string>',
'lineage_document_uuid' => '<string>',
'mime_type' => '<string>',
'original_filename' => '<string>',
'original_path' => '<string>',
'source_document_uuid' => '<string>'
],
'sourceContentObjectId' => '<string>',
'storeRef' => '<string>',
'summary' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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://platform.kodexa.ai/api/content-objects/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://platform.kodexa.ai/api/content-objects/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/content-objects/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"contentMetadata": {},
"contentType": 123,
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"docTransitionType": "<string>",
"documentFamilyId": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": true,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": true,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": true,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"documentVersion": "<string>",
"id": "<string>",
"index": 123,
"metadata": {},
"mixins": [
"<string>"
],
"modified": "2023-11-07T05:31:56Z",
"name": "<string>",
"size": 123,
"source": {
"checksum": "<string>",
"cid": "<string>",
"connector": "<string>",
"created": "<string>",
"document_family_id": "<string>",
"headers": {},
"last_modified": "<string>",
"lineage_document_uuid": "<string>",
"mime_type": "<string>",
"original_filename": "<string>",
"original_path": "<string>",
"source_document_uuid": "<string>"
},
"sourceContentObjectId": "<string>",
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Content Object
Update ContentObject
Updates an existing ContentObject. Content objects represent individual files or processing results within a document family.
PUT
/
api
/
content-objects
/
{id}
Update ContentObject
curl --request PUT \
--url https://platform.kodexa.ai/api/content-objects/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"contentMetadata": {},
"contentType": 123,
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"docTransitionType": "<string>",
"documentFamilyId": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": true,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": true,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": true,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"documentVersion": "<string>",
"id": "<string>",
"index": 123,
"metadata": {},
"mixins": [
"<string>"
],
"modified": "2023-11-07T05:31:56Z",
"name": "<string>",
"size": 123,
"source": {
"checksum": "<string>",
"cid": "<string>",
"connector": "<string>",
"created": "<string>",
"document_family_id": "<string>",
"headers": {},
"last_modified": "<string>",
"lineage_document_uuid": "<string>",
"mime_type": "<string>",
"original_filename": "<string>",
"original_path": "<string>",
"source_document_uuid": "<string>"
},
"sourceContentObjectId": "<string>",
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/content-objects/{id}"
payload = {
"changeSequence": 123,
"contentMetadata": {},
"contentType": 123,
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"docTransitionType": "<string>",
"documentFamilyId": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": True,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": True,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": True,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"documentVersion": "<string>",
"id": "<string>",
"index": 123,
"metadata": {},
"mixins": ["<string>"],
"modified": "2023-11-07T05:31:56Z",
"name": "<string>",
"size": 123,
"source": {
"checksum": "<string>",
"cid": "<string>",
"connector": "<string>",
"created": "<string>",
"document_family_id": "<string>",
"headers": {},
"last_modified": "<string>",
"lineage_document_uuid": "<string>",
"mime_type": "<string>",
"original_filename": "<string>",
"original_path": "<string>",
"source_document_uuid": "<string>"
},
"sourceContentObjectId": "<string>",
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
contentMetadata: {},
contentType: 123,
created: '2023-11-07T05:31:56Z',
createdOn: '2023-11-07T05:31:56Z',
docTransitionType: '<string>',
documentFamilyId: '<string>',
documentTaxonValidations: [
{
taxonPath: '<string>',
taxonomyRef: '<string>',
validation: {
conditional: true,
conditionalFormula: '<string>',
description: '<string>',
detailFormula: '<string>',
disabled: true,
exceptionId: '<string>',
messageFormula: '<string>',
name: '<string>',
overridable: true,
ruleFormula: '<string>',
supportArticleId: '<string>'
}
}
],
documentVersion: '<string>',
id: '<string>',
index: 123,
metadata: {},
mixins: ['<string>'],
modified: '2023-11-07T05:31:56Z',
name: '<string>',
size: 123,
source: {
checksum: '<string>',
cid: '<string>',
connector: '<string>',
created: '<string>',
document_family_id: '<string>',
headers: {},
last_modified: '<string>',
lineage_document_uuid: '<string>',
mime_type: '<string>',
original_filename: '<string>',
original_path: '<string>',
source_document_uuid: '<string>'
},
sourceContentObjectId: '<string>',
storeRef: '<string>',
summary: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/content-objects/{id}', 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://platform.kodexa.ai/api/content-objects/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'changeSequence' => 123,
'contentMetadata' => [
],
'contentType' => 123,
'created' => '2023-11-07T05:31:56Z',
'createdOn' => '2023-11-07T05:31:56Z',
'docTransitionType' => '<string>',
'documentFamilyId' => '<string>',
'documentTaxonValidations' => [
[
'taxonPath' => '<string>',
'taxonomyRef' => '<string>',
'validation' => [
'conditional' => true,
'conditionalFormula' => '<string>',
'description' => '<string>',
'detailFormula' => '<string>',
'disabled' => true,
'exceptionId' => '<string>',
'messageFormula' => '<string>',
'name' => '<string>',
'overridable' => true,
'ruleFormula' => '<string>',
'supportArticleId' => '<string>'
]
]
],
'documentVersion' => '<string>',
'id' => '<string>',
'index' => 123,
'metadata' => [
],
'mixins' => [
'<string>'
],
'modified' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'size' => 123,
'source' => [
'checksum' => '<string>',
'cid' => '<string>',
'connector' => '<string>',
'created' => '<string>',
'document_family_id' => '<string>',
'headers' => [
],
'last_modified' => '<string>',
'lineage_document_uuid' => '<string>',
'mime_type' => '<string>',
'original_filename' => '<string>',
'original_path' => '<string>',
'source_document_uuid' => '<string>'
],
'sourceContentObjectId' => '<string>',
'storeRef' => '<string>',
'summary' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-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://platform.kodexa.ai/api/content-objects/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://platform.kodexa.ai/api/content-objects/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/content-objects/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"contentMetadata": {},
"contentType": 123,
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"docTransitionType": "<string>",
"documentFamilyId": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": true,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": true,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": true,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"documentVersion": "<string>",
"id": "<string>",
"index": 123,
"metadata": {},
"mixins": [
"<string>"
],
"modified": "2023-11-07T05:31:56Z",
"name": "<string>",
"size": 123,
"source": {
"checksum": "<string>",
"cid": "<string>",
"connector": "<string>",
"created": "<string>",
"document_family_id": "<string>",
"headers": {},
"last_modified": "<string>",
"lineage_document_uuid": "<string>",
"mime_type": "<string>",
"original_filename": "<string>",
"original_path": "<string>",
"source_document_uuid": "<string>"
},
"sourceContentObjectId": "<string>",
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Path Parameters
Unique identifier (UUID) of the resource.
Body
application/json
A content object represents an individual file or processing result within a document family.
Optimistic locking version number.
Content-level metadata extracted during processing.
Show child attributes
Show child attributes
Type of content: DOCUMENT or NATIVE.
Timestamp when the content object was created.
ID of the parent document family.
Show child attributes
Show child attributes
Document version identifier.
Unique identifier (UUID) for the content object.
Ordering index within the document family.
Metadata extracted from the content.
Show child attributes
Show child attributes
List of mixin names applied to this content object (e.g., spatial, workbook, text).
File size in bytes.
Source/origin metadata for the content object.
Show child attributes
Show child attributes
Reference to the storage location.
AI-generated summary of the content.
Timestamp when the content object was last updated.
Secondary UUID identifier.
Response
Updated ContentObject
A content object represents an individual file or processing result within a document family.
Optimistic locking version number.
Content-level metadata extracted during processing.
Show child attributes
Show child attributes
Type of content: DOCUMENT or NATIVE.
Timestamp when the content object was created.
ID of the parent document family.
Show child attributes
Show child attributes
Document version identifier.
Unique identifier (UUID) for the content object.
Ordering index within the document family.
Metadata extracted from the content.
Show child attributes
Show child attributes
List of mixin names applied to this content object (e.g., spatial, workbook, text).
File size in bytes.
Source/origin metadata for the content object.
Show child attributes
Show child attributes
Reference to the storage location.
AI-generated summary of the content.
Timestamp when the content object was last updated.
Secondary UUID identifier.
⌘I