Skip to content

Taipy Rest v1.0.0

Scroll down for example requests and responses.

api

get__api_v1_datanodes_{datanode_id}

Code samples

GET /api/v1/datanodes/{datanode_id}

Get a datanode

Get a single datanode by ID

Parameters

Name In Type Required Description
datanode_id path string true none

Example responses

200 Response

{
  "datanode": {
    "config_id": "string",
    "edit_in_progress": true,
    "id": "string",
    "job_ids": [
      "string"
    ],
    "last_edit_date": "string",
    "name": "string",
    "parent_id": "string",
    "properties": {},
    "scope": "string",
    "storage_type": "string",
    "validity_days": 0,
    "validity_seconds": 0
  }
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found datanode does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» datanode DataNodeSchema false none none
»» config_id string false none none
»» edit_in_progress boolean false none none
»» id string false none none
»» job_ids [string] false none none
»» last_edit_date string false none none
»» name string false none none
»» parent_id string false none none
»» properties object false none none
»» scope string false none none
»» storage_type string false none none
»» validity_days number false none none
»» validity_seconds number false none none

delete__api_v1_datanodes_{datanode_id}

Code samples

DELETE /api/v1/datanodes/{datanode_id}

Delete a datanode

Delete a single datanode by ID

Parameters

Name In Type Required Description
datanode_id path integer true none

Example responses

200 Response

{
  "msg": "datanode deleted"
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found datanode does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» msg string false none none

get__api_v1_datanodes

Code samples

GET /api/v1/datanodes

Get a list of datanodes

Get a list of paginated datanodes

Example responses

200 Response

{
  "results": [
    {
      "config_id": "string",
      "edit_in_progress": true,
      "id": "string",
      "job_ids": [
        "string"
      ],
      "last_edit_date": "string",
      "name": "string",
      "parent_id": "string",
      "properties": {},
      "scope": "string",
      "storage_type": "string",
      "validity_days": 0,
      "validity_seconds": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» results [DataNodeSchema] false none none
»» config_id string false none none
»» edit_in_progress boolean false none none
»» id string false none none
»» job_ids [string] false none none
»» last_edit_date string false none none
»» name string false none none
»» parent_id string false none none
»» properties object false none none
»» scope string false none none
»» storage_type string false none none
»» validity_days number false none none
»» validity_seconds number false none none

post__api_v1_datanodes

Code samples

POST /api/v1/datanodes

Create a datanode

Create a new datanode

Body parameter

{
  "name": "string",
  "scope": 0,
  "storage_type": "string"
}

Parameters

Name In Type Required Description
body body DataNodeConfig false none

Example responses

201 Response

{
  "datanode": {
    "name": "string",
    "scope": 0,
    "storage_type": "string"
  },
  "msg": "datanode created"
}

Responses

Status Meaning Description Schema
201 Created none Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
» datanode DataNodeConfig false none none
»» name string false none none
»» scope integer false none none
»» storage_type string false none none
» msg string false none none

get__api_v1_tasks_{task_id}

Code samples

GET /api/v1/tasks/{task_id}

Get a task

Get a single task by ID

Parameters

Name In Type Required Description
task_id path string true none

Example responses

200 Response

{
  "task": {
    "config_id": "string",
    "function_module": "string",
    "function_name": "string",
    "id": "string",
    "input_ids": [
      "string"
    ],
    "output_ids": [
      "string"
    ],
    "parent_id": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found task does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» task TaskSchema false none none
»» config_id string false none none
»» function_module string false none none
»» function_name string false none none
»» id string false none none
»» input_ids [string] false none none
»» output_ids [string] false none none
»» parent_id string false none none

delete__api_v1_tasks_{task_id}

Code samples

DELETE /api/v1/tasks/{task_id}

Delete a task

Delete a single task by ID

Parameters

Name In Type Required Description
task_id path integer true none

Example responses

200 Response

{
  "msg": "task deleted"
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found task does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» msg string false none none

get__api_v1_tasks

Code samples

GET /api/v1/tasks

Get a list of tasks

Get a list of paginated tasks

Example responses

200 Response

{
  "results": [
    {
      "config_id": "string",
      "function_module": "string",
      "function_name": "string",
      "id": "string",
      "input_ids": [
        "string"
      ],
      "output_ids": [
        "string"
      ],
      "parent_id": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» results [TaskSchema] false none none
»» config_id string false none none
»» function_module string false none none
»» function_name string false none none
»» id string false none none
»» input_ids [string] false none none
»» output_ids [string] false none none
»» parent_id string false none none

post__api_v1_tasks

Code samples

POST /api/v1/tasks

Create a task

Create a new task

Body parameter

{
  "config_id": "string",
  "function_module": "string",
  "function_name": "string",
  "id": "string",
  "input_ids": [
    "string"
  ],
  "output_ids": [
    "string"
  ],
  "parent_id": "string"
}

Parameters

Name In Type Required Description
body body TaskSchema false none

Example responses

201 Response

{
  "msg": "task created",
  "task": {
    "config_id": "string",
    "function_module": "string",
    "function_name": "string",
    "id": "string",
    "input_ids": [
      "string"
    ],
    "output_ids": [
      "string"
    ],
    "parent_id": "string"
  }
}

Responses

Status Meaning Description Schema
201 Created none Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
» msg string false none none
» task TaskSchema false none none
»» config_id string false none none
»» function_module string false none none
»» function_name string false none none
»» id string false none none
»» input_ids [string] false none none
»» output_ids [string] false none none
»» parent_id string false none none

post__api_v1_tasks_submit_{task_id}

Code samples

POST /api/v1/tasks/submit/{task_id}

Execute a task

Execute a task

Parameters

Name In Type Required Description
task_id path string true none

Example responses

204 Response

{
  "msg": "task created",
  "task": {
    "config_id": "string",
    "function_module": "string",
    "function_name": "string",
    "id": "string",
    "input_ids": [
      "string"
    ],
    "output_ids": [
      "string"
    ],
    "parent_id": "string"
  }
}

Responses

Status Meaning Description Schema
204 No Content none Inline

Response Schema

Status Code 204

Name Type Required Restrictions Description
» msg string false none none
» task TaskSchema false none none
»» config_id string false none none
»» function_module string false none none
»» function_name string false none none
»» id string false none none
»» input_ids [string] false none none
»» output_ids [string] false none none
»» parent_id string false none none

get__api_v1_pipelines_{pipeline_id}

Code samples

GET /api/v1/pipelines/{pipeline_id}

Get a pipeline

Get a single pipeline by ID

Parameters

Name In Type Required Description
pipeline_id path string true none

Example responses

200 Response

{
  "pipeline": {
    "config_id": "string",
    "parent_id": "string",
    "properties": {},
    "tasks": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found pipeline does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» pipeline PipelineSchema false none none
»» config_id string false none none
»» parent_id string false none none
»» properties object false none none
»» tasks [string] false none none

delete__api_v1_pipelines_{pipeline_id}

Code samples

DELETE /api/v1/pipelines/{pipeline_id}

Delete a pipeline

Delete a single pipeline by ID

Parameters

Name In Type Required Description
pipeline_id path integer true none

Example responses

200 Response

{
  "msg": "pipeline deleted"
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found pipeline does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» msg string false none none

get__api_v1_pipelines

Code samples

GET /api/v1/pipelines

Get a list of pipelines

Get a list of paginated pipelines

Example responses

200 Response

{
  "results": [
    {
      "config_id": "string",
      "parent_id": "string",
      "properties": {},
      "tasks": [
        "string"
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» results [PipelineSchema] false none none
»» config_id string false none none
»» parent_id string false none none
»» properties object false none none
»» tasks [string] false none none

post__api_v1_pipelines

Code samples

POST /api/v1/pipelines

Create a pipeline

Create a new pipeline

Body parameter

{
  "config_id": "string",
  "parent_id": "string",
  "properties": {},
  "tasks": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body PipelineSchema false none

Example responses

201 Response

{
  "msg": "pipeline created",
  "pipeline": {
    "config_id": "string",
    "parent_id": "string",
    "properties": {},
    "tasks": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
201 Created none Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
» msg string false none none
» pipeline PipelineSchema false none none
»» config_id string false none none
»» parent_id string false none none
»» properties object false none none
»» tasks [string] false none none

post__api_v1_pipelines_submit_{pipeline_id}

Code samples

POST /api/v1/pipelines/submit/{pipeline_id}

Execute a pipeline

Execute a pipeline

Parameters

Name In Type Required Description
pipeline_id path string true none

Example responses

204 Response

{
  "msg": "pipeline created",
  "pipeline": {
    "config_id": "string",
    "parent_id": "string",
    "properties": {},
    "tasks": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
204 No Content none Inline

Response Schema

Status Code 204

Name Type Required Restrictions Description
» msg string false none none
» pipeline PipelineSchema false none none
»» config_id string false none none
»» parent_id string false none none
»» properties object false none none
»» tasks [string] false none none

get__api_v1_scenarios_{scenario_id}

Code samples

GET /api/v1/scenarios/{scenario_id}

Get a scenario

Get a single scenario by ID

Parameters

Name In Type Required Description
scenario_id path string true none

Example responses

200 Response

{
  "scenario": {
    "official_scenario": true,
    "pipelines": [
      "string"
    ],
    "properties": {},
    "tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found scenario does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» scenario ScenarioSchema false none none
»» official_scenario boolean false none none
»» pipelines [string] false none none
»» properties object false none none
»» tags [string] false none none

delete__api_v1_scenarios_{scenario_id}

Code samples

DELETE /api/v1/scenarios/{scenario_id}

Delete a scenario

Delete a single scenario by ID

Parameters

Name In Type Required Description
scenario_id path integer true none

Example responses

200 Response

{
  "msg": "scenario deleted"
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found scenario does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» msg string false none none

get__api_v1_scenarios

Code samples

GET /api/v1/scenarios

Get a list of scenarios

Get a list of paginated scenarios

Example responses

200 Response

{
  "results": [
    {
      "official_scenario": true,
      "pipelines": [
        "string"
      ],
      "properties": {},
      "tags": [
        "string"
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» results [ScenarioSchema] false none none
»» official_scenario boolean false none none
»» pipelines [string] false none none
»» properties object false none none
»» tags [string] false none none

post__api_v1_scenarios

Code samples

POST /api/v1/scenarios

Create a scenario

Create a new scenario

Body parameter

{
  "official_scenario": true,
  "pipelines": [
    "string"
  ],
  "properties": {},
  "tags": [
    "string"
  ]
}

Parameters

Name In Type Required Description
body body ScenarioSchema false none

Example responses

201 Response

{
  "msg": "scenario created",
  "scenario": {
    "official_scenario": true,
    "pipelines": [
      "string"
    ],
    "properties": {},
    "tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
201 Created none Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
» msg string false none none
» scenario ScenarioSchema false none none
»» official_scenario boolean false none none
»» pipelines [string] false none none
»» properties object false none none
»» tags [string] false none none

post__api_v1_scenarios_submit_{scenario_id}

Code samples

POST /api/v1/scenarios/submit/{scenario_id}

Execute a scenario

Execute a scenario

Parameters

Name In Type Required Description
scenario_id path string true none

Example responses

204 Response

{
  "msg": "scenario created",
  "scenario": {
    "official_scenario": true,
    "pipelines": [
      "string"
    ],
    "properties": {},
    "tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
204 No Content none Inline

Response Schema

Status Code 204

Name Type Required Restrictions Description
» msg string false none none
» scenario ScenarioSchema false none none
»» official_scenario boolean false none none
»» pipelines [string] false none none
»» properties object false none none
»» tags [string] false none none

get__api_v1_cycles_{cycle_id}

Code samples

GET /api/v1/cycles/{cycle_id}

Get a cycle

Get a single cycle by ID

Parameters

Name In Type Required Description
cycle_id path string true none

Example responses

200 Response

{
  "cycle": {
    "creation_date": "string",
    "end_date": "string",
    "frequency": "string",
    "id": "string",
    "name": "string",
    "properties": {},
    "start_date": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found cycle does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» cycle CycleResponse false none none
»» creation_date string false none none
»» end_date string false none none
»» frequency string false none none
»» id string false none none
»» name string false none none
»» properties object false none none
»» start_date string false none none

delete__api_v1_cycles_{cycle_id}

Code samples

DELETE /api/v1/cycles/{cycle_id}

Delete a cycle

Delete a single cycle by ID

Parameters

Name In Type Required Description
cycle_id path integer true none

Example responses

200 Response

{
  "msg": "cycle deleted"
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found cycle does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» msg string false none none

get__api_v1_cycles

Code samples

GET /api/v1/cycles

Get a list of cycles

Get a list of paginated cycles

Example responses

200 Response

{
  "results": [
    {
      "creation_date": "string",
      "end_date": "string",
      "frequency": "string",
      "name": "string",
      "properties": {},
      "start_date": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» results [CycleSchema] false none none
»» creation_date string false none none
»» end_date string false none none
»» frequency string false none none
»» name string false none none
»» properties object false none none
»» start_date string false none none

post__api_v1_cycles

Code samples

POST /api/v1/cycles

Create a cycle

Create a new cycle

Body parameter

{
  "creation_date": "string",
  "end_date": "string",
  "frequency": "string",
  "name": "string",
  "properties": {},
  "start_date": "string"
}

Parameters

Name In Type Required Description
body body CycleSchema false none

Example responses

201 Response

{
  "cycle": {
    "creation_date": "string",
    "end_date": "string",
    "frequency": "string",
    "name": "string",
    "properties": {},
    "start_date": "string"
  },
  "msg": "cycle created"
}

Responses

Status Meaning Description Schema
201 Created none Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
» cycle CycleSchema false none none
»» creation_date string false none none
»» end_date string false none none
»» frequency string false none none
»» name string false none none
»» properties object false none none
»» start_date string false none none
» msg string false none none

get__api_v1_jobs_{job_id}

Code samples

GET /api/v1/jobs/{job_id}

Get a job

Get a single job by ID

Parameters

Name In Type Required Description
job_id path string true none

Example responses

200 Response

{
  "job": {
    "callables": {
      "module": "string",
      "name": "string"
    },
    "task_name": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found job does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» job JobSchema false none none
»» callables Callable false none none
»»» module string false none none
»»» name string false none none
»» task_name string false none none

delete__api_v1_jobs_{job_id}

Code samples

DELETE /api/v1/jobs/{job_id}

Delete a job

Delete a single job by ID

Parameters

Name In Type Required Description
job_id path integer true none

Example responses

200 Response

{
  "msg": "job deleted"
}

Responses

Status Meaning Description Schema
200 OK none Inline
404 Not Found job does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» msg string false none none

get__api_v1_jobs

Code samples

GET /api/v1/jobs

Get a list of jobs

Get a list of paginated jobs

Example responses

200 Response

{
  "results": [
    {
      "callables": {
        "module": "string",
        "name": "string"
      },
      "task_name": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» results [JobSchema] false none none
»» callables Callable false none none
»»» module string false none none
»»» name string false none none
»» task_name string false none none

post__api_v1_jobs

Code samples

POST /api/v1/jobs

Create a job

Create a new job

Body parameter

{
  "callables": {
    "module": "string",
    "name": "string"
  },
  "task_name": "string"
}

Parameters

Name In Type Required Description
body body JobSchema false none

Example responses

201 Response

{
  "job": {
    "callables": {
      "module": "string",
      "name": "string"
    },
    "task_name": "string"
  },
  "msg": "job created"
}

Responses

Status Meaning Description Schema
201 Created none Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
» job JobSchema false none none
»» callables Callable false none none
»»» module string false none none
»»» name string false none none
»» task_name string false none none
» msg string false none none

Schemas

Callable

{
  "module": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
module string false none none
name string false none none

CycleResponse

{
  "creation_date": "string",
  "end_date": "string",
  "frequency": "string",
  "id": "string",
  "name": "string",
  "properties": {},
  "start_date": "string"
}

Properties

Name Type Required Restrictions Description
creation_date string false none none
end_date string false none none
frequency string false none none
id string false none none
name string false none none
properties object false none none
start_date string false none none

CycleSchema

{
  "creation_date": "string",
  "end_date": "string",
  "frequency": "string",
  "name": "string",
  "properties": {},
  "start_date": "string"
}

Properties

Name Type Required Restrictions Description
creation_date string false none none
end_date string false none none
frequency string false none none
name string false none none
properties object false none none
start_date string false none none

DataNodeConfig

{
  "name": "string",
  "scope": 0,
  "storage_type": "string"
}

Properties

Name Type Required Restrictions Description
name string false none none
scope integer false none none
storage_type string false none none

DataNodeSchema

{
  "config_id": "string",
  "edit_in_progress": true,
  "id": "string",
  "job_ids": [
    "string"
  ],
  "last_edit_date": "string",
  "name": "string",
  "parent_id": "string",
  "properties": {},
  "scope": "string",
  "storage_type": "string",
  "validity_days": 0,
  "validity_seconds": 0
}

Properties

Name Type Required Restrictions Description
config_id string false none none
edit_in_progress boolean false none none
id string false none none
job_ids [string] false none none
last_edit_date string false none none
name string false none none
parent_id string false none none
properties object false none none
scope string false none none
storage_type string false none none
validity_days number false none none
validity_seconds number false none none

JobSchema

{
  "callables": {
    "module": "string",
    "name": "string"
  },
  "task_name": "string"
}

Properties

Name Type Required Restrictions Description
callables Callable false none none
task_name string false none none

PaginatedResult

{
  "next": "string",
  "pages": 0,
  "prev": "string",
  "total": 0
}

Properties

Name Type Required Restrictions Description
next string false none none
pages integer false none none
prev string false none none
total integer false none none

PipelineSchema

{
  "config_id": "string",
  "parent_id": "string",
  "properties": {},
  "tasks": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
config_id string false none none
parent_id string false none none
properties object false none none
tasks [string] false none none

ScenarioSchema

{
  "official_scenario": true,
  "pipelines": [
    "string"
  ],
  "properties": {},
  "tags": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
official_scenario boolean false none none
pipelines [string] false none none
properties object false none none
tags [string] false none none

TaskSchema

{
  "config_id": "string",
  "function_module": "string",
  "function_name": "string",
  "id": "string",
  "input_ids": [
    "string"
  ],
  "output_ids": [
    "string"
  ],
  "parent_id": "string"
}

Properties

Name Type Required Restrictions Description
config_id string false none none
function_module string false none none
function_name string false none none
id string false none none
input_ids [string] false none none
output_ids [string] false none none
parent_id string false none none