Create StepExecution
curl --request POST \
--url https://platform.kodexa.ai/api/step-executions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"executionId": "<string>",
"organizationId": "<string>",
"attemptNumber": 123,
"completedAt": "2023-11-07T05:31:56Z",
"durationMs": 123,
"errorDetails": null,
"errorMessage": "<string>",
"inputEvent": null,
"logsUri": "<string>",
"metrics": null,
"outputEvent": null,
"sliceId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stepName": "<string>",
"stepOrder": 123
}
'import requests
url = "https://platform.kodexa.ai/api/step-executions"
payload = {
"executionId": "<string>",
"organizationId": "<string>",
"attemptNumber": 123,
"completedAt": "2023-11-07T05:31:56Z",
"durationMs": 123,
"errorDetails": None,
"errorMessage": "<string>",
"inputEvent": None,
"logsUri": "<string>",
"metrics": None,
"outputEvent": None,
"sliceId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stepName": "<string>",
"stepOrder": 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({
executionId: '<string>',
organizationId: '<string>',
attemptNumber: 123,
completedAt: '2023-11-07T05:31:56Z',
durationMs: 123,
errorDetails: null,
errorMessage: '<string>',
inputEvent: null,
logsUri: '<string>',
metrics: null,
outputEvent: null,
sliceId: '<string>',
startedAt: '2023-11-07T05:31:56Z',
status: '<string>',
stepName: '<string>',
stepOrder: 123
})
};
fetch('https://platform.kodexa.ai/api/step-executions', 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/step-executions",
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([
'executionId' => '<string>',
'organizationId' => '<string>',
'attemptNumber' => 123,
'completedAt' => '2023-11-07T05:31:56Z',
'durationMs' => 123,
'errorDetails' => null,
'errorMessage' => '<string>',
'inputEvent' => null,
'logsUri' => '<string>',
'metrics' => null,
'outputEvent' => null,
'sliceId' => '<string>',
'startedAt' => '2023-11-07T05:31:56Z',
'status' => '<string>',
'stepName' => '<string>',
'stepOrder' => 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/step-executions"
payload := strings.NewReader("{\n \"executionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"attemptNumber\": 123,\n \"completedAt\": \"2023-11-07T05:31:56Z\",\n \"durationMs\": 123,\n \"errorDetails\": null,\n \"errorMessage\": \"<string>\",\n \"inputEvent\": null,\n \"logsUri\": \"<string>\",\n \"metrics\": null,\n \"outputEvent\": null,\n \"sliceId\": \"<string>\",\n \"startedAt\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"stepName\": \"<string>\",\n \"stepOrder\": 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/step-executions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"executionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"attemptNumber\": 123,\n \"completedAt\": \"2023-11-07T05:31:56Z\",\n \"durationMs\": 123,\n \"errorDetails\": null,\n \"errorMessage\": \"<string>\",\n \"inputEvent\": null,\n \"logsUri\": \"<string>\",\n \"metrics\": null,\n \"outputEvent\": null,\n \"sliceId\": \"<string>\",\n \"startedAt\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"stepName\": \"<string>\",\n \"stepOrder\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/step-executions")
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 \"executionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"attemptNumber\": 123,\n \"completedAt\": \"2023-11-07T05:31:56Z\",\n \"durationMs\": 123,\n \"errorDetails\": null,\n \"errorMessage\": \"<string>\",\n \"inputEvent\": null,\n \"logsUri\": \"<string>\",\n \"metrics\": null,\n \"outputEvent\": null,\n \"sliceId\": \"<string>\",\n \"startedAt\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"stepName\": \"<string>\",\n \"stepOrder\": 123\n}"
response = http.request(request)
puts response.read_body{
"attemptNumber": 123,
"changeSequence": 123,
"completedAt": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"durationMs": 123,
"errorDetails": null,
"errorMessage": "<string>",
"executionId": "<string>",
"id": "<string>",
"inputEvent": null,
"logsUri": "<string>",
"metrics": null,
"organizationId": "<string>",
"outputEvent": null,
"sliceId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stepName": "<string>",
"stepOrder": 123,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Step Executions
Create StepExecution
Creates a new StepExecution. Step executions record results of individual processing steps within execution slices.
POST
/
api
/
step-executions
Create StepExecution
curl --request POST \
--url https://platform.kodexa.ai/api/step-executions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"executionId": "<string>",
"organizationId": "<string>",
"attemptNumber": 123,
"completedAt": "2023-11-07T05:31:56Z",
"durationMs": 123,
"errorDetails": null,
"errorMessage": "<string>",
"inputEvent": null,
"logsUri": "<string>",
"metrics": null,
"outputEvent": null,
"sliceId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stepName": "<string>",
"stepOrder": 123
}
'import requests
url = "https://platform.kodexa.ai/api/step-executions"
payload = {
"executionId": "<string>",
"organizationId": "<string>",
"attemptNumber": 123,
"completedAt": "2023-11-07T05:31:56Z",
"durationMs": 123,
"errorDetails": None,
"errorMessage": "<string>",
"inputEvent": None,
"logsUri": "<string>",
"metrics": None,
"outputEvent": None,
"sliceId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stepName": "<string>",
"stepOrder": 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({
executionId: '<string>',
organizationId: '<string>',
attemptNumber: 123,
completedAt: '2023-11-07T05:31:56Z',
durationMs: 123,
errorDetails: null,
errorMessage: '<string>',
inputEvent: null,
logsUri: '<string>',
metrics: null,
outputEvent: null,
sliceId: '<string>',
startedAt: '2023-11-07T05:31:56Z',
status: '<string>',
stepName: '<string>',
stepOrder: 123
})
};
fetch('https://platform.kodexa.ai/api/step-executions', 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/step-executions",
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([
'executionId' => '<string>',
'organizationId' => '<string>',
'attemptNumber' => 123,
'completedAt' => '2023-11-07T05:31:56Z',
'durationMs' => 123,
'errorDetails' => null,
'errorMessage' => '<string>',
'inputEvent' => null,
'logsUri' => '<string>',
'metrics' => null,
'outputEvent' => null,
'sliceId' => '<string>',
'startedAt' => '2023-11-07T05:31:56Z',
'status' => '<string>',
'stepName' => '<string>',
'stepOrder' => 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/step-executions"
payload := strings.NewReader("{\n \"executionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"attemptNumber\": 123,\n \"completedAt\": \"2023-11-07T05:31:56Z\",\n \"durationMs\": 123,\n \"errorDetails\": null,\n \"errorMessage\": \"<string>\",\n \"inputEvent\": null,\n \"logsUri\": \"<string>\",\n \"metrics\": null,\n \"outputEvent\": null,\n \"sliceId\": \"<string>\",\n \"startedAt\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"stepName\": \"<string>\",\n \"stepOrder\": 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/step-executions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"executionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"attemptNumber\": 123,\n \"completedAt\": \"2023-11-07T05:31:56Z\",\n \"durationMs\": 123,\n \"errorDetails\": null,\n \"errorMessage\": \"<string>\",\n \"inputEvent\": null,\n \"logsUri\": \"<string>\",\n \"metrics\": null,\n \"outputEvent\": null,\n \"sliceId\": \"<string>\",\n \"startedAt\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"stepName\": \"<string>\",\n \"stepOrder\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/step-executions")
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 \"executionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"attemptNumber\": 123,\n \"completedAt\": \"2023-11-07T05:31:56Z\",\n \"durationMs\": 123,\n \"errorDetails\": null,\n \"errorMessage\": \"<string>\",\n \"inputEvent\": null,\n \"logsUri\": \"<string>\",\n \"metrics\": null,\n \"outputEvent\": null,\n \"sliceId\": \"<string>\",\n \"startedAt\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"stepName\": \"<string>\",\n \"stepOrder\": 123\n}"
response = http.request(request)
puts response.read_body{
"attemptNumber": 123,
"changeSequence": 123,
"completedAt": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"durationMs": 123,
"errorDetails": null,
"errorMessage": "<string>",
"executionId": "<string>",
"id": "<string>",
"inputEvent": null,
"logsUri": "<string>",
"metrics": null,
"organizationId": "<string>",
"outputEvent": null,
"sliceId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stepName": "<string>",
"stepOrder": 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 StepExecution