v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Workflows

Search workflows draft

Search data pipeline workflows

get/v1/workflow/workflows-draft

Query parameters

pageinteger

Results page number - the start index of results is calculated as (page - 1) * limit. Page parameter will return results in range [start index, start index + limit]. Default value is 1. Value 0 will cause error.

limitinteger

Page size - number of the workflow results to retrieve for a given page.

filterstring

Filter by the workflow completion status. Possible values are: all - for all the workflows (completed and failed), failed - for the workflows that failed and completed - for the workflows that completed successfully.

pipelineIdstring

Optional parameter. If provided, only the workflows associated with this pipelineid are retrieved. Otherwise, the workflows from all the pipelines are retrieved.

startTimestring date-time

Optional parameter. If provided, service returns all the workflows created after this time. Value can be Unix time in milliseconds or date in ISO format 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 parameter. If provided, service returns all the workflows created before this time. Value can be Unix time in milliseconds or date in ISO format 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

idstring

protocolSlugstring

pipelineIdstring

protocolVersionstring

orgSlugstring

statusstring

createdAtinteger

lastUpdatedAtinteger

pipelineConfigobject

Example response

[
  {
    "id": "ab3d4e44-483e-446f-9e76-92ab4d01f903",
    "protocolSlug": "leaf-nodes-excel-and-csv-to-adf",
    "pipelineId": "a592d372-3bdf-417e-b650-4e3c02cec688",
    "protocolVersion": "v1.0.0",
    "orgSlug": "demo",
    "protocol": {
      "name": "Convert leaf nodes Excel into ADF",
      "steps": [
        {
          "slug": "parse-leaf-nodes-excel-or-csv-to-json",
          "description": "Parse a leaf node Excel into a json file, such that ADF/SHACL generation can be automated. ",
          "type": "parser",
          "pattern": "map",
          "script": {
            "slug": "parse-leaf-nodes-excel-or-csv-to-json",
            "version": "v1.0.0"
          },
          "inputMapping": [
            {
              "key": "tempDir",
              "value": "/$context/session/fileDir"
            }
          ],
          "outputMapping": [
            {
              "key": "leafNodesJson",
              "shouldUpload": true,
              "value": "/$session/leafNodesJson"
            }
          ]
        }
      ]
    },
    "inputFile": {
      "meta": {
        "fileId": "7beb45c3-2d07-4ad7-bf49-8efa29a52e44",
        "sourceType": "egnyte",
        "source": {
          "type": "egnyte",
          "egnyte": {
            "url": "https://apptetrascience.qa-egnyte.com",
            "integrationId": "febf8cab-0103-4320-ad63-7eab9f26d025",
            "filePath": "/Private/demo/test/Structured Spreadsheet for RAMAN Data Cube automation 20180802.xlsx",
            "fileName": "Structured Spreadsheet for RAMAN Data Cube automation 20180802.xlsx",
            "groupId": "df754531-48bf-441b-8a6b-329f55914c51",
            "entryId": "051d5fc1-be3e-4219-bc90-303b3a1e89df",
            "checksum": "bbb609cb3fed2bcc2bec44de062c450115322f9b35bbf74f988d1d789326767bb59cf8f68a229c1e5808c8b51d6d22a631dc44ad49ae62c54056a89807367bb6",
            "versionId": "051d5fc1-be3e-4219-bc90-303b3a1e89df",
            "lastModifiedTime": "2018-09-17T17:47:42.000Z",
            "versionNum": 1
          }
        }
      },
      "fileKey": "demo/7beb45c3-2d07-4ad7-bf49-8efa29a52e44/1538761419866-Structured Spreadsheet for RAMAN Data Cube automation 20180802.xlsx",
      "bucket": "files-service",
      "type": "s3file",
      "checksum": "d219c4945c3167d4547640d211908640"
    },
    "tasks": [
      {
        "logs": [
          {
            "type": "content",
            "sessionId": "5fc6004f-f9df-4f57-8455-49fd99e4bbc6"
          }
        ],
        "slug": "parse-leaf-nodes-excel-or-csv-to-json",
        "errors": [
          {
            "error": {
              "error": {
                "message": "Parsing error"
              },
              "message": "Script failed. Please check the log file"
            },
            "action": "run-script",
            "exitCode": 1,
            "sessionId": "5fc6004f-f9df-4f57-8455-49fd99e4bbc6",
            "humanReadableMsg": "Script failed. Please check the log file"
          }
        ],
        "status": "failed",
        "taskId": "72e9f8fe-bbc6-49f7-b609-8c48e6b98447",
        "createdAt": 1538761420014,
        "lastUpdatedAt": 1538761426013
      }
    ],
    "status": "failed",
    "createdAt": 1538761420014,
    "lastUpdatedAt": 1538761426013
  }
]