| Table of Contents |
|---|
...
| # | Field | Description | Data Type | Validations |
|---|---|---|---|---|
| 1 | name | Name of Parameter | string | [A-Z], [a-z], [0-9] and underscore[_]. |
| 2 | type | Data-type of Parameter | string | Enumeration with valid values
|
| 3 | mandatory | Indicates if the Parameter is mandatory or optional | boolean | true - mandatory false - optional |
API's
...
Summary
# | Operation | URI | Request | Response Status | Response Body | Description |
1 | GET | /workflows/ | ?state=CERTIFIED ?state=DRAFT ?state=DRAFT,CERTIFIED ?limit=50&offset=0 | 200 (OK) | {id, name, description, category, states[{name,…}], limit, offset, count} | get all workflows, optionally filtered by state (comma separated) |
2 | GET | /workflows/{id} | ?expand=versions | 200 (OK) / 404 (Not Found) If does not exist | {id, name, description, category, states[{name,…}] }. If expanded (i.e. ?expand=versions), will include the list of versions with their metadata (semantic, ID) only [version{…}] | getspecificworkflow |
3 | GET | /workflows/{id}/versions/ | ?state=CERTIFIED ?state=DRAFT ?state=DRAFT,CERTIFIED ?limit=50&offset=0 | 200 (OK) / 404 (Not Found) if the workflow does not exist, with an appropriate message | {version, versionId, state, inputs[{name, type}], outputs[{name, type}]} | return all versions of a workflow, optionally filtered by state (comma separated) |
4 | GET | /workflows/{id}/versions/{versionId} | ?fields=inputs,outputs | 200 (OK) / 404 (Not Found) if the workflow or version does not exist, with an appropriate message | {inputs[{name, type}], outputs[{name, type}], state} | get specific workflow version |
| 5 | PUT | /workflows/{id}/versions/{versionId}/artifact (Exposed by SDC) | file | 201 (Created) if did not exist / 200 (OK) if replaced / 422 (Unprocessable Entity) if the state does not allow modifications (e.g. certified), must include a detailed message / 404 (Not Found) if the workflow or version does not exist, with an appropriate message | Save/Update artifact of a version i SDC | |
6 |
Depricated |
|
|
|
| |
7 |
|
|
|
|
|
|
...
| Code | Error | Message | notes |
|---|---|---|---|
| 200 | OK | - | if the artifact got replaced |
| 201 | Created | - | if the artifact did not exist |
| 404 | Not Found | Workflow does not exist. | |
| 404 | Not Found | Version does not exist. | |
| 422 | Unprocessable Entity | The state of the workflow version does not allow modification. "CERTIFIED" |
...