v1
latestOpenAPI 3.1.02026-07-24239123562.1 KBWorkflows
Search Workflow
Search data pipeline workflows
get/v1/workflow/search
Query parameters
sizestring
Optional. Number of results to return starting from the page index given in the “from” parameter. Default: 10 Max: 100
fromstring
Optional. Paging index. Starts with zero. Default: 0
filterstring
Optional. Filter by the workflow completion status. Possible values are: 1. all - for all the workflows (pending, in-progress, completed, failed). 2. failed - for the workflows that failed. 3. completed - for the workflows that completed successfully. 4. pending - for workflows waiting to be scheduled. 5. in-progress - for workflows that are executing. Default: all
pipelineIdstring
Optional. UUID of the pipeline. If provided, only the workflows associated with this pipelineid are retrieved. Otherwise, the workflows from all the pipelines are retrieved.
startTimestring date-time
Optional. If provided, service returns all the workflows created after this time. Value can be ISO format only with or without hours, minutes, seconds. If value is just a date without hours, minutes and second, timestamp will be defaulted to 00:00:00 for given date.
endTimestring date-time
Optional. If provided, service returns all the workflows created before this time. Value can be ISO format only with or without hours, minutes, seconds. If value is just a date without hours, minutes and second, timestamp will be defaulted to 00:00:00 for given date.
Response
200
Example response
{
"size": 2,
"hasNext": true,
"hits": [
{
"id": "ea3e0f87-4ba2-4a10-83f3-db30760fd652",
"orgSlug": "your_org",
"pipelineId": "8592187a-d3ed-4410-8ffb-ee47826bebf7",
"masterScriptNamespace": "private-your_org",
"masterScriptSlug": "hg-prot-covid-data",
"masterScriptVersion": "v2.1.0",
"protocolSlug": "hg-prot-covid-data",
"protocolVersion": "v2.1.0",
"protocol": {
"protocolSchema": "v2",
"name": "HG Protocol COVID-JSON to IDS",
"steps": [
{
"slug": "first-step-covid-json-ids",
"description": "Generates COVID data row (IDS JSON) for each state.",
"type": "generator",
"script": {
"namespace": "private-your_org",
"slug": "hg-tscr-covid-data",
"version": "v2.0.1"
},
"functionSlug": "main"
}
]
},
"pipelineConfig": {
"notificationsConfig": {
"sendOnSuccessful": true,
"sendOnFailed": true,
"notificationEmailAddresses": [
"example1@your_org.com"
]
},
"pipelineName": "HG-Covid-Data"
},
"inputFile": {
"meta": {
"fileId": "650bc88a-e90c-48c7-a349-65dcc756b0a4",
"source": {
"box": {
"id": "56d9293c-2dc7-4133-b21b-c1468aefb41f",
"size": 2648411,
"filePath": "/All Files/your_org/coviddata/statesdata/covid_states_tseries_2021_12_09.json",
"integrationSource": "4095be8f-40c6-487d-99ce-bef42682c36b"
},
"type": "box"
},
"traceId": "650bc88a-e90c-48c7-a349-65dcc756b0a4",
"sourceId": "4095be8f-40c6-487d-99ce-bef42682c36b",
"sourceName": "HG-Box-Covid-Data-States",
"sourceType": "box",
"integrationId": "56d9293c-2dc7-4133-b21b-c1468aefb41f",
"integrationType": "box"
},
"type": "s3file",
"bucket": "ts-platform-dev-datalake",
"fileId": "650bc88a-e90c-48c7-a349-65dcc756b0a4",
"fileKey": "your_org/4095be8f-40c6-487d-99ce-bef42682c36b/RAW/All Files/your_org/coviddata/statesdata/covid_states_tseries_2021_12_09.json",
"version": "YXWfnGtFnxXaRshIkphKpeIWjKM5YMrL"
},
"tasks": [
{
"slug": "first-step-covid-json-ids",
"input": {
"input_file": {
"meta": {
"fileId": "650bc88a-e90c-48c7-a349-65dcc756b0a4",
"source": {
"box": {
"id": "56d9293c-2dc7-4133-b21b-c1468aefb41f",
"size": 2648411,
"filePath": "/All Files/your_org/coviddata/statesdata/covid_states_tseries_2021_12_09.json",
"integrationSource": "4095be8f-40c6-487d-99ce-bef42682c36b"
},
"type": "box"
},
"traceId": "650bc88a-e90c-48c7-a349-65dcc756b0a4",
"sourceId": "4095be8f-40c6-487d-99ce-bef42682c36b",
"sourceName": "HG-Box-Covid-Data-States",
"sourceType": "box",
"integrationId": "56d9293c-2dc7-4133-b21b-c1468aefb41f",
"integrationType": "box"
},
"type": "s3file",
"bucket": "ts-platform-dev-datalake",
"fileId": "650bc88a-e90c-48c7-a349-65dcc756b0a4",
"fileKey": "your_org/4095be8f-40c6-487d-99ce-bef42682c36b/RAW/All Files/your_org/coviddata/statesdata/covid_states_tseries_2021_12_09.json",
"version": "YXWfnGtFnxXaRshIkphKpeIWjKM5YMrL"
}
},
"events": [
{
"at": "2022-02-08T16:17:59.579+00:00",
"status": "pending"
}
],
"output": {
"type": "success",
"result": [
{
"type": "s3file",
"bucket": "ts-platform-dev-datalake",
"fileId": "6908a751-62d1-4851-b502-818f7c836df1",
"fileKey": "your_org/4095be8f-40c6-487d-99ce-bef42682c36b/IDS/All Files/your_org/coviddata/statesdata/covid_states_tseries_2021_12_09.json/covid-state-tseries-AK-2021-12-08.json",
"version": "9sNbqVb879.geEUVp03EfCDpK8j9gz1Z"
}
]
},
"script": {
"list": [
"requirements.txt"
],
"slug": "hg-tscr-covid-data",
"docker": {
"image": "706717599419.dkr.ecr.us-east-2.amazonaws.com/ts-platform-development-task-private-your_org-hg-tscr-covid-data@sha256:334e32f0810dfdeb3324f63f85c9b6aa7c67fdd4023b317eb67a3a7bdd5be706"
},
"version": "v2.0.1",
"language": "python",
"maxCount": 30,
"createdAt": "2022-02-08T15:41:05.234Z",
"functions": [
{
"slug": "main",
"function": "main.main"
}
],
"hasSource": true,
"namespace": "private-your_org",
"timestamp": 1644334642884,
"runnerType": "ecs",
"buildLogSaved": true,
"buildDurationMs": 63528
},
"status": "completed",
"taskId": "a9c6e221-bd6e-4554-9ebd-54a231079591",
"createdAt": "2022-02-08T16:17:59.563+00:00",
"containerId": "5e1a47e9-6d3a-428e-8988-e85746f3756b",
"functionSlug": "main",
"lastUpdatedAt": "2022-02-08T16:18:49.010+00:00",
"taskMemoryInMB": 512,
"cloudWatchUrl": "https://us-east-2.console.aws.amazon.com/cloudwatch/home?region=us-east-2#logs-insights:queryDetail=~(end~'2022-02-08T16*3a23*3a49.010Z~start~'2022-02-08T16*3a12*3a59.563Z~timeType~'ABSOLUTE~tz~'Local~editorString~'filter*20*60taskId*60*3d*27a9c6e221-bd6e-4554-9ebd-54a231079591*27*20and*20*60containerId*60*3d*275e1a47e9-6d3a-428e-8988-e85746f3756b*27*0a*7c*20fields*20*40timestamp*2c*20*40message*0a*7c*20sort*20*40timestamp*20asc~source~(~'*2fecs*2ftaskscripts*2fts-platform*2fcontainers))"
}
],
"status": "completed",
"events": [
{
"at": "2022-02-08T16:17:59.463+00:00",
"status": "in-progress"
}
],
"createdAt": "2022-02-08T16:17:59.142Z",
"lastUpdatedAt": "2022-02-08T16:18:49.024Z",
"output": {
"type": "success",
"result": [
{
"type": "s3file",
"bucket": "ts-platform-dev-datalake",
"fileId": "6908a751-62d1-4851-b502-818f7c836df1",
"fileKey": "your_org/4095be8f-40c6-487d-99ce-bef42682c36b/IDS/All Files/your_org/coviddata/statesdata/covid_states_tseries_2021_12_09.json/covid-state-tseries-AK-2021-12-08.json",
"version": "9sNbqVb879.geEUVp03EfCDpK8j9gz1Z"
}
]
}
}
]
}