Version: v4.5

Orchestrator Run

Note: The nsfilter (namespace filter) query parameter is mandatory for every request. It sets the context, helping you look up resources within that namespace. Example: GET /datasourcesvc/api/v1/orchrun?nsfilter=proj_DrZrSNrW
A maximum of 20 Orch runs can be created for a specific project if there are already Orch runs in the queued status.

Get Paginated Orchestrator Runs with Optional Filter(s)#

Endpoints#

GET /datasourcesvc/api/v1/orchrun

Request#

Parameters#

Path#

Parameter	Type	Description	Required	Default
`_pageSize`	Number	Number of records to return in the page	Optional	20
`_offset`	Number	Number of records to offset or skip before the first document to return in the page	Optional	0
`_status`	String	The orchestrator run status you want to filter by	Optional
`startDate`	String	The orchestrator run start date you want to filter by	Optional
`endDate`	String	The orchestrator run end date you want to filter by	Optional

Query#

Parameter	Type	Description	Required
`nsfilter`	String	Project namespace	Required

Response#

Type#

JSON object

Codes#

Code	Description
`200`	Success
`500`	Internal Service error

Body example#

{    "_offset": 0,    "_pageSize": 1,    "_total": 1,    "_list": [        {            "id": "b94f4ea3-447d-43a0-9d7f-345d46e11791",            "_orchid": "383f91dd-7d7f-41f6-b3dc-3c26c45d3c16",            "_name": "Test Instant Orch",            "_description": "Test Instant Orch",            "_namespaces": [                "AT_BEtqYlZ4"            ],            "_usertype": "test_instant",            "_createdby": "77eee821-b0d4-44c4-b179-7b50ec9575c5",            "_createdat": "1675164393072",            "_updatedat": "1675164428003",            "_status": "COMPLETED",            "_result": "",            "orchrunsteps": [                {                    "id": "1e533aed-81a0-45e9-8599-d867eda528a4",                    "_name": "test_connector",                    "orchstepid": "b4529482-053a-4402-ac57-f4bdd51b5ef9",                    "_compid": "eced6368-2c1f-4186-acf0-3fa6e079e9a8",                    "_orchrunid": "b94f4ea3-447d-43a0-9d7f-345d46e11791",                    "_actualparams": "{}",                    "_sequenceno": 1,                    "_runparams": "{}",                    "_status": "COMPLETED",                    "_statusmsg": ""                }            ]        }    ]}

Get an Orchestrator Run by ID#

Endpoints#

GET /datasourcesvc/api/v1/orchrun/{id}

Parameters#

Path#

Parameter	Type	Description	Required
`id`	String	The orchestrator run's id	Required

Query#

Parameter	Type	Description	Required
`nsfilter`	String	Project namespace	Required

Response#

Type#

JSON object

Codes#

Code	Description
`200`	Success
`404`	File Not Found

Body example#

[  {    "id": "13d44e84-a3ab-47a3-a375-46fdc5859522",    "_orchid": "b07990cf-c64d-4cc4-a0bc-02a4daf0510d",    "_name": "Test Instant Orch",    "_description": "Test Instant Orch",    "_namespaces": [      "test_bXgr468E"    ],    "_usertype": "test_instant",    "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",    "_createdat": "1606885468249",    "_status": "COMPLETED",    "_result": "",    "orchrunsteps": [      {        "id": "ea7dc76e-1087-470d-9929-3fadb4204753",        "_name": "test_connector",        "orchstepid": "578a9663-8fc9-4c06-b70f-ad6be53d77ef",        "_compid": "eced6368-2c1f-4186-acf0-3fa6e079e9a8",        "_orchrunid": "13d44e84-a3ab-47a3-a375-46fdc5859522",        "_actualparams": "{}",        "_sequenceno": 1,        "_runparams": "{}",        "_status": "COMPLETED",        "_statusmsg": ""      }    ]  }]

Get an Orchestrator Run's Logs by ID#

Endpoints#

GET /datasourcesvc/api/v1/orchrun/logs/{id}

Parameters#

Path#

Parameter	Type	Description	Required
`id`	String	The OrchRun id	Required

Query#

Parameter	Type	Description	Required
`nsfilter`	String	Project namespace	Required

Response#

Codes#

Code	Description
`200`	Success
`404`	File Not Found

Response#

Type#

String

Body example#

"{\"orchRunId\":\"8cec89dc-9074-46be-9065-9faade7ad091\",\"level\":\"info\",\"message\":\"Orch run execution has begun\",\"timestamp\":\"2023-09-08T07:50:31.330Z\"}\n{\"level\":\"info\",\"message\":\"Running Orchestrator: test_connector in Node b4a149b9-6bc3-429e-bbcf-2661a1cdea98, orch_run_id: 8cec89dc-9074-46be-9065-9faade7ad091\",\"timestamp\":\"2023-09-08T07:50:31.331Z\"}\n{\"level\":\"info\",\"message\":\"Node b4a149b9-6bc3-429e-bbcf-2661a1cdea98 Executing Step: Connector:test_connector, orch_run_id: 8cec89dc-9074-46be-9065-9faade7ad091\",\"timestamp\":\"2023-09-08T07:50:31.854Z\"}\n{\"level\":\"info\",\"message\":\"Test Connector, orch_run_id: 8cec89dc-9074-46be-9065-9faade7ad091\",\"timestamp\":\"2023-09-08T07:50:31.857Z\"}\n{\"level\":\"info\",\"message\":\"Executing TestConnector - Connectors with version 1, orch_run_id: 8cec89dc-9074-46be-9065-9faade7ad091\",\"timestamp\":\"2023-09-08T07:50:31.858Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:50:37.881Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:50:43.879Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:50:49.881Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:50:55.882Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:51:01.885Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:51:07.885Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:51:13.888Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:51:19.889Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop in progress\",\"timestamp\":\"2023-09-08T07:51:25.889Z\"}\n{\"level\":\"info\",\"message\":\"TestConnector_v1: Dummy loop has ended\",\"timestamp\":\"2023-09-08T07:51:31.889Z\"}\n{\"level\":\"info\",\"message\":\"[\\\"Step: Connector:test_connector took ->60.56\\\"]\",\"timestamp\":\"2023-09-08T07:51:31.894Z\"}\n{\"level\":\"info\",\"message\":\"Orchestrator test_connector Execution Duration in project auto8080_CzMQc82u is: 60.56, orch_run_id: 8cec89dc-9074-46be-9065-9faade7ad091\",\"timestamp\":\"2023-09-08T07:51:31.894Z\"}\n{\"level\":\"info\",\"message\":\"Updating orch run status to 4 in OrchExecutionService, orch_run_id: 8cec89dc-9074-46be-9065-9faade7ad091\",\"timestamp\":\"2023-09-08T07:51:31.896Z\"}\n{\"end\":true,\"level\":\"info\",\"message\":\"Orch run has ended. Closing up file log stream\",\"timestamp\":\"2023-09-08T07:51:32.912Z\"}\n"

Create Orchestrator Run#

Endpoints#

POST /datasourcesvc/api/v1/orchrun

Parameters#

Query#

Parameter	Type	Description	Required
`nsfilter`	String	Project namespace	Required

Body#

Parameter	Type	Description	Required
`orchestratorId`	String	The orchestrator's id	Required
`_actualParams`	Array of Object	Array of actual parameter objects	Required
`_actualParams.sequence_type_id`	String	The sequence type id	Required
`_actualParams.params`	Object	An object that contains the actual parameters and their ids	Required

Example#

{  "orchestratorId": "b07990cf-c64d-4cc4-a0bc-02a4daf0510d",  "_actualparams": [    {      "sequence_type_id": "9a616686-571e-4167-8a70-d180dcd585a9",      "params": {        "_fileId": "cb8d42b2-60ec-46e7-a27e-634f092cfddf",        "_fileVersionId": "902aa32c-de61-4240-8f54-700de626498b"      }    }  ]}

Response#

Type#

JSON object

Codes#

Code	Description
`200`	Success
`400`	Bad Request

Body example#

{  "id": "13d44e84-a3ab-47a3-a375-46fdc5859522",  "_orchid": "b07990cf-c64d-4cc4-a0bc-02a4daf0510d",  "_name": "Test Instant Orch",  "_description": "Test Instant Orch",  "_namespaces": [    "test_bXgr468E"  ],  "_usertype": "test_instant",  "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",  "_createdat": 1606885468249,  "_status": "QUEUED",  "_result": "",  "orchrunsteps": [    {      "id": "ea7dc76e-1087-470d-9929-3fadb4204753",      "_name": "test_connector",      "orchstepid": "578a9663-8fc9-4c06-b70f-ad6be53d77ef",      "_compid": "eced6368-2c1f-4186-acf0-3fa6e079e9a8",      "_orchrunid": "13d44e84-a3ab-47a3-a375-46fdc5859522",      "_actualparams": "{}",      "_sequenceno": 1,      "_runparams": {},      "_status": "QUEUED"    }  ]}

Edit an Orchestrator Run#

Endpoints#

PUT /datasourcesvc/api/v1/orchrun/{id}

Parameters#

Path#

Parameter	Type	Description	Required
`id`	String	The orchestrator's id.	Required

Query#

Parameter	Type	Description	Required
`nsfilter`	String	Project namespace	Required

Body#

Parameter	Type	Description	Required
`id`	String	The orchestrator's id.	Required

Example#

{  "id": "73bde773-6ef8-41af-aa89-67c91e6ff683"}

Response#

Codes#

Code	Description
`200`	Success
`400`	Bad Request
`404`	File or Version Not Found

Body example#

[  {    "id": "73bde773-6ef8-41af-aa89-67c91e6ff683",    "_orchid": "b07990cf-c64d-4cc4-a0bc-02a4daf0510d",    "_name": "Test Instant Orch",    "_description": "Test Instant Orch",    "_namespaces": [      "test_bXgr468E"    ],    "_usertype": "test_instant",    "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",    "_createdat": "1606978503963",    "_status": "REQUEST_CANCEL",    "_result": "",    "orchrunsteps": []  }]

Delete an Orchestrator Run#

Endpoints#

DELETE /datasourcesvc/api/v1/orchrun/{id}

Parameters#

Path#

Parameter	Type	Description	Required
`id`	String	The orchestrator's id	Required

Query#

Parameter	Type	Description	Required
`nsfilter`	String	Project namespace	Required

Response#

Codes#

Code	Description
`204`	No Content
`404`	File Not Found

Response#

None