Create DocumentTransition
curl --request POST \
--url https://platform.kodexa.ai/api/document-transitions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"actor": null,
"dateTime": "2023-11-07T05:31:56Z",
"destinationContentObjectId": "<string>",
"index": 123,
"label": "<string>",
"sourceContentObjectId": "<string>",
"transitionType": 123
}
'import requests
url = "https://platform.kodexa.ai/api/document-transitions"
payload = {
"actor": None,
"dateTime": "2023-11-07T05:31:56Z",
"destinationContentObjectId": "<string>",
"index": 123,
"label": "<string>",
"sourceContentObjectId": "<string>",
"transitionType": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
actor: null,
dateTime: '2023-11-07T05:31:56Z',
destinationContentObjectId: '<string>',
index: 123,
label: '<string>',
sourceContentObjectId: '<string>',
transitionType: 123
})
};
fetch('https://platform.kodexa.ai/api/document-transitions', 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/document-transitions",
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([
'actor' => null,
'dateTime' => '2023-11-07T05:31:56Z',
'destinationContentObjectId' => '<string>',
'index' => 123,
'label' => '<string>',
'sourceContentObjectId' => '<string>',
'transitionType' => 123
]),
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/document-transitions"
payload := strings.NewReader("{\n \"actor\": null,\n \"dateTime\": \"2023-11-07T05:31:56Z\",\n \"destinationContentObjectId\": \"<string>\",\n \"index\": 123,\n \"label\": \"<string>\",\n \"sourceContentObjectId\": \"<string>\",\n \"transitionType\": 123\n}")
req, _ := http.NewRequest("POST", 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.post("https://platform.kodexa.ai/api/document-transitions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"actor\": null,\n \"dateTime\": \"2023-11-07T05:31:56Z\",\n \"destinationContentObjectId\": \"<string>\",\n \"index\": 123,\n \"label\": \"<string>\",\n \"sourceContentObjectId\": \"<string>\",\n \"transitionType\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/document-transitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actor\": null,\n \"dateTime\": \"2023-11-07T05:31:56Z\",\n \"destinationContentObjectId\": \"<string>\",\n \"index\": 123,\n \"label\": \"<string>\",\n \"sourceContentObjectId\": \"<string>\",\n \"transitionType\": 123\n}"
response = http.request(request)
puts response.read_body{
"actor": null,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"dateTime": "2023-11-07T05:31:56Z",
"destinationContentObjectId": "<string>",
"id": "<string>",
"index": 123,
"label": "<string>",
"sourceContentObjectId": "<string>",
"transitionType": 123,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Document Transitions
Create DocumentTransition
Creates a new DocumentTransition. Document transitions record state changes through processing stages.
POST
/
api
/
document-transitions
Create DocumentTransition
curl --request POST \
--url https://platform.kodexa.ai/api/document-transitions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"actor": null,
"dateTime": "2023-11-07T05:31:56Z",
"destinationContentObjectId": "<string>",
"index": 123,
"label": "<string>",
"sourceContentObjectId": "<string>",
"transitionType": 123
}
'import requests
url = "https://platform.kodexa.ai/api/document-transitions"
payload = {
"actor": None,
"dateTime": "2023-11-07T05:31:56Z",
"destinationContentObjectId": "<string>",
"index": 123,
"label": "<string>",
"sourceContentObjectId": "<string>",
"transitionType": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
actor: null,
dateTime: '2023-11-07T05:31:56Z',
destinationContentObjectId: '<string>',
index: 123,
label: '<string>',
sourceContentObjectId: '<string>',
transitionType: 123
})
};
fetch('https://platform.kodexa.ai/api/document-transitions', 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/document-transitions",
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([
'actor' => null,
'dateTime' => '2023-11-07T05:31:56Z',
'destinationContentObjectId' => '<string>',
'index' => 123,
'label' => '<string>',
'sourceContentObjectId' => '<string>',
'transitionType' => 123
]),
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/document-transitions"
payload := strings.NewReader("{\n \"actor\": null,\n \"dateTime\": \"2023-11-07T05:31:56Z\",\n \"destinationContentObjectId\": \"<string>\",\n \"index\": 123,\n \"label\": \"<string>\",\n \"sourceContentObjectId\": \"<string>\",\n \"transitionType\": 123\n}")
req, _ := http.NewRequest("POST", 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.post("https://platform.kodexa.ai/api/document-transitions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"actor\": null,\n \"dateTime\": \"2023-11-07T05:31:56Z\",\n \"destinationContentObjectId\": \"<string>\",\n \"index\": 123,\n \"label\": \"<string>\",\n \"sourceContentObjectId\": \"<string>\",\n \"transitionType\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/document-transitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actor\": null,\n \"dateTime\": \"2023-11-07T05:31:56Z\",\n \"destinationContentObjectId\": \"<string>\",\n \"index\": 123,\n \"label\": \"<string>\",\n \"sourceContentObjectId\": \"<string>\",\n \"transitionType\": 123\n}"
response = http.request(request)
puts response.read_body{
"actor": null,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"dateTime": "2023-11-07T05:31:56Z",
"destinationContentObjectId": "<string>",
"id": "<string>",
"index": 123,
"label": "<string>",
"sourceContentObjectId": "<string>",
"transitionType": 123,
"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.
Body
application/json
Response
Created DocumentTransition
A document transition records a state change of a document through processing stages.