Update JobDocumentFamilyInteraction
curl --request PUT \
--url https://platform.kodexa.ai/api/job-document-family-interactions/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"documentFamilyId": "<string>",
"endTimestamp": "2023-11-07T05:31:56Z",
"id": "<string>",
"scheduledJobExecution": {
"changeSequence": 123,
"completionMessage": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"exceptionDetails": "<string>",
"id": "<string>",
"logGroup": "<string>",
"logStream": "<string>",
"requestId": "<string>",
"scheduledJob": {
"active": true,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "f5678901-23ab-cdef-4567-890123abcdef",
"modelRef": "<string>",
"name": "Daily Invoice Processing",
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": {
"showNewTask": true
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"properties": {},
"schedules": [
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"cronExpression": "<string>",
"id": "<string>",
"lastEvent": "2023-11-07T05:31:56Z",
"nextEvent": "2023-11-07T05:31:56Z",
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"searchText": "<string>",
"slug": "daily-invoice-processing",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"scheduledJobId": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"userCancelled": true,
"uuid": "<string>"
},
"scheduledJobExecutionId": "<string>",
"startTimestamp": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/job-document-family-interactions/{id}"
payload = {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"documentFamilyId": "<string>",
"endTimestamp": "2023-11-07T05:31:56Z",
"id": "<string>",
"scheduledJobExecution": {
"changeSequence": 123,
"completionMessage": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"exceptionDetails": "<string>",
"id": "<string>",
"logGroup": "<string>",
"logStream": "<string>",
"requestId": "<string>",
"scheduledJob": {
"active": True,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleted": True,
"description": "<string>",
"id": "f5678901-23ab-cdef-4567-890123abcdef",
"modelRef": "<string>",
"name": "Daily Invoice Processing",
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": ["<string>"],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": ["<string>"],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": { "showNewTask": True },
"taxonTypeFeatures": {}
},
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<string>"] },
"showDeveloperTools": True,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": True,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"properties": {},
"schedules": [
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"cronExpression": "<string>",
"id": "<string>",
"lastEvent": "2023-11-07T05:31:56Z",
"nextEvent": "2023-11-07T05:31:56Z",
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"searchText": "<string>",
"slug": "daily-invoice-processing",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"scheduledJobId": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"userCancelled": True,
"uuid": "<string>"
},
"scheduledJobExecutionId": "<string>",
"startTimestamp": "2023-11-07T05:31:56Z",
"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,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
documentFamilyId: '<string>',
endTimestamp: '2023-11-07T05:31:56Z',
id: '<string>',
scheduledJobExecution: {
changeSequence: 123,
completionMessage: '<string>',
createdOn: '2023-11-07T05:31:56Z',
endTime: '2023-11-07T05:31:56Z',
exceptionDetails: '<string>',
id: '<string>',
logGroup: '<string>',
logStream: '<string>',
requestId: '<string>',
scheduledJob: {
active: true,
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
deleted: true,
description: '<string>',
id: 'f5678901-23ab-cdef-4567-890123abcdef',
modelRef: '<string>',
name: 'Daily Invoice Processing',
project: {
changeSequence: 123,
color: '#4A90D9',
createdOn: '2023-11-07T05:31:56Z',
dataFlow: {
edges: [{id: '<string>', properties: {}, source: '<string>', target: '<string>'}],
nodes: [
{
dimensions: {height: 123, width: 123},
id: '<string>',
parentId: '<string>',
position: {x: 123, y: 123},
properties: {},
type: '<string>'
}
],
viewPort: {x: 123, y: 123, zoom: 123}
},
description: 'Automated invoice processing pipeline.',
documentStatuses: [
{
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
project: '<unknown>',
projectId: '<string>',
slug: '<string>',
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
],
id: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
memory: {
changeSequence: 123,
orderedDashboards: ['<string>'],
recentFilters: {},
recentQueries: {}
},
name: 'Invoice Processing',
notes: '<string>',
options: {
companion: {agentRuntimeRef: '<string>', moduleRefs: ['<string>'], prompt: '<string>'},
dataOptions: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
dataProperties: {},
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
groupTaxonTypeFeatures: {},
options: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
properties: {},
taskOptions: {showNewTask: true},
taxonTypeFeatures: {}
},
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
owner: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<string>']},
showDeveloperTools: true,
title: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
userStorage: {favoriteLinks: [{link: '<string>'}]},
userType: '<string>',
uuid: '<string>'
},
ownerId: '<string>',
projectTemplateRef: '<string>',
searchText: '<string>',
slug: 'invoice-processing',
status: {
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
production: true,
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
statusId: '<string>',
statusType: 'ACTIVE',
templateArticleId: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '7c9e667974254de944be07fc1f90ae7'
},
projectId: '<string>',
properties: {},
schedules: [
{
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
cronExpression: '<string>',
id: '<string>',
lastEvent: '2023-11-07T05:31:56Z',
nextEvent: '2023-11-07T05:31:56Z',
type: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
],
searchText: '<string>',
slug: 'daily-invoice-processing',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
scheduledJobId: '<string>',
startTime: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
userCancelled: true,
uuid: '<string>'
},
scheduledJobExecutionId: '<string>',
startTimestamp: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/job-document-family-interactions/{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/job-document-family-interactions/{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,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'documentFamilyId' => '<string>',
'endTimestamp' => '2023-11-07T05:31:56Z',
'id' => '<string>',
'scheduledJobExecution' => [
'changeSequence' => 123,
'completionMessage' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'endTime' => '2023-11-07T05:31:56Z',
'exceptionDetails' => '<string>',
'id' => '<string>',
'logGroup' => '<string>',
'logStream' => '<string>',
'requestId' => '<string>',
'scheduledJob' => [
'active' => true,
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'deleted' => true,
'description' => '<string>',
'id' => 'f5678901-23ab-cdef-4567-890123abcdef',
'modelRef' => '<string>',
'name' => 'Daily Invoice Processing',
'project' => [
'changeSequence' => 123,
'color' => '#4A90D9',
'createdOn' => '2023-11-07T05:31:56Z',
'dataFlow' => [
'edges' => [
[
'id' => '<string>',
'properties' => [
],
'source' => '<string>',
'target' => '<string>'
]
],
'nodes' => [
[
'dimensions' => [
'height' => 123,
'width' => 123
],
'id' => '<string>',
'parentId' => '<string>',
'position' => [
'x' => 123,
'y' => 123
],
'properties' => [
],
'type' => '<string>'
]
],
'viewPort' => [
'x' => 123,
'y' => 123,
'zoom' => 123
]
],
'description' => 'Automated invoice processing pipeline.',
'documentStatuses' => [
[
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'project' => '<unknown>',
'projectId' => '<string>',
'slug' => '<string>',
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
],
'id' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'memory' => [
'changeSequence' => 123,
'orderedDashboards' => [
'<string>'
],
'recentFilters' => [
],
'recentQueries' => [
]
],
'name' => 'Invoice Processing',
'notes' => '<string>',
'options' => [
'companion' => [
'agentRuntimeRef' => '<string>',
'moduleRefs' => [
'<string>'
],
'prompt' => '<string>'
],
'dataOptions' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'dataProperties' => [
],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'groupTaxonTypeFeatures' => [
],
'options' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'properties' => [
],
'taskOptions' => [
'showNewTask' => true
],
'taxonTypeFeatures' => [
]
],
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'owner' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<string>'
]
],
'showDeveloperTools' => true,
'title' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'userStorage' => [
'favoriteLinks' => [
[
'link' => '<string>'
]
]
],
'userType' => '<string>',
'uuid' => '<string>'
],
'ownerId' => '<string>',
'projectTemplateRef' => '<string>',
'searchText' => '<string>',
'slug' => 'invoice-processing',
'status' => [
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'production' => true,
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'statusId' => '<string>',
'statusType' => 'ACTIVE',
'templateArticleId' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '7c9e667974254de944be07fc1f90ae7'
],
'projectId' => '<string>',
'properties' => [
],
'schedules' => [
[
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'cronExpression' => '<string>',
'id' => '<string>',
'lastEvent' => '2023-11-07T05:31:56Z',
'nextEvent' => '2023-11-07T05:31:56Z',
'type' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
],
'searchText' => '<string>',
'slug' => 'daily-invoice-processing',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'scheduledJobId' => '<string>',
'startTime' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'userCancelled' => true,
'uuid' => '<string>'
],
'scheduledJobExecutionId' => '<string>',
'startTimestamp' => '2023-11-07T05:31:56Z',
'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/job-document-family-interactions/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endTimestamp\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"scheduledJobExecution\": {\n \"changeSequence\": 123,\n \"completionMessage\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": \"<string>\",\n \"id\": \"<string>\",\n \"logGroup\": \"<string>\",\n \"logStream\": \"<string>\",\n \"requestId\": \"<string>\",\n \"scheduledJob\": {\n \"active\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"f5678901-23ab-cdef-4567-890123abcdef\",\n \"modelRef\": \"<string>\",\n \"name\": \"Daily Invoice Processing\",\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"properties\": {},\n \"schedules\": [\n {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"cronExpression\": \"<string>\",\n \"id\": \"<string>\",\n \"lastEvent\": \"2023-11-07T05:31:56Z\",\n \"nextEvent\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"searchText\": \"<string>\",\n \"slug\": \"daily-invoice-processing\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"scheduledJobId\": \"<string>\",\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userCancelled\": true,\n \"uuid\": \"<string>\"\n },\n \"scheduledJobExecutionId\": \"<string>\",\n \"startTimestamp\": \"2023-11-07T05:31:56Z\",\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/job-document-family-interactions/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endTimestamp\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"scheduledJobExecution\": {\n \"changeSequence\": 123,\n \"completionMessage\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": \"<string>\",\n \"id\": \"<string>\",\n \"logGroup\": \"<string>\",\n \"logStream\": \"<string>\",\n \"requestId\": \"<string>\",\n \"scheduledJob\": {\n \"active\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"f5678901-23ab-cdef-4567-890123abcdef\",\n \"modelRef\": \"<string>\",\n \"name\": \"Daily Invoice Processing\",\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"properties\": {},\n \"schedules\": [\n {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"cronExpression\": \"<string>\",\n \"id\": \"<string>\",\n \"lastEvent\": \"2023-11-07T05:31:56Z\",\n \"nextEvent\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"searchText\": \"<string>\",\n \"slug\": \"daily-invoice-processing\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"scheduledJobId\": \"<string>\",\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userCancelled\": true,\n \"uuid\": \"<string>\"\n },\n \"scheduledJobExecutionId\": \"<string>\",\n \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/job-document-family-interactions/{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 \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endTimestamp\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"scheduledJobExecution\": {\n \"changeSequence\": 123,\n \"completionMessage\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": \"<string>\",\n \"id\": \"<string>\",\n \"logGroup\": \"<string>\",\n \"logStream\": \"<string>\",\n \"requestId\": \"<string>\",\n \"scheduledJob\": {\n \"active\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"f5678901-23ab-cdef-4567-890123abcdef\",\n \"modelRef\": \"<string>\",\n \"name\": \"Daily Invoice Processing\",\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"properties\": {},\n \"schedules\": [\n {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"cronExpression\": \"<string>\",\n \"id\": \"<string>\",\n \"lastEvent\": \"2023-11-07T05:31:56Z\",\n \"nextEvent\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"searchText\": \"<string>\",\n \"slug\": \"daily-invoice-processing\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"scheduledJobId\": \"<string>\",\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userCancelled\": true,\n \"uuid\": \"<string>\"\n },\n \"scheduledJobExecutionId\": \"<string>\",\n \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"documentFamilyId": "<string>",
"endTimestamp": "2023-11-07T05:31:56Z",
"id": "<string>",
"scheduledJobExecution": {
"changeSequence": 123,
"completionMessage": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"exceptionDetails": "<string>",
"id": "<string>",
"logGroup": "<string>",
"logStream": "<string>",
"requestId": "<string>",
"scheduledJob": {
"active": true,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "f5678901-23ab-cdef-4567-890123abcdef",
"modelRef": "<string>",
"name": "Daily Invoice Processing",
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": {
"showNewTask": true
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"properties": {},
"schedules": [
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"cronExpression": "<string>",
"id": "<string>",
"lastEvent": "2023-11-07T05:31:56Z",
"nextEvent": "2023-11-07T05:31:56Z",
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"searchText": "<string>",
"slug": "daily-invoice-processing",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"scheduledJobId": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"userCancelled": true,
"uuid": "<string>"
},
"scheduledJobExecutionId": "<string>",
"startTimestamp": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Job Document Family Interactions
Update JobDocumentFamilyInteraction
Updates an existing JobDocumentFamilyInteraction. Job document family interactions record a scheduled job’s interactions with document families.
PUT
/
api
/
job-document-family-interactions
/
{id}
Update JobDocumentFamilyInteraction
curl --request PUT \
--url https://platform.kodexa.ai/api/job-document-family-interactions/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"documentFamilyId": "<string>",
"endTimestamp": "2023-11-07T05:31:56Z",
"id": "<string>",
"scheduledJobExecution": {
"changeSequence": 123,
"completionMessage": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"exceptionDetails": "<string>",
"id": "<string>",
"logGroup": "<string>",
"logStream": "<string>",
"requestId": "<string>",
"scheduledJob": {
"active": true,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "f5678901-23ab-cdef-4567-890123abcdef",
"modelRef": "<string>",
"name": "Daily Invoice Processing",
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": {
"showNewTask": true
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"properties": {},
"schedules": [
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"cronExpression": "<string>",
"id": "<string>",
"lastEvent": "2023-11-07T05:31:56Z",
"nextEvent": "2023-11-07T05:31:56Z",
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"searchText": "<string>",
"slug": "daily-invoice-processing",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"scheduledJobId": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"userCancelled": true,
"uuid": "<string>"
},
"scheduledJobExecutionId": "<string>",
"startTimestamp": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/job-document-family-interactions/{id}"
payload = {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"documentFamilyId": "<string>",
"endTimestamp": "2023-11-07T05:31:56Z",
"id": "<string>",
"scheduledJobExecution": {
"changeSequence": 123,
"completionMessage": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"exceptionDetails": "<string>",
"id": "<string>",
"logGroup": "<string>",
"logStream": "<string>",
"requestId": "<string>",
"scheduledJob": {
"active": True,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleted": True,
"description": "<string>",
"id": "f5678901-23ab-cdef-4567-890123abcdef",
"modelRef": "<string>",
"name": "Daily Invoice Processing",
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": ["<string>"],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": ["<string>"],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": { "showNewTask": True },
"taxonTypeFeatures": {}
},
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<string>"] },
"showDeveloperTools": True,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": True,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"properties": {},
"schedules": [
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"cronExpression": "<string>",
"id": "<string>",
"lastEvent": "2023-11-07T05:31:56Z",
"nextEvent": "2023-11-07T05:31:56Z",
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"searchText": "<string>",
"slug": "daily-invoice-processing",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"scheduledJobId": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"userCancelled": True,
"uuid": "<string>"
},
"scheduledJobExecutionId": "<string>",
"startTimestamp": "2023-11-07T05:31:56Z",
"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,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
documentFamilyId: '<string>',
endTimestamp: '2023-11-07T05:31:56Z',
id: '<string>',
scheduledJobExecution: {
changeSequence: 123,
completionMessage: '<string>',
createdOn: '2023-11-07T05:31:56Z',
endTime: '2023-11-07T05:31:56Z',
exceptionDetails: '<string>',
id: '<string>',
logGroup: '<string>',
logStream: '<string>',
requestId: '<string>',
scheduledJob: {
active: true,
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
deleted: true,
description: '<string>',
id: 'f5678901-23ab-cdef-4567-890123abcdef',
modelRef: '<string>',
name: 'Daily Invoice Processing',
project: {
changeSequence: 123,
color: '#4A90D9',
createdOn: '2023-11-07T05:31:56Z',
dataFlow: {
edges: [{id: '<string>', properties: {}, source: '<string>', target: '<string>'}],
nodes: [
{
dimensions: {height: 123, width: 123},
id: '<string>',
parentId: '<string>',
position: {x: 123, y: 123},
properties: {},
type: '<string>'
}
],
viewPort: {x: 123, y: 123, zoom: 123}
},
description: 'Automated invoice processing pipeline.',
documentStatuses: [
{
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
project: '<unknown>',
projectId: '<string>',
slug: '<string>',
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
],
id: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
memory: {
changeSequence: 123,
orderedDashboards: ['<string>'],
recentFilters: {},
recentQueries: {}
},
name: 'Invoice Processing',
notes: '<string>',
options: {
companion: {agentRuntimeRef: '<string>', moduleRefs: ['<string>'], prompt: '<string>'},
dataOptions: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
dataProperties: {},
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
groupTaxonTypeFeatures: {},
options: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
properties: {},
taskOptions: {showNewTask: true},
taxonTypeFeatures: {}
},
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
owner: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<string>']},
showDeveloperTools: true,
title: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
userStorage: {favoriteLinks: [{link: '<string>'}]},
userType: '<string>',
uuid: '<string>'
},
ownerId: '<string>',
projectTemplateRef: '<string>',
searchText: '<string>',
slug: 'invoice-processing',
status: {
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
production: true,
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
statusId: '<string>',
statusType: 'ACTIVE',
templateArticleId: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '7c9e667974254de944be07fc1f90ae7'
},
projectId: '<string>',
properties: {},
schedules: [
{
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
cronExpression: '<string>',
id: '<string>',
lastEvent: '2023-11-07T05:31:56Z',
nextEvent: '2023-11-07T05:31:56Z',
type: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
],
searchText: '<string>',
slug: 'daily-invoice-processing',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
scheduledJobId: '<string>',
startTime: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
userCancelled: true,
uuid: '<string>'
},
scheduledJobExecutionId: '<string>',
startTimestamp: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/job-document-family-interactions/{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/job-document-family-interactions/{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,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'documentFamilyId' => '<string>',
'endTimestamp' => '2023-11-07T05:31:56Z',
'id' => '<string>',
'scheduledJobExecution' => [
'changeSequence' => 123,
'completionMessage' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'endTime' => '2023-11-07T05:31:56Z',
'exceptionDetails' => '<string>',
'id' => '<string>',
'logGroup' => '<string>',
'logStream' => '<string>',
'requestId' => '<string>',
'scheduledJob' => [
'active' => true,
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'deleted' => true,
'description' => '<string>',
'id' => 'f5678901-23ab-cdef-4567-890123abcdef',
'modelRef' => '<string>',
'name' => 'Daily Invoice Processing',
'project' => [
'changeSequence' => 123,
'color' => '#4A90D9',
'createdOn' => '2023-11-07T05:31:56Z',
'dataFlow' => [
'edges' => [
[
'id' => '<string>',
'properties' => [
],
'source' => '<string>',
'target' => '<string>'
]
],
'nodes' => [
[
'dimensions' => [
'height' => 123,
'width' => 123
],
'id' => '<string>',
'parentId' => '<string>',
'position' => [
'x' => 123,
'y' => 123
],
'properties' => [
],
'type' => '<string>'
]
],
'viewPort' => [
'x' => 123,
'y' => 123,
'zoom' => 123
]
],
'description' => 'Automated invoice processing pipeline.',
'documentStatuses' => [
[
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'project' => '<unknown>',
'projectId' => '<string>',
'slug' => '<string>',
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
],
'id' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'memory' => [
'changeSequence' => 123,
'orderedDashboards' => [
'<string>'
],
'recentFilters' => [
],
'recentQueries' => [
]
],
'name' => 'Invoice Processing',
'notes' => '<string>',
'options' => [
'companion' => [
'agentRuntimeRef' => '<string>',
'moduleRefs' => [
'<string>'
],
'prompt' => '<string>'
],
'dataOptions' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'dataProperties' => [
],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'groupTaxonTypeFeatures' => [
],
'options' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'properties' => [
],
'taskOptions' => [
'showNewTask' => true
],
'taxonTypeFeatures' => [
]
],
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'owner' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<string>'
]
],
'showDeveloperTools' => true,
'title' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'userStorage' => [
'favoriteLinks' => [
[
'link' => '<string>'
]
]
],
'userType' => '<string>',
'uuid' => '<string>'
],
'ownerId' => '<string>',
'projectTemplateRef' => '<string>',
'searchText' => '<string>',
'slug' => 'invoice-processing',
'status' => [
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'production' => true,
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'statusId' => '<string>',
'statusType' => 'ACTIVE',
'templateArticleId' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '7c9e667974254de944be07fc1f90ae7'
],
'projectId' => '<string>',
'properties' => [
],
'schedules' => [
[
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'cronExpression' => '<string>',
'id' => '<string>',
'lastEvent' => '2023-11-07T05:31:56Z',
'nextEvent' => '2023-11-07T05:31:56Z',
'type' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
],
'searchText' => '<string>',
'slug' => 'daily-invoice-processing',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'scheduledJobId' => '<string>',
'startTime' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'userCancelled' => true,
'uuid' => '<string>'
],
'scheduledJobExecutionId' => '<string>',
'startTimestamp' => '2023-11-07T05:31:56Z',
'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/job-document-family-interactions/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endTimestamp\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"scheduledJobExecution\": {\n \"changeSequence\": 123,\n \"completionMessage\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": \"<string>\",\n \"id\": \"<string>\",\n \"logGroup\": \"<string>\",\n \"logStream\": \"<string>\",\n \"requestId\": \"<string>\",\n \"scheduledJob\": {\n \"active\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"f5678901-23ab-cdef-4567-890123abcdef\",\n \"modelRef\": \"<string>\",\n \"name\": \"Daily Invoice Processing\",\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"properties\": {},\n \"schedules\": [\n {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"cronExpression\": \"<string>\",\n \"id\": \"<string>\",\n \"lastEvent\": \"2023-11-07T05:31:56Z\",\n \"nextEvent\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"searchText\": \"<string>\",\n \"slug\": \"daily-invoice-processing\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"scheduledJobId\": \"<string>\",\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userCancelled\": true,\n \"uuid\": \"<string>\"\n },\n \"scheduledJobExecutionId\": \"<string>\",\n \"startTimestamp\": \"2023-11-07T05:31:56Z\",\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/job-document-family-interactions/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endTimestamp\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"scheduledJobExecution\": {\n \"changeSequence\": 123,\n \"completionMessage\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": \"<string>\",\n \"id\": \"<string>\",\n \"logGroup\": \"<string>\",\n \"logStream\": \"<string>\",\n \"requestId\": \"<string>\",\n \"scheduledJob\": {\n \"active\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"f5678901-23ab-cdef-4567-890123abcdef\",\n \"modelRef\": \"<string>\",\n \"name\": \"Daily Invoice Processing\",\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"properties\": {},\n \"schedules\": [\n {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"cronExpression\": \"<string>\",\n \"id\": \"<string>\",\n \"lastEvent\": \"2023-11-07T05:31:56Z\",\n \"nextEvent\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"searchText\": \"<string>\",\n \"slug\": \"daily-invoice-processing\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"scheduledJobId\": \"<string>\",\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userCancelled\": true,\n \"uuid\": \"<string>\"\n },\n \"scheduledJobExecutionId\": \"<string>\",\n \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/job-document-family-interactions/{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 \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endTimestamp\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"scheduledJobExecution\": {\n \"changeSequence\": 123,\n \"completionMessage\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"endTime\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": \"<string>\",\n \"id\": \"<string>\",\n \"logGroup\": \"<string>\",\n \"logStream\": \"<string>\",\n \"requestId\": \"<string>\",\n \"scheduledJob\": {\n \"active\": true,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"f5678901-23ab-cdef-4567-890123abcdef\",\n \"modelRef\": \"<string>\",\n \"name\": \"Daily Invoice Processing\",\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"properties\": {},\n \"schedules\": [\n {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"cronExpression\": \"<string>\",\n \"id\": \"<string>\",\n \"lastEvent\": \"2023-11-07T05:31:56Z\",\n \"nextEvent\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"searchText\": \"<string>\",\n \"slug\": \"daily-invoice-processing\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"scheduledJobId\": \"<string>\",\n \"startTime\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userCancelled\": true,\n \"uuid\": \"<string>\"\n },\n \"scheduledJobExecutionId\": \"<string>\",\n \"startTimestamp\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"documentFamilyId": "<string>",
"endTimestamp": "2023-11-07T05:31:56Z",
"id": "<string>",
"scheduledJobExecution": {
"changeSequence": 123,
"completionMessage": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"exceptionDetails": "<string>",
"id": "<string>",
"logGroup": "<string>",
"logStream": "<string>",
"requestId": "<string>",
"scheduledJob": {
"active": true,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "f5678901-23ab-cdef-4567-890123abcdef",
"modelRef": "<string>",
"name": "Daily Invoice Processing",
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": {
"showNewTask": true
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"properties": {},
"schedules": [
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"cronExpression": "<string>",
"id": "<string>",
"lastEvent": "2023-11-07T05:31:56Z",
"nextEvent": "2023-11-07T05:31:56Z",
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"searchText": "<string>",
"slug": "daily-invoice-processing",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"scheduledJobId": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"userCancelled": true,
"uuid": "<string>"
},
"scheduledJobExecutionId": "<string>",
"startTimestamp": "2023-11-07T05:31:56Z",
"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 job document family interaction records a scheduled job's interaction with a document family.
A scheduled job execution records a single run of a scheduled job.
Show child attributes
Show child attributes
Response
Updated JobDocumentFamilyInteraction
A job document family interaction records a scheduled job's interaction with a document family.
A scheduled job execution records a single run of a scheduled job.
Show child attributes
Show child attributes
⌘I