Orchestrator

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/orchestrators?nsfilter=proj_DrZrSNrW

Get All Orchestrators

Endpoints

GET /datasourcesvc/api/v1/orchestrators

Request

Query parameters

Parameter	Type	Description	Required
nsfilter	String	Filter by namespace.	Required

Response

Response codes

Code	Description
200	Success
400	Bad Request
404	File Not Found

Response data example

{
  "_offset": 0,
  "_pageSize": 2,
  "_total": 2,
  "_list": [
    {
      "id": "0567d327-87ed-431c-923d-3a4d86ae9105",
      "_name": "Test Instant Orch",
      "_description": "Test Instant Orch",
      "_namespaces": [
        "test_bXgr468E"
      ],
      "_userType": "test_instant",
      "_class": "NORMAL",
      "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
      "_createdat": "1606817112614",
      "_updatedby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
      "_updatedat": "1606817112614",
      "_timeout": "2 * *",
      "_permissionprofileid": "4f20736c-dbce-4556-be1d-87b7bbxyz64c",
      "orchsteps": [
        {
          "id": "4f20736c-dbce-4556-be1d-87b7bbabe64b",
          "_compid": "eced6368-2c1f-4186-acf0-3fa6e079e9a8",
          "_orchid": "0567d327-87ed-431c-923d-3a4d86ae9105",
          "_actualparams": "{}",
          "_sequenceno": 1,
          "_name": "test_connector",
          "_orchcomp": "test_connector"
        }
      ]
    },
    {
      "id": "1e6d08dd-993a-469b-baf2-6e0f31f68fcf",
      "_name": "Test Instant Orch",
      "_description": "Test Instant Orch",
      "_namespaces": [
        "test_bXgr468E"
      ],
      "_userType": "test_instant",
      "_class": "NORMAL",
      "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
      "_createdat": "1606817681054",
      "_updatedby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
      "_updatedat": "1606817681054",
      "_timeout": "* 2 *",
      "orchsteps": [
        {
          "id": "151d247f-afe6-43b1-ab57-f2e72a89f873",
          "_compid": "eced6368-2c1f-4186-acf0-3fa6e079e9a8",
          "_orchid": "1e6d08dd-993a-469b-baf2-6e0f31f68fcf",
          "_actualparams": "{}",
          "_sequenceno": 1,
          "_name": "test_connector",
          "_orchcomp": "test_connector"
        }
      ]
    }
  ]
}

Get Orchestrator By Id

Endpoints

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

Request

Path parameters

Parameter	Type	Description	Required
id	String	Pass the Orchestrator's id.	Required

Query parameters

Parameter	Type	Description	Required
nsfilter	String	Filter by namespace.	Required

Response

Response codes

Code	Description
200	Success
404	File Not Found

Response data example

{
  "id": "1e6d08dd-993a-469b-baf2-6e0f31f68fcf",
  "_name": "Test Instant Orch",
  "_description": "Test Instant Orch",
  "_namespaces": [
    "test_bXgr468E"
  ],
  "_userType": "test_instant",
  "_class": "NORMAL",
  "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
  "_createdat": "1606817681054",
  "_updatedby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
  "_updatedat": "1606817681054",
  "_timeout": "2 * *",
  "_permissionprofileid": "4f20736c-dbce-4556-be1d-87b7bbxyz64c",
  "orchsteps": [
    {
      "id": "151d247f-afe6-43b1-ab57-f2e72a89f873",
      "_compid": "eced6368-2c1f-4186-acf0-3fa6e079e9a8",
      "_orchid": "1e6d08dd-993a-469b-baf2-6e0f31f68fcf",
      "_actualparams": "{}",
      "_sequenceno": 1,
      "_name": "test_connector",
      "_orchcomp": "test_connector"
    }
  ]
}

Create Orchestrators

Endpoints

POST /datasourcesvc/api/v1/orchestrators

Response

Query parameters

Parameter	Type	Description	Required
nsfilter	String	Filter by namespace.	Required

Request

Body parameters

Parameter	Type	Description	Required
_name	String	Enter a unique name for the Orchestrator.	Required
_description	String	Give the Orchestrator a description.	Optional
_namespaces	Array of Strings	Pass an array with the namespaces you want to include.	Optional
_userType	String	Give the Orchestrator a userType tag that can be attributed to similar orchestrators.	Optional
_permissionprofileid	String	The id of the permission profile you want to use for the Orchestrator.	Optional
_timeout	String	Pass the orchestrator timeout time in the style of a chrontab time specification, such as * * *. The astericks represent seconds from 30 to 59, minutes from 1 to 59, and hours from 1 to 24.	Optional
_params	Object	Pass an object that contains a “tasks” parameter.	Required
_params.tasks	Array of Objects	Pass an array of objects with each object a system component you want to use in the orchestrator.	Optional
_params.tasks._orchcomp	String	Enter the unique name of the system component you want to reference.	Required
_params.tasks._name	String	Describe what the component does in the context of your orchestrator.	Optional
_params.tasks._sequenceno	Number	Enter a number that defines the task’s order in the sequence of tasks to execute.	Required
_params.tasks._actualparams	Object	Pass an object that contains the parameters you want to pass to the component as key-value pairs.	Optional

Request body example

{
  "_name": "Test Instant Orch",
  "_description": "Test Instant Orch",
  "_namespaces": [
    "test_bXgr468E"
  ],
  "_userType": "test_instant",
  "_permissionprofileid": "324ce8ca-941a-4e17-ab29-73274a465e59",
  "_timeout": "2 * *",
  "instant": true,
  "_timeout": "2 * *",
  "_permissionprofileid": "4f20736c-dbce-4556-be1d-87b7bbxyz64c",
  "_params": {
    "tasks": [
      {
        "name": "test_connector",
        "_sequenceno": 1
      }
    ]
  }
}

Response

Response codes

Code	Description
200	Success
400	Bad Request

Response

{
  "id": "0567d327-87ed-431c-923d-3a4d86ae9105",
  "_name": "Test Instant Orch",
  "_description": "Test Instant Orch",
  "_namespaces": [
    "test_bXgr468E"
  ],
  "_userType": "test_instant",
  "_class": "NORMAL",
  "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
  "_createdat": "1606817112614",
  "_updatedby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
  "_updatedat": "1606817112614",
  "_timeout": "2 * *",
  "_permissionprofileid": "4f20736c-dbce-4556-be1d-87b7bbxyz64c",
  "orchsteps": [
    {
      "id": "4f20736c-dbce-4556-be1d-87b7bbabe64b",
      "_compid": "eced6368-2c1f-4186-acf0-3fa6e079e9a8",
      "_orchid": "0567d327-87ed-431c-923d-3a4d86ae9105",
      "_actualparams": "{}",
      "_sequenceno": 1,
      "_name": "test_connector",
      "_orchcomp": "test_connector"
    }
  ]
}

Update Orchestrators

Endpoints

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

Request

Path parameters

Parameter	Type	Description	Required
id	String	Pass the Orchestrator's id.	Required

Query parameters

Parameter	Type	Description	Required
nsfilter	String	Filter by namespace.	Required

Body parameters

Parameter	Type	Description	Required
_name	String	Edit the Orchestrator's name.	Optional
_description	String	Edit the Orchestrator's description.	Optional
_namespaces	Array of Strings	Edit the array of namespaces you want to include.	Optional
_userType	String	Edit the Orchestrator's userType tag.	Optional
_permissionprofileid	String	Edit the id of the permission profile you want to use for the Orchestrator.	Optional
_timeout	String	Edit the orchestrator timeout time in the style of a chrontab time specification, such as * * *. The astericks represent seconds from 30 to 59, minutes from 1 to 59, and hours from 1 to 24.	Optional
_params	Object	Pass an object that contains a “tasks” parameter.	Required
_params.tasks	Array of Objects	Pass an array of objects with each object a system component you want to use in the orchestrator.	Optional
_params.tasks._orchcomp	String	Edit the unique name of the system component you want to reference.	Required
_params.tasks._name	String	Edit the task name.	Optional
_params.tasks._sequenceno	Number	Edit the number that defines the task’s order in the sequence of tasks to execute.	Required
_params.tasks._actualparams	Object	Pass an object that contains the parameters you want to pass to the component as key-value pairs.	Optional

Body parameters example

{
  "id": "a0a484ac-9e35-4899-8e91-f91b2a1c8518",
  "_name": "Test Instant Orch-updated",
  "_description": "Test Instant Orch-updated",
  "_namespaces": [
    "test_bXgr468E"
  ],
  "_timeout": "* 2 *",
  "_permissionprofileid": "324ce8ca-941a-4e17-ab29-73274a465e59",
  "_userType": "test",
  "_timeout": "2 * *",
  "_permissionprofileid": "4f20736c-dbce-4556-be1d-87b7bbxyz64c",
  "_params": {
    "tasks": [
      {
        "name": "geometry_relations_target",
        "_sequenceno": 5
      },
      {
        "name": "default_expressions_target",
        "_sequenceno": 4
      },
      {
        "name": "bimpk_element_extractor",
        "_sequenceno": 3
      },
      {
        "name": "bimpk_geometry_extractor",
        "_sequenceno": 2
      },
      {
        "name": "bimpk_file_extractor",
        "_sequenceno": 1
      }
    ]
  },
  "orchsteps": [
    {
      "id": "082f7927-76bf-4b47-8ce6-ee9e648851f5",
      "_compid": "87bc0bfb-4b77-4b76-8d67-fdf8b7ef608e",
      "_orchid": "a0a484ac-9e35-4899-8e91-f91b2a1c8518",
      "_actualparams": "{}",
      "_sequenceno": 1,
      "_name": "test_connector",
      "_orchcomp": "test_connector"
    }
  ]
}

Response

Response codes

Code	Description
200	Success
400	Bad Request
404	File Not Found

Response

{
  "id": "a0a484ac-9e35-4899-8e91-f91b2a1c8518",
  "_name": "Test Instant Orch-updated",
  "_description": "Test Instant Orch-updated",
  "_namespaces": [
    "test_bXgr468E"
  ],
  "_userType": "test",
  "_class": "NORMAL",
  "_createdby": "cea475f0-7a61-4e06-8ab0-90777bcba2bf",
  "_createdat": "1606971803050",
  "_updatedby": "john.doe@company.com",
  "_updatedat": "1606977261048",
  "_timeout": "2 * *",
  "_permissionprofileid": "4f20736c-dbce-4556-be1d-87b7bbxyz64c",
  "orchsteps": [
    {
      "id": "ac09965e-be6d-4f4b-aec9-7951ad82956c",
      "_compid": "87bc0bfb-4b77-4b76-8d67-fdf8b7ef608e",
      "_orchid": "a0a484ac-9e35-4899-8e91-f91b2a1c8518",
      "_actualparams": "{}",
      "_sequenceno": 5,
      "_name": "geometry_relations_target",
      "_orchcomp": "geometry_relations_target"
    },
    {
      "id": "d94ade5b-8ed2-43c4-86be-d628e7d5bbc3",
      "_compid": "1fc6dd28-61c0-4939-93c8-30fb0cc54452",
      "_orchid": "a0a484ac-9e35-4899-8e91-f91b2a1c8518",
      "_actualparams": "{}",
      "_sequenceno": 4,
      "_name": "default_expressions_target",
      "_orchcomp": "default_expressions_target"
    },
    {
      "id": "2cd6f53a-4d83-4514-bb87-74cad6e048aa",
      "_compid": "8183b99d-fad3-4751-8f85-6289f7797180",
      "_orchid": "a0a484ac-9e35-4899-8e91-f91b2a1c8518",
      "_actualparams": "{}",
      "_sequenceno": 3,
      "_name": "bimpk_element_extractor",
      "_orchcomp": "bimpk_element_extractor"
    },
    {
      "id": "088b4893-c37f-47b3-b1ef-b505a6a1e511",
      "_compid": "e808e84a-2914-4988-8637-d87e3056c9e8",
      "_orchid": "a0a484ac-9e35-4899-8e91-f91b2a1c8518",
      "_actualparams": "{}",
      "_sequenceno": 2,
      "_name": "bimpk_geometry_extractor",
      "_orchcomp": "bimpk_geometry_extractor"
    },
    {
      "id": "42892218-4db9-4fbc-a8bb-b15baaee683c",
      "_compid": "9a616686-571e-4167-8a70-d180dcd585a9",
      "_orchid": "a0a484ac-9e35-4899-8e91-f91b2a1c8518",
      "_actualparams": "{}",
      "_sequenceno": 1,
      "_name": "bimpk_file_extractor",
      "_orchcomp": "bimpk_file_extractor"
    }
  ]
}

Delete an Orchestrator

Endpoints

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

Request

Path parameters

Parameter	Type	Description	Required
id	String	Pass the Orchestrator's id.	Required

Query parameters

Parameter	Type	Description	Required
nsfilter	String	Filter by namespace.	Required

Response

Response codes

Code	Description
204	No Content
404	File Not Found

Response

None