curl --request GET \
--url https://platform.kodexa.ai/api/orchestrator-modules/{id} \
--header 'x-api-key: <api-key>'{
"changeSequence": 123,
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"description": "<string>",
"entryPoint": "<string>",
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"additionalTaxonOptions": {},
"baseDir": "<string>",
"contents": [
"<string>"
],
"eventAware": true,
"ignoredContents": [
"<string>"
],
"inferable": true,
"inferenceOptions": {},
"messageTemplates": {},
"modelRuntimeParameters": {},
"modelRuntimeRef": "<string>",
"modelSidecars": [
"<string>"
],
"optionTabs": {},
"script": "<string>",
"scriptLanguage": "<string>",
"state": "<string>",
"stateHash": "<string>",
"supportsScheduling": true,
"taxonFeatures": {},
"taxonomy": {},
"type": "<string>"
},
"moduleStatus": "<string>",
"moduleType": "<string>",
"name": "<string>",
"organization": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Retrieves a single OrchestratorModule by its unique identifier. Orchestrator modules are processing components used within pipelines.
curl --request GET \
--url https://platform.kodexa.ai/api/orchestrator-modules/{id} \
--header 'x-api-key: <api-key>'{
"changeSequence": 123,
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"description": "<string>",
"entryPoint": "<string>",
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"additionalTaxonOptions": {},
"baseDir": "<string>",
"contents": [
"<string>"
],
"eventAware": true,
"ignoredContents": [
"<string>"
],
"inferable": true,
"inferenceOptions": {},
"messageTemplates": {},
"modelRuntimeParameters": {},
"modelRuntimeRef": "<string>",
"modelSidecars": [
"<string>"
],
"optionTabs": {},
"script": "<string>",
"scriptLanguage": "<string>",
"state": "<string>",
"stateHash": "<string>",
"supportsScheduling": true,
"taxonFeatures": {},
"taxonomy": {},
"type": "<string>"
},
"moduleStatus": "<string>",
"moduleType": "<string>",
"name": "<string>",
"organization": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Unique identifier (UUID) of the resource.
The OrchestratorModule
An orchestrator module is a processing component used within pipelines.
Show child attributes
Show child attributes