GET /projects/{projectId}/workflows
Oauth2

List workflows in project

Path parameters

  • projectId string Required

    Project ID

Query parameters

  • sort string

    Sort string. Must be in the form field:order. field may be one of: id, created, started, or finished. order may be one of -1 for descending or 1 for ascending. Resources are sorted in descending order by id by default.

  • q string

    Query string. See search query syntax for details. Supported search fields are: id, and state.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id string Required
    • jobs array[string] Required

      Job IDs

    • state string Required

      Current workflow state

      Values are pending, started, success, failure, or canceled.

    • created string Required

      ISO 8601 datetime

    • started string Required

      ISO 8601 datetime

    • finished string Required

      ISO 8601 datetime

    • definition string Required

      Raw definition string

    • project_id string Required

      Project ID

    • link string

      Status query URL
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • code integer

      HTTP response code

    • name string

      Status text corresponding to the HTTP response code

    • description string

      Detailed error message
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • code integer

      HTTP response code

    • name string

      Status text corresponding to the HTTP response code

    • description string

      Detailed error message
GET /projects/{projectId}/workflows 
curl \
 --request GET 'https://api.metafold3d.com/projects/{projectId}/workflows' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": "123",
    "jobs": [
      "1",
      "2",
      "3"
    ],
    "state": "success",
    "created": "2006-01-02T22:04:05+00:00",
    "started": "2006-01-02T22:04:10+00:00",
    "finished": "2006-01-02T22:04:40+00:00",
    "definition": "---\njobs:\n  preprocess-mesh:\n    type: mesh/preprocess\n  compute-bvh:\n    type: mesh/compute-bvh\n    needs:\n    - preprocess-mesh\n    assets:\n      mesh: preprocess-mesh\n  sample-mesh:\n    type: implicit/from-mesh\n    needs:\n    - preprocess-mesh\n    - compute-bvh\n    assets:\n      mesh: preprocess-mesh\n      bvh: compute-bvh\n...\n",
    "project_id": "123"
  }
]
Response examples (400) 
{
  "code": 400,
  "name": "Bad Request",
  "description": "Expected parameter \"foo\""
}
Response examples (401) 
{
  "code": 401,
  "name": "Unauthorzed",
  "description": "Token has expired"
}