Paths for sequence
Entry points that interact with Sequence
entities.
/api/v1/sequences/
¶
GET¶
Return an array of all sequences.
Note
When the authorization feature is activated (available in the Enterprise edition only), this endpoint requires TAIPY_READER role.
Code example:
curl -X GET http://localhost:5000/api/v1/sequences
Responses
-
200
Status:OK
Name Type results [ SequenceSchema
]
POST¶
Create a sequence from scenario_id, sequence_name and task_ids. If the scenario_id does not exist or sequence_name is not provided, a 404 error is returned.
Note
When the authorization feature is activated (available in the Enterprise edition only), this endpoint requires TAIPY_EDITOR role.
Code example:
curl -X POST --data '{"scenario_id": "SCENARIO_scenario_id", "sequence_name": "sequence", "tasks": []}' \
http://localhost:5000/api/v1/sequences
Parameters
Name | Type | Required | Description |
---|---|---|---|
tasks | list[string] | Yes | A list of task id of the Sequence. |
Responses
-
201
Status:Created
Name Type message string sequence SequenceSchema
/api/v1/sequences/submit/{sequence_id}/
¶
POST¶
Execute a sequence from sequence_id. If the sequence does not exist, a 404 error is returned.
Note
When the authorization feature is activated (available in the Enterprise edition only), This endpoint requires TAIPY_EXECUTOR role.
Code example:
curl -X POST http://localhost:5000/api/v1/sequences/submit/SEQUENCE_my_config_7575-4e09-4e00-958d-e352ee426cc9
Parameters
Name | Type | Required | Description |
---|---|---|---|
sequence_id | string | Yes | - |
Responses
-
204
Status:No Content
Name Type message string sequence SequenceSchema
-
404
Status:Not Found
No sequence has the sequence_id identifier.
/api/v1/sequences/{sequence_id}/
¶
DELETE¶
Delete a sequence. If the sequence does not exist, a 404 error is returned.
Note
When the authorization feature is activated (available in the Enterprise edition only), this endpoint requires TAIPY_EDITOR role.
Code example:
curl -X DELETE http://localhost:5000/api/v1/sequences/SEQUENCE_my_config_75750ed8-4e09-4e00-958d-e352ee426cc9
Parameters
Name | Type | Required | Description |
---|---|---|---|
sequence_id | string | Yes | The identifier of the sequence. |
Responses
-
200
Status:OK
Name Type message string -
404
Status:Not Found
No sequence has the sequence_id identifier.
GET¶
Return a single sequence by sequence_id. If the sequence does not exist, a 404 error is returned.
Note
When the authorization feature is activated (available in the Enterprise edition only), this endpoint requires TAIPY_READER role.
Code example:
curl -X GET http://localhost:5000/api/v1/sequences/SEQUENCE_my_config_75750ed8-4e09-4e00-958d-e352ee426cc9
Parameters
Name | Type | Required | Description |
---|---|---|---|
sequence_id | string | Yes | The identifier of the sequence. |
Responses
-
200
Status:OK
Name Type sequence SequenceSchema
-
404
Status:Not Found
No sequence has the sequence_id identifier.