Start a workflow execution as a new session or a new attempt of an existing session

Request

"resume" is used to rerun an attempt. It is used in the case an attempt failed then users want to resume it from the middle.It has two modes "failed" or "from" to set the way to resume.In "failed" mode, the attempt specified by "attemptId" is resumed from the failed tasks.In "from" mode, the attempt is resumed from the task which is set in "from" field.

Security

ApiKeyAuth

Bodyapplication/json

allowQueueingboolean

Whether an attempt can be queued when the maximum attempt limit is reached.

paramsobjectrequired

parameters as json

Example:

{
  "key1": 12345
}

projectNamestring

project name. workflowId or (projectName and workflowName) are required

Example:"project-a"

resumeobject(Resume)

retryAttemptNamestring

unique attempt name for retry

sessionTimestring, (date-time)required

session time

Example:"2023-08-17T18:56:24+09:00"

workflowIdstring

workflow ID. workflowId or (projectName and workflowName) are required

Example:"123456"

workflowNamestring

workflow name. workflowId or (projectName and workflowName) are required

Example:"workflow-a"

curl -i -X PUT \
  https://api-workflow.treasuredata.com/api/attempts \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allowQueueing": true,
    "params": {
      "key1": 12345
    },
    "projectName": "project-a",
    "resume": {
      "attemptId": "12345",
      "mode": "failed"
    },
    "retryAttemptName": "string",
    "sessionTime": "2023-08-17T18:56:24+09:00",
    "workflowId": "123456",
    "workflowName": "workflow-a"
  }'

Responses

return an attempt

Bodyapplication/json

cancelRequestedbooleanrequired

true if kill requested

createdAtstring, (date-time)required

created time

Example:"2023-08-18T06:52:33Z"

donebooleanrequired

true if the attempt finished

finishedAtstring, (date-time)

finished time

Example:"2023-08-18T06:52:33Z"

idstringrequired

attempt ID

Example:"123456"

indexinteger, (int32)required

index for multiple attempts

Example:1

paramsobjectrequired

passed parameters as JSON

poolIdstring

ID of the pool to which this attempt is assigned.

Example:"42"

projectobject(IdAndName)required

Name and ID

retryAttemptNamestringrequired

attempt name for retry

Example:"retry-12345"

sessionIdstringrequired

session ID

Example:"123456"

sessionTimestringrequired

session time

Example:"2022-12-31T23:59:00+00:00"

sessionUuidstring, (uuid)required

unique UUID of this session

Example:"2b91a014-076e-4c6d-8b51-f4f91089cab2"

statusstringrequired

The current status of the attempt.

Enum:"blocked""queued""running""canceling""success""error""killed"

Example:"running"

successbooleanrequired

true if the attempt finished successfully

workflowobject(NameOptionalId)required

Name and optional ID

Response

{
  "cancelRequested": true,
  "createdAt": "2023-08-18T06:52:33Z",
  "done": true,
  "finishedAt": "2023-08-18T06:52:33Z",
  "id": "123456",
  "index": 1,
  "params": {},
  "poolId": "42",
  "project": {
    "id": "123456",
    "name": "abcdefg"
  },
  "retryAttemptName": "retry-12345",
  "sessionId": "123456",
  "sessionTime": "2022-12-31T23:59:00+00:00",
  "sessionUuid": "2b91a014-076e-4c6d-8b51-f4f91089cab2",
  "status": "running",
  "success": true,
  "workflow": {
    "id": "123456",
    "name": "abcdefg"
  }
}