Skip to content
API Documents/
/Session

Treasure Workflow (1.0)

Treasure Workflow

Download OpenAPI description
workflow.json
workflow.yaml
Languages
Servers
Mock server
https://docs.treasuredata.com/_mock/apis/workflow
aws
https://api-workflow.treasuredata.com
aws-tokyo
https://api-workflow.treasuredata.co.jp
eu01
https://api-workflow.eu01.treasuredata.com
ap02
https://api-workflow.ap02.treasuredata.com
ap03
https://api-workflow.ap03.treasuredata.com

Attempt

Operations

Log

Operations

Project

Operations

Schedule

Operations

Session

Operations

List sessions

Request

Security
ApiKeyAuth
Query
last_idinteger(int64)

List sessions whose ID is smaller than this ID for pagination. Sessions are returned in descending order by ID.

page_sizeinteger(int32)

number of sessions to return

curl -i -X GET \
  'https://docs.treasuredata.com/_mock/apis/workflow/api/sessions?last_id=0&page_size=0' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

default response

Bodyapplication/json
sessionsArray of objects(RestSession)
Response
application/json
{
  "sessions": [
    { … }
  ]
}

Get a session

Request

Security
ApiKeyAuth
Path
idinteger(int64)required

session id

curl -i -X GET \
  'https://docs.treasuredata.com/_mock/apis/workflow/api/sessions/{id}' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

default response

Bodyapplication/json
idstringrequired

session ID

Example: "123456"
lastAttemptobject(Attempt)

Attempts of session

projectobject(IdAndName)required

Name and ID

project.​idstringrequired

ID

Example: "123456"
project.​namestringrequired

name

Example: "abcdefg"
sessionTimestringrequired

session time

Example: "2022-12-31T23:59:00+00:00"
sessionUuidstring(uuid)
workflowobject(NameOptionalId)required

Name and optional ID

workflow.​idstring

ID

Example: "123456"
workflow.​namestringrequired

name

Example: "abcdefg"
Response
application/json
{
  "id": "123456",
  "lastAttempt": {
    "cancelRequested": true,
    "createdAt": "2023-08-18T06:52:33Z",
    "done": true,
    "finishedAt": "2023-08-18T06:52:33Z",
    "id": "123456",
    "params": {},
    "poolId": "42",
    "retryAttemptName": "string",
    "status": "running",
    "success": true
  },
  "project": {
    "id": "123456",
    "name": "abcdefg"
  },
  "sessionTime": "2022-12-31T23:59:00+00:00",
  "sessionUuid": "0688aee8-ffa9-4d26-9262-47526493535e",
  "workflow": {
    "id": "123456",
    "name": "abcdefg"
  }
}

List attempts of a session

Request

Security
ApiKeyAuth
Path
idinteger(int64)required

session id

Query
last_idinteger(int64)

List attempts whose ID is smaller than this ID for pagination. Attempts are returned in descending order by ID.

page_sizeinteger(int32)

number of attempts to return

curl -i -X GET \
  'https://docs.treasuredata.com/_mock/apis/workflow/api/sessions/{id}/attempts?last_id=0&page_size=0' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

default response

Bodyapplication/json
attemptsArray of objects(RestSessionAttempt)
Response
application/json
{
  "attempts": [
    { … }
  ]
}

Workflow

Operations