IM
JA
ドキュメントホーム
メニュー

Contents

Task endpoints

GET/api/accounts/{account_id}/tasks

List queued/running/finished tasks for an account. More Tasks

Responses
200application/json
OK
schemaobject
dataarrayrequired
itemTaskrequired
An orchestration record that fans out one or more provider jobs.
idstringrequired
Task identifier.
account_idstringrequired
Account identifier.
application_idstringrequired
Application identifier.
created_bystringrequired
User identifier.
task_typestringrequired
target_credential_idstring | nullrequired
Provider credential identifier.
payloadrequired
statusrequired
priorityintegerrequired
available_atstringrequired
started_atstring | nullrequired
finished_atstring | nullrequired
last_error_codestring | nullrequired
last_errorstring | nullrequired
dedupe_keystring | nullrequired
expected_job_countnumber | nullrequired
fanout_completed_atstring | nullrequired
created_atstringrequired
updated_atstringrequired
meta
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/accounts/{account_id}/tasks

Create a task that can fan out queue jobs. More Tasks

Body application/json
task_typestringrequired
target_credential_idstring | null
Provider credential identifier.
payload
priorityinteger
dedupe_keystring | null
Responses
201application/json
Created
schemaobject
dataTaskrequired
An orchestration record that fans out one or more provider jobs.
idstringrequired
Task identifier.
account_idstringrequired
Account identifier.
application_idstringrequired
Application identifier.
created_bystringrequired
User identifier.
task_typestringrequired
target_credential_idstring | nullrequired
Provider credential identifier.
payloadrequired
statusrequired
priorityintegerrequired
available_atstringrequired
started_atstring | nullrequired
finished_atstring | nullrequired
last_error_codestring | nullrequired
last_errorstring | nullrequired
dedupe_keystring | nullrequired
expected_job_countnumber | nullrequired
fanout_completed_atstring | nullrequired
created_atstringrequired
updated_atstringrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/accounts/{account_id}/tasks/search

Search tasks by query expression with paging controls. More Tasks

Body application/json
querystringrequired
limitinteger
offsetinteger
Responses
200application/json
OK
schemaobject
dataarrayrequired
itemTaskrequired
An orchestration record that fans out one or more provider jobs.
idstringrequired
Task identifier.
account_idstringrequired
Account identifier.
application_idstringrequired
Application identifier.
created_bystringrequired
User identifier.
task_typestringrequired
target_credential_idstring | nullrequired
Provider credential identifier.
payloadrequired
statusrequired
priorityintegerrequired
available_atstringrequired
started_atstring | nullrequired
finished_atstring | nullrequired
last_error_codestring | nullrequired
last_errorstring | nullrequired
dedupe_keystring | nullrequired
expected_job_countnumber | nullrequired
fanout_completed_atstring | nullrequired
created_atstringrequired
updated_atstringrequired
meta
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
DELETE/api/tasks/{task_id}

Delete a task record by ID. More Tasks

Responses
204
No Content
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/tasks/{task_id}

Retrieve one task by ID. More Tasks

Responses
200application/json
OK
schemaobject
dataTaskrequired
An orchestration record that fans out one or more provider jobs.
idstringrequired
Task identifier.
account_idstringrequired
Account identifier.
application_idstringrequired
Application identifier.
created_bystringrequired
User identifier.
task_typestringrequired
target_credential_idstring | nullrequired
Provider credential identifier.
payloadrequired
statusrequired
priorityintegerrequired
available_atstringrequired
started_atstring | nullrequired
finished_atstring | nullrequired
last_error_codestring | nullrequired
last_errorstring | nullrequired
dedupe_keystring | nullrequired
expected_job_countnumber | nullrequired
fanout_completed_atstring | nullrequired
created_atstringrequired
updated_atstringrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
PATCH/api/tasks/{task_id}

Update mutable task fields such as status, schedule, and priority. More Tasks

Body application/json
status
priorityinteger
available_atstring
last_error_codestring | null
last_errorstring | null
Responses
200application/json
OK
schemaobject
dataTaskrequired
An orchestration record that fans out one or more provider jobs.
idstringrequired
Task identifier.
account_idstringrequired
Account identifier.
application_idstringrequired
Application identifier.
created_bystringrequired
User identifier.
task_typestringrequired
target_credential_idstring | nullrequired
Provider credential identifier.
payloadrequired
statusrequired
priorityintegerrequired
available_atstringrequired
started_atstring | nullrequired
finished_atstring | nullrequired
last_error_codestring | nullrequired
last_errorstring | nullrequired
dedupe_keystring | nullrequired
expected_job_countnumber | nullrequired
fanout_completed_atstring | nullrequired
created_atstringrequired
updated_atstringrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/tasks/{task_id}/trigger

Force-trigger immediate execution for a task by enqueueing a job. More Tasks

Body application/json
reasonstring
Responses
200application/json
OK
schemaobject
dataobjectrequired
task_idstringrequired
Task identifier.
jobJobrequired
A queue job representing provider or internal work derived from tasks and retriable independently.
idstringrequired
Job identifier.
account_idstringrequired
Account identifier.
application_idstringrequired
Application identifier.
task_idstring | nullrequired
Task identifier.
source_kindrequired
queue_namestringrequired
job_typestringrequired
dedupe_keystringrequired
payloadrequired
attemptsintegerrequired
max_attemptsintegerrequired
available_atstringrequired
claimed_atstring | nullrequired
succeeded_atstring | nullrequired
failed_atstring | nullrequired
resolved_atstring | nullrequired
resolved_bystring | nullrequired
User identifier.
resolution_notestring | nullrequired
last_error_codestring | nullrequired
last_error_detailstring | nullrequired
versionintegerrequired
created_atstringrequired
updated_atstringrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring

Models

Job
idstringrequired
Job identifier.
account_idstringrequired
Account identifier.
application_idstringrequired
Application identifier.
task_idstring | nullrequired
Task identifier.
source_kindrequired
queue_namestringrequired
job_typestringrequired
dedupe_keystringrequired
payloadrequired
attemptsintegerrequired
max_attemptsintegerrequired
available_atstringrequired
claimed_atstring | nullrequired
succeeded_atstring | nullrequired
failed_atstring | nullrequired
resolved_atstring | nullrequired
resolved_bystring | nullrequired
User identifier.
resolution_notestring | nullrequired
last_error_codestring | nullrequired
last_error_detailstring | nullrequired
versionintegerrequired
created_atstringrequired
updated_atstringrequired
ProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
Task
idstringrequired
Task identifier.
account_idstringrequired
Account identifier.
application_idstringrequired
Application identifier.
created_bystringrequired
User identifier.
task_typestringrequired
target_credential_idstring | nullrequired
Provider credential identifier.
payloadrequired
statusrequired
priorityintegerrequired
available_atstringrequired
started_atstring | nullrequired
finished_atstring | nullrequired
last_error_codestring | nullrequired
last_errorstring | nullrequired
dedupe_keystring | nullrequired
expected_job_countnumber | nullrequired
fanout_completed_atstring | nullrequired
created_atstringrequired
updated_atstringrequired
ValidationProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring