{"items":[{"type":"link","label":"Treasure Workflow","link":"/apis/workflow","routeSlug":"/apis/workflow","content":{"contentType":"overview","meta":{"name":"Treasure Workflow"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"workflow.json","url":"/_bundle/apis/workflow.json?download"},{"kind":"download","label":"workflow.yaml","url":"/_bundle/apis/workflow.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"aws","url":"https://api-workflow.treasuredata.com"},{"description":"aws-tokyo","url":"https://api-workflow.treasuredata.co.jp"},{"description":"eu01","url":"https://api-workflow.eu01.treasuredata.com"},{"description":"ap02","url":"https://api-workflow.ap02.treasuredata.com"},{"description":"ap03","url":"https://api-workflow.ap03.treasuredata.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Treasure Workflow (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Treasure Workflow"}],"sectionId":"/apis/workflow"}],"sectionId":"/apis/workflow"}]}]}},{"type":"group","label":"Attempt","link":"/apis/workflow/attempt","routeSlug":"/apis/workflow/attempt","items":[{"label":"List attempts with filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/attempt/getattempts","routeSlug":"/apis/workflow/attempt/getattempts","metadata":{"seo":{"title":"List attempts with filters","description":"List attempts with filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttempts","name":"List attempts with filters","isWebhook":false,"pointer":"/paths/~1api~1attempts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attempts with filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"project","in":"query","schemaId":"schema_596","description":"exact matching filter on project name"},{"name":"workflow","in":"query","schemaId":"schema_596","description":"exact matching filter on workflow name"},{"name":"include_retried","in":"query","schemaId":"schema_597","description":"list more than 1 attempts per session"},{"name":"last_id","in":"query","schemaId":"schema_598","description":"List attempts whose ID is smaller than this ID for pagination. Attempts are returned in descending order by ID."},{"name":"page_size","in":"query","schemaId":"schema_599","description":"number of attempts to return"}],"pointer":"/paths/~1api~1attempts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/attempts","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[{"name":"project","in":"query","schemaId":"schema_596"},{"name":"workflow","in":"query","schemaId":"schema_596"},{"name":"include_retried","in":"query","schemaId":"schema_597"},{"name":"last_id","in":"query","schemaId":"schema_598"},{"name":"page_size","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/attempts","href":"attempt/getattempts","openApiOperationId":"getAttempts","summary":"List attempts with filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptCollection"}},"schemaId":"components/schemas/RestSessionAttemptCollection"}],"pointer":"/paths/~1api~1attempts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSessionAttemptCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attempt/getattempts"}],"panels":[]}]},"httpPath":"/api/attempts"},{"label":"Start a workflow execution as a new session or a new attempt of an existing session","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/attempt/startattempt","routeSlug":"/apis/workflow/attempt/startattempt","metadata":{"seo":{"title":"Start a workflow execution as a new session or a new attempt of an existing session","description":"\"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startAttempt","name":"Start a workflow execution as a new session or a new attempt of an existing session","isWebhook":false,"pointer":"/paths/~1api~1attempts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a workflow execution as a new session or a new attempt of an existing session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptRequest"}},"schemaId":"components/schemas/RestSessionAttemptRequest","pointer":"/paths/~1api~1attempts/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/attempts","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptRequest"}},"responseCodes":["200","409"],"pointer":"/api/attempts","href":"attempt/startattempt","openApiOperationId":"startAttempt","summary":"Start a workflow execution as a new session or a new attempt of an existing session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestSessionAttemptRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"return an attempt","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttempt"}},"schemaId":"components/schemas/RestSessionAttempt"},{"code":"409","description":"session or attempt already exist. return the existing attempt.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttempt"}},"schemaId":"components/schemas/RestSessionAttempt"}],"pointer":"/paths/~1api~1attempts/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSessionAttempt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttempt"}}},{"code":"409","schemaId":"components/schemas/RestSessionAttempt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttempt"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attempt/startattempt"}],"panels":[]}]},"httpPath":"/api/attempts"},{"label":"Get an attempt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/attempt/getattempt","routeSlug":"/apis/workflow/attempt/getattempt","metadata":{"seo":{"title":"Get an attempt","description":"Get an attempt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttempt","name":"Get an attempt","isWebhook":false,"pointer":"/paths/~1api~1attempts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an attempt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_598","description":"attempt id","required":true}],"pointer":"/paths/~1api~1attempts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/attempts/{id}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/attempts/{id}","href":"attempt/getattempt","openApiOperationId":"getAttempt","summary":"Get an attempt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttempt"}},"schemaId":"components/schemas/RestSessionAttempt"}],"pointer":"/paths/~1api~1attempts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSessionAttempt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttempt"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attempt/getattempt"}],"panels":[]}]},"httpPath":"/api/attempts/{id}"},{"label":"Set a cancel-requested flag on a running attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/attempt/killattempt","routeSlug":"/apis/workflow/attempt/killattempt","metadata":{"seo":{"title":"Set a cancel-requested flag on a running attempt","description":"Set a cancel-requested flag on a running attempt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"killAttempt","name":"Set a cancel-requested flag on a running attempt","isWebhook":false,"pointer":"/paths/~1api~1attempts~1{id}~1kill/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a cancel-requested flag on a running attempt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_598","description":"attempt id","required":true}],"pointer":"/paths/~1api~1attempts~1{id}~1kill/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/attempts/{id}/kill","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/attempts/{id}/kill","href":"attempt/killattempt","openApiOperationId":"killAttempt","summary":"Set a cancel-requested flag on a running attempt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"return an attempt","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttempt"}},"schemaId":"components/schemas/RestSessionAttempt"}],"pointer":"/paths/~1api~1attempts~1{id}~1kill/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSessionAttempt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttempt"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attempt/killattempt"}],"panels":[]}]},"httpPath":"/api/attempts/{id}/kill"},{"label":"List attempts of a session of a given attempt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/attempt/getattemptretries","routeSlug":"/apis/workflow/attempt/getattemptretries","metadata":{"seo":{"title":"List attempts of a session of a given attempt","description":"List attempts of a session of a given attempt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttemptRetries","name":"List attempts of a session of a given attempt","isWebhook":false,"pointer":"/paths/~1api~1attempts~1{id}~1retries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attempts of a session of a given attempt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_598","description":"attempt id","required":true}],"pointer":"/paths/~1api~1attempts~1{id}~1retries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/attempts/{id}/retries","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/attempts/{id}/retries","href":"attempt/getattemptretries","openApiOperationId":"getAttemptRetries","summary":"List attempts of a session of a given attempt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptCollection"}},"schemaId":"components/schemas/RestSessionAttemptCollection"}],"pointer":"/paths/~1api~1attempts~1{id}~1retries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSessionAttemptCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attempt/getattemptretries"}],"panels":[]}]},"httpPath":"/api/attempts/{id}/retries"},{"label":"List tasks of an attempt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/attempt/gettasks","routeSlug":"/apis/workflow/attempt/gettasks","metadata":{"seo":{"title":"List tasks of an attempt","description":"List tasks of an attempt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTasks","name":"List tasks of an attempt","isWebhook":false,"pointer":"/paths/~1api~1attempts~1{id}~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tasks of an attempt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_598","description":"attempt id","required":true}],"pointer":"/paths/~1api~1attempts~1{id}~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/attempts/{id}/tasks","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/attempts/{id}/tasks","href":"attempt/gettasks","openApiOperationId":"getTasks","summary":"List tasks of an attempt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestTaskCollection"}},"schemaId":"components/schemas/RestTaskCollection"}],"pointer":"/paths/~1api~1attempts~1{id}~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestTaskCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestTaskCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attempt/gettasks"}],"panels":[]}]},"httpPath":"/api/attempts/{id}/tasks"}],"content":{"contentType":"group","meta":{"name":"Attempt"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attempt","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/attempts","summary":"List attempts with filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attempt/getattempts","deprecated":false},{"title":"/api/attempts","summary":"Start a workflow execution as a new session or a new attempt of an existing session","prefix":{"name":"put","color":"put"},"badges":[],"link":"/attempt/startattempt","deprecated":false},{"title":"/api/attempts/{id}","summary":"Get an attempt","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attempt/getattempt","deprecated":false},{"title":"/api/attempts/{id}/kill","summary":"Set a cancel-requested flag on a running attempt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/attempt/killattempt","deprecated":false},{"title":"/api/attempts/{id}/retries","summary":"List attempts of a session of a given attempt","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attempt/getattemptretries","deprecated":false},{"title":"/api/attempts/{id}/tasks","summary":"List tasks of an attempt","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attempt/gettasks","deprecated":false}]}]}]}]}},{"type":"group","label":"Log","link":"/apis/workflow/log","routeSlug":"/apis/workflow/log","items":[{"label":"List log files of an attempt with filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/log/getfilehandles","routeSlug":"/apis/workflow/log/getfilehandles","metadata":{"seo":{"title":"List log files of an attempt with filters","description":"List log files of an attempt with filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFileHandles","name":"List log files of an attempt with filters","isWebhook":false,"pointer":"/paths/~1api~1logs~1{attempt_id}~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List log files of an attempt with filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attempt_id","in":"path","schemaId":"schema_598","description":"attempt id","required":true}],"pointer":"/paths/~1api~1logs~1{attempt_id}~1files/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"task","in":"query","schemaId":"schema_596","description":"partial prefix match filter on task name"},{"name":"direct_download","in":"query","schemaId":"schema_597","description":"enable returning direct download handle"}],"pointer":"/paths/~1api~1logs~1{attempt_id}~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/logs/{attempt_id}/files","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"attempt_id","in":"path","required":true,"schemaId":"schema_598"}],"query":[{"name":"task","in":"query","schemaId":"schema_596"},{"name":"direct_download","in":"query","schemaId":"schema_597"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/logs/{attempt_id}/files","href":"log/getfilehandles","openApiOperationId":"getFileHandles","summary":"List log files of an attempt with filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestLogFileHandleCollection"}},"schemaId":"components/schemas/RestLogFileHandleCollection"}],"pointer":"/paths/~1api~1logs~1{attempt_id}~1files/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestLogFileHandleCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestLogFileHandleCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/log/getfilehandles"}],"panels":[]}]},"httpPath":"/api/logs/{attempt_id}/files"},{"label":"Download a log file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/log/getfile","routeSlug":"/apis/workflow/log/getfile","metadata":{"seo":{"title":"Download a log file","description":"Download a log file"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFile","name":"Download a log file","isWebhook":false,"pointer":"/paths/~1api~1logs~1{attempt_id}~1files~1{file_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a log file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attempt_id","in":"path","schemaId":"schema_598","description":"attempt id","required":true},{"name":"file_name","in":"path","schemaId":"schema_596","description":"log file name","required":true}],"pointer":"/paths/~1api~1logs~1{attempt_id}~1files~1{file_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/logs/{attempt_id}/files/{file_name}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"attempt_id","in":"path","required":true,"schemaId":"schema_598"},{"name":"file_name","in":"path","required":true,"schemaId":"schema_596"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/logs/{attempt_id}/files/{file_name}","href":"log/getfile","openApiOperationId":"getFile","summary":"Download a log file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/gzip","mediaTypes":["application/gzip"],"mediaTypeContent":{"application/gzip":{"schemaId":"schema_600"}},"schemaId":"schema_600"}],"pointer":"/paths/~1api~1logs~1{attempt_id}~1files~1{file_name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_600","mediaTypes":["application/gzip"],"mediaTypeContent":{"application/gzip":{"schemaId":"schema_600"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/log/getfile"}],"panels":[]}]},"httpPath":"/api/logs/{attempt_id}/files/{file_name}"}],"content":{"contentType":"group","meta":{"name":"Log"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Log","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/logs/{attempt_id}/files","summary":"List log files of an attempt with filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/log/getfilehandles","deprecated":false},{"title":"/api/logs/{attempt_id}/files/{file_name}","summary":"Download a log file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/log/getfile","deprecated":false}]}]}]}]}},{"type":"group","label":"Pool","link":"/apis/workflow/pool","routeSlug":"/apis/workflow/pool","items":[{"label":"List pool rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/getpoolrules","routeSlug":"/apis/workflow/pool/getpoolrules","metadata":{"seo":{"title":"List pool rules","description":"List pool rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPoolRules","name":"List pool rules","isWebhook":false,"pointer":"/paths/~1api~1pool_rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List pool rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List pool rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pool_rules","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/pool_rules","href":"pool/getpoolrules","openApiOperationId":"getPoolRules","summary":"List pool rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of pool rules","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRuleCollection"}},"schemaId":"components/schemas/RestPoolRuleCollection"}],"pointer":"/paths/~1api~1pool_rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestPoolRuleCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRuleCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/getpoolrules"}],"panels":[]}]},"httpPath":"/api/pool_rules"},{"label":"Create a pool rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/createpoolrule","routeSlug":"/apis/workflow/pool/createpoolrule","metadata":{"seo":{"title":"Create a pool rule","description":"Create a rule that assigns an attempt to a pool based on conditions. A rule consists of a priority, conditions, and a pool ID. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority. If all of a rule's conditions are met, an attempt is assigned to its pool. If none of the rules are met, an attempt is assigned to a default pool."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPoolRule","name":"Create a pool rule","isWebhook":false,"pointer":"/paths/~1api~1pool_rules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a pool rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a rule that assigns an attempt to a pool based on conditions. A rule consists of a priority, conditions, and a pool ID. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority. If all of a rule's conditions are met, an attempt is assigned to its pool. If none of the rules are met, an attempt is assigned to a default pool."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestPoolRuleCreateRequest"}},"schemaId":"components/schemas/RestPoolRuleCreateRequest","pointer":"/paths/~1api~1pool_rules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/pool_rules","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestPoolRuleCreateRequest"}},"responseCodes":["201","400","403"],"pointer":"/api/pool_rules","href":"pool/createpoolrule","openApiOperationId":"createPoolRule","summary":"Create a pool rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestPoolRuleCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestPoolRuleCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Pool rule created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRule"}},"schemaId":"components/schemas/RestPoolRule"},{"code":"400","description":"Invalid request"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1api~1pool_rules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/RestPoolRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRule"}}},{"code":"400"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/createpoolrule"}],"panels":[]}]},"httpPath":"/api/pool_rules"},{"label":"Delete a pool rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/deletepoolrule","routeSlug":"/apis/workflow/pool/deletepoolrule","metadata":{"seo":{"title":"Delete a pool rule","description":"Delete a pool rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePoolRule","name":"Delete a pool rule","isWebhook":false,"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a pool rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a pool rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"poolRuleId","in":"path","schemaId":"schema_601","required":true}],"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/pool_rules/{poolRuleId}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"poolRuleId","in":"path","required":true,"schemaId":"schema_601"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/pool_rules/{poolRuleId}","href":"pool/deletepoolrule","openApiOperationId":"deletePoolRule","summary":"Delete a pool rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pool rule deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRule"}},"schemaId":"components/schemas/RestPoolRule"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Pool rule not found"}],"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestPoolRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRule"}}},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/deletepoolrule"}],"panels":[]}]},"httpPath":"/api/pool_rules/{poolRuleId}"},{"label":"Get a pool rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/getpoolrule","routeSlug":"/apis/workflow/pool/getpoolrule","metadata":{"seo":{"title":"Get a pool rule","description":"Get a pool rule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPoolRule","name":"Get a pool rule","isWebhook":false,"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a pool rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a pool rule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"poolRuleId","in":"path","schemaId":"schema_601","required":true}],"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pool_rules/{poolRuleId}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"poolRuleId","in":"path","required":true,"schemaId":"schema_601"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/pool_rules/{poolRuleId}","href":"pool/getpoolrule","openApiOperationId":"getPoolRule","summary":"Get a pool rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pool rule","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRule"}},"schemaId":"components/schemas/RestPoolRule"},{"code":"404","description":"Pool rule not found"}],"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestPoolRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRule"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/getpoolrule"}],"panels":[]}]},"httpPath":"/api/pool_rules/{poolRuleId}"},{"label":"Update a pool rule","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/updatepoolrule","routeSlug":"/apis/workflow/pool/updatepoolrule","metadata":{"seo":{"title":"Update a pool rule","description":"Update a rule that assigns an attempt to a pool based on conditions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePoolRule","name":"Update a pool rule","isWebhook":false,"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a pool rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a rule that assigns an attempt to a pool based on conditions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"poolRuleId","in":"path","schemaId":"schema_601","required":true}],"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestPoolRuleUpdateRequest"}},"schemaId":"components/schemas/RestPoolRuleUpdateRequest","pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/pool_rules/{poolRuleId}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"poolRuleId","in":"path","required":true,"schemaId":"schema_601"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestPoolRuleUpdateRequest"}},"responseCodes":["200","400","403","404"],"pointer":"/api/pool_rules/{poolRuleId}","href":"pool/updatepoolrule","openApiOperationId":"updatePoolRule","summary":"Update a pool rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestPoolRuleUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestPoolRuleUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pool rule updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRule"}},"schemaId":"components/schemas/RestPoolRule"},{"code":"400","description":"Invalid request"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Pool rule not found"}],"pointer":"/paths/~1api~1pool_rules~1{poolRuleId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestPoolRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolRule"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/updatepoolrule"}],"panels":[]}]},"httpPath":"/api/pool_rules/{poolRuleId}"},{"label":"List pools","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/getpools","routeSlug":"/apis/workflow/pool/getpools","metadata":{"seo":{"title":"List pools","description":"List pools."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPools","name":"List pools","isWebhook":false,"pointer":"/paths/~1api~1pools/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List pools","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List pools."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pools","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/pools","href":"pool/getpools","openApiOperationId":"getPools","summary":"List pools"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of pools","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolCollection"}},"schemaId":"components/schemas/RestPoolCollection"}],"pointer":"/paths/~1api~1pools/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestPoolCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPoolCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/getpools"}],"panels":[]}]},"httpPath":"/api/pools"},{"label":"Create a pool","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/createpool","routeSlug":"/apis/workflow/pool/createpool","metadata":{"seo":{"title":"Create a pool","description":"Create a pool with the specified name and concurrency limit. A default pool is created with the account's concurrency limit if it does not exist. The default pool’s concurrency limit is reduced by the new pool’s concurrency limit. You cannot create a pool if the default pool has more running attempts than its new reduced concurrency limit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPool","name":"Create a pool","isWebhook":false,"pointer":"/paths/~1api~1pools/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a pool with the specified name and concurrency limit. A default pool is created with the account's concurrency limit if it does not exist. The default pool’s concurrency limit is reduced by the new pool’s concurrency limit. You cannot create a pool if the default pool has more running attempts than its new reduced concurrency limit."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestPoolCreateRequest"}},"schemaId":"components/schemas/RestPoolCreateRequest","pointer":"/paths/~1api~1pools/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/pools","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestPoolCreateRequest"}},"responseCodes":["201","400","403","409"],"pointer":"/api/pools","href":"pool/createpool","openApiOperationId":"createPool","summary":"Create a pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestPoolCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestPoolCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Pool created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPool"}},"schemaId":"components/schemas/RestPool"},{"code":"400","description":"Invalid request"},{"code":"403","description":"Forbidden"},{"code":"409","description":"Pool name is already used"}],"pointer":"/paths/~1api~1pools/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/RestPool","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPool"}}},{"code":"400"},{"code":"403"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/createpool"}],"panels":[]}]},"httpPath":"/api/pools"},{"label":"Delete a pool","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/deletepool","routeSlug":"/apis/workflow/pool/deletepool","metadata":{"seo":{"title":"Delete a pool","description":"Delete a pool. You cannot delete a pool if there are any attempts running or queued in the pool, if a pool rule references it, or if it is the default pool. The deleted pool’s concurrency limit is added to the default pool’s concurrency limit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePool","name":"Delete a pool","isWebhook":false,"pointer":"/paths/~1api~1pools~1{poolId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a pool. You cannot delete a pool if there are any attempts running or queued in the pool, if a pool rule references it, or if it is the default pool. The deleted pool’s concurrency limit is added to the default pool’s concurrency limit."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"poolId","in":"path","schemaId":"schema_602","required":true}],"pointer":"/paths/~1api~1pools~1{poolId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/pools/{poolId}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"poolId","in":"path","required":true,"schemaId":"schema_602"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200","400","403","404"],"pointer":"/api/pools/{poolId}","href":"pool/deletepool","openApiOperationId":"deletePool","summary":"Delete a pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pool deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPool"}},"schemaId":"components/schemas/RestPool"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Pool not found"}],"pointer":"/paths/~1api~1pools~1{poolId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestPool","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPool"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/deletepool"}],"panels":[]}]},"httpPath":"/api/pools/{poolId}"},{"label":"Get a pool","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/getpool","routeSlug":"/apis/workflow/pool/getpool","metadata":{"seo":{"title":"Get a pool","description":"Get a pool."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPool","name":"Get a pool","isWebhook":false,"pointer":"/paths/~1api~1pools~1{poolId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a pool."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"poolId","in":"path","schemaId":"schema_603","required":true}],"pointer":"/paths/~1api~1pools~1{poolId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pools/{poolId}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"poolId","in":"path","required":true,"schemaId":"schema_603"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/pools/{poolId}","href":"pool/getpool","openApiOperationId":"getPool","summary":"Get a pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pool","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPool"}},"schemaId":"components/schemas/RestPool"},{"code":"404","description":"Pool not found"}],"pointer":"/paths/~1api~1pools~1{poolId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestPool","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPool"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/getpool"}],"panels":[]}]},"httpPath":"/api/pools/{poolId}"},{"label":"Update a pool","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/pool/updatepool","routeSlug":"/apis/workflow/pool/updatepool","metadata":{"seo":{"title":"Update a pool","description":"Update a pool with the specified name and concurrency limit. You cannot update the default pool. The default pool’s concurrency limit is adjusted to accommodate the new concurrency limit. A pool’s concurrency limit cannot be reduced if it has more running attempts than its new reduced concurrency limit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePool","name":"Update a pool","isWebhook":false,"pointer":"/paths/~1api~1pools~1{poolId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a pool","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a pool with the specified name and concurrency limit. You cannot update the default pool. The default pool’s concurrency limit is adjusted to accommodate the new concurrency limit. A pool’s concurrency limit cannot be reduced if it has more running attempts than its new reduced concurrency limit."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"poolId","in":"path","schemaId":"schema_602","required":true}],"pointer":"/paths/~1api~1pools~1{poolId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestPoolUpdateRequest"}},"schemaId":"components/schemas/RestPoolUpdateRequest","pointer":"/paths/~1api~1pools~1{poolId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/pools/{poolId}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"poolId","in":"path","required":true,"schemaId":"schema_602"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestPoolUpdateRequest"}},"responseCodes":["200","400","403","404"],"pointer":"/api/pools/{poolId}","href":"pool/updatepool","openApiOperationId":"updatePool","summary":"Update a pool"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestPoolUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestPoolUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pool updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPool"}},"schemaId":"components/schemas/RestPool"},{"code":"400","description":"Invalid request"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Pool not found"}],"pointer":"/paths/~1api~1pools~1{poolId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestPool","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestPool"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool/updatepool"}],"panels":[]}]},"httpPath":"/api/pools/{poolId}"}],"content":{"contentType":"group","meta":{"name":"Pool"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pool","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/pool_rules","summary":"List pool rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pool/getpoolrules","deprecated":false},{"title":"/api/pool_rules","summary":"Create a pool rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pool/createpoolrule","deprecated":false},{"title":"/api/pool_rules/{poolRuleId}","summary":"Delete a pool rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pool/deletepoolrule","deprecated":false},{"title":"/api/pool_rules/{poolRuleId}","summary":"Get a pool rule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pool/getpoolrule","deprecated":false},{"title":"/api/pool_rules/{poolRuleId}","summary":"Update a pool rule","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pool/updatepoolrule","deprecated":false},{"title":"/api/pools","summary":"List pools","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pool/getpools","deprecated":false},{"title":"/api/pools","summary":"Create a pool","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pool/createpool","deprecated":false},{"title":"/api/pools/{poolId}","summary":"Delete a pool","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pool/deletepool","deprecated":false},{"title":"/api/pools/{poolId}","summary":"Get a pool","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pool/getpool","deprecated":false},{"title":"/api/pools/{poolId}","summary":"Update a pool","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pool/updatepool","deprecated":false}]}]}]}]}},{"type":"group","label":"Project","link":"/apis/workflow/project","routeSlug":"/apis/workflow/project","items":[{"label":"List projects with filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getprojects","routeSlug":"/apis/workflow/project/getprojects","metadata":{"seo":{"title":"List projects with filters","description":"List projects with filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjects","name":"List projects with filters","isWebhook":false,"pointer":"/paths/~1api~1projects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List projects with filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_596","description":"exact matching filter on project name"},{"name":"last_id","in":"query","schemaId":"schema_599","description":"List projects whose ID is greater than this ID for pagination. Projects are returned in ascending order by ID."},{"name":"count","in":"query","schemaId":"schema_599","description":"number of projects to return"},{"name":"name_pattern","in":"query","schemaId":"schema_596","description":"name pattern to be partially matched"}],"pointer":"/paths/~1api~1projects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","schemaId":"schema_596"},{"name":"last_id","in":"query","schemaId":"schema_599"},{"name":"count","in":"query","schemaId":"schema_599"},{"name":"name_pattern","in":"query","schemaId":"schema_596"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects","href":"project/getprojects","openApiOperationId":"getProjects","summary":"List projects with filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestProjectCollection"}},"schemaId":"components/schemas/RestProjectCollection"}],"pointer":"/paths/~1api~1projects/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestProjectCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestProjectCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getprojects"}],"panels":[]}]},"httpPath":"/api/projects"},{"label":"Upload a project archive as a new project or a new revision of an existing project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/putproject","routeSlug":"/apis/workflow/project/putproject","metadata":{"seo":{"title":"Upload a project archive as a new project or a new revision of an existing project","description":"Upload a project archive as a new project or a new revision of an existing project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putProject","name":"Upload a project archive as a new project or a new revision of an existing project","isWebhook":false,"pointer":"/paths/~1api~1projects/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a project archive as a new project or a new revision of an existing project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"project","in":"query","schemaId":"schema_596","description":"project name","required":true},{"name":"revision","in":"query","schemaId":"schema_596","description":"revision","required":true},{"name":"schedule_from","in":"query","schemaId":"schema_596","description":"start scheduling of new workflows from the given time instead of current time"},{"name":"clear_schedule","in":"query","schemaId":"schema_604","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"clear_schedule"},"children":[]}]}]}]},{"name":"clear_schedule_all","in":"query","schemaId":"schema_605","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"clear_schedule_all"},"children":[]}]}]}]},{"name":"skip_schedule","in":"query","schemaId":"schema_606","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"skip schedules to current time for workflows whose schedule definition changed. Ignored when clear_schedule or clear_schedule_all is specified."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1projects/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Length","in":"header","schemaId":"schema_598"}],"pointer":"/paths/~1api~1projects/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/gzip"],"mediaTypeSchemas":{"application/gzip":{"schemaId":"schema_607"}},"schemaId":"schema_607","pointer":"/paths/~1api~1projects/put/requestBody","description":"project archive data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/projects","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[{"name":"project","in":"query","required":true,"schemaId":"schema_596"},{"name":"revision","in":"query","required":true,"schemaId":"schema_596"},{"name":"schedule_from","in":"query","schemaId":"schema_596"},{"name":"clear_schedule","in":"query","schemaId":"schema_604"},{"name":"clear_schedule_all","in":"query","schemaId":"schema_605"},{"name":"skip_schedule","in":"query","schemaId":"schema_606"}],"querystring":[],"header":[{"name":"Content-Length","in":"header","schemaId":"schema_598"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/gzip":{"schemaId":"schema_607"}},"responseCodes":["200"],"pointer":"/api/projects","href":"project/putproject","openApiOperationId":"putProject","summary":"Upload a project archive as a new project or a new revision of an existing project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"schema_607","mediaTypes":["application/gzip"],"mediaTypeSchemas":{"application/gzip":{"schemaId":"schema_607"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestProject"}},"schemaId":"components/schemas/RestProject"}],"pointer":"/paths/~1api~1projects/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestProject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestProject"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/putproject"}],"panels":[]}]},"httpPath":"/api/projects"},{"label":"Delete a project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/deleteproject","routeSlug":"/apis/workflow/project/deleteproject","metadata":{"seo":{"title":"Delete a project","description":"Delete a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProject","name":"Delete a project","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","required":true}],"pointer":"/paths/~1api~1projects~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/projects/{id}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}","href":"project/deleteproject","openApiOperationId":"deleteProject","summary":"Delete a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestProject"}},"schemaId":"components/schemas/RestProject"}],"pointer":"/paths/~1api~1projects~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestProject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestProject"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/deleteproject"}],"panels":[]}]},"httpPath":"/api/projects/{id}"},{"label":"Get a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getproject","routeSlug":"/apis/workflow/project/getproject","metadata":{"seo":{"title":"Get a project","description":"Get a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProject","name":"Get a project","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"project id","required":true}],"pointer":"/paths/~1api~1projects~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects/{id}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}","href":"project/getproject","openApiOperationId":"getProject","summary":"Get a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestProject"}},"schemaId":"components/schemas/RestProject"}],"pointer":"/paths/~1api~1projects~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestProject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestProject"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getproject"}],"panels":[]}]},"httpPath":"/api/projects/{id}"},{"label":"Download a project archive file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getarchive","routeSlug":"/apis/workflow/project/getarchive","metadata":{"seo":{"title":"Download a project archive file","description":"Download a project archive file"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getArchive","name":"Download a project archive file","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1archive/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a project archive file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"project id","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1archive/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"revision","in":"query","schemaId":"schema_596","description":"use a given revision of a project instead of the latest revision","required":true},{"name":"direct_download","in":"query","schemaId":"schema_597","description":"enable returning direct download handle"}],"pointer":"/paths/~1api~1projects~1{id}~1archive/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects/{id}/archive","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[{"name":"revision","in":"query","required":true,"schemaId":"schema_596"},{"name":"direct_download","in":"query","schemaId":"schema_597"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}/archive","href":"project/getarchive","openApiOperationId":"getArchive","summary":"Download a project archive file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"archive of files of a project."}],"pointer":"/paths/~1api~1projects~1{id}~1archive/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getarchive"}],"panels":[]}]},"httpPath":"/api/projects/{id}/archive"},{"label":"List revisions of a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getrevisions","routeSlug":"/apis/workflow/project/getrevisions","metadata":{"seo":{"title":"List revisions of a project","description":"List revisions of a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRevisions","name":"List revisions of a project","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1revisions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List revisions of a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1revisions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"last_id","in":"query","schemaId":"schema_599","description":"deprecated - do not use"},{"name":"name","in":"query","schemaId":"schema_596","description":"revision name"},{"name":"page[after]","in":"query","schemaId":"schema_596","description":"cursor to next page"},{"name":"page[size]","in":"query","schemaId":"schema_608","description":"page size"}],"pointer":"/paths/~1api~1projects~1{id}~1revisions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects/{id}/revisions","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[{"name":"last_id","in":"query","schemaId":"schema_599"},{"name":"name","in":"query","schemaId":"schema_596"},{"name":"page[after]","in":"query","schemaId":"schema_596"},{"name":"page[size]","in":"query","schemaId":"schema_608"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}/revisions","href":"project/getrevisions","openApiOperationId":"getRevisions","summary":"List revisions of a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestRevisionCollection"}},"schemaId":"components/schemas/RestRevisionCollection"}],"pointer":"/paths/~1api~1projects~1{id}~1revisions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestRevisionCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestRevisionCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getrevisions"}],"panels":[]}]},"httpPath":"/api/projects/{id}/revisions"},{"label":"List schedules of a project with filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getprojectschedules","routeSlug":"/apis/workflow/project/getprojectschedules","metadata":{"seo":{"title":"List schedules of a project with filters","description":"List schedules of a project with filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectSchedules","name":"List schedules of a project with filters","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List schedules of a project with filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"project id","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1schedules/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"workflow","in":"query","schemaId":"schema_596","description":"exact matching filter on workflow name"},{"name":"last_id","in":"query","schemaId":"schema_599","description":"List schedules whose ID is greater than this ID for pagination. Schedules are returned in ascending order by ID."}],"pointer":"/paths/~1api~1projects~1{id}~1schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects/{id}/schedules","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[{"name":"workflow","in":"query","schemaId":"schema_596"},{"name":"last_id","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}/schedules","href":"project/getprojectschedules","openApiOperationId":"getProjectSchedules","summary":"List schedules of a project with filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleCollection"}},"schemaId":"components/schemas/RestScheduleCollection"}],"pointer":"/paths/~1api~1projects~1{id}~1schedules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestScheduleCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getprojectschedules"}],"panels":[]}]},"httpPath":"/api/projects/{id}/schedules"},{"label":"List secret keys of a project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getprojectsecrets","routeSlug":"/apis/workflow/project/getprojectsecrets","metadata":{"seo":{"title":"List secret keys of a project","description":"List secret keys of a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectSecrets","name":"List secret keys of a project","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1secrets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List secret keys of a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"project id","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1secrets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects/{id}/secrets","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}/secrets","href":"project/getprojectsecrets","openApiOperationId":"getProjectSecrets","summary":"List secret keys of a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSecretList"}},"schemaId":"components/schemas/RestSecretList"}],"pointer":"/paths/~1api~1projects~1{id}~1secrets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSecretList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSecretList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getprojectsecrets"}],"panels":[]}]},"httpPath":"/api/projects/{id}/secrets"},{"label":"Delete a secret from a project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/deleteprojectsecret","routeSlug":"/apis/workflow/project/deleteprojectsecret","metadata":{"seo":{"title":"Delete a secret from a project","description":"Delete a secret from a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProjectSecret","name":"Delete a secret from a project","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1secrets~1{key}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a secret from a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"project id","required":true},{"name":"key","in":"path","schemaId":"schema_596","description":"secret key","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1secrets~1{key}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/projects/{id}/secrets/{key}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"},{"name":"key","in":"path","required":true,"schemaId":"schema_596"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/api/projects/{id}/secrets/{key}","href":"project/deleteprojectsecret","openApiOperationId":"deleteProjectSecret","summary":"Delete a secret from a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Treasure Workflow never returns content"}],"pointer":"/paths/~1api~1projects~1{id}~1secrets~1{key}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/deleteprojectsecret"}],"panels":[]}]},"httpPath":"/api/projects/{id}/secrets/{key}"},{"label":"Set a secret to a project","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/putprojectsecret","routeSlug":"/apis/workflow/project/putprojectsecret","metadata":{"seo":{"title":"Set a secret to a project","description":"Set a secret to a project"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putProjectSecret","name":"Set a secret to a project","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1secrets~1{key}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a secret to a project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"project id","required":true},{"name":"key","in":"path","schemaId":"schema_596","description":"secret key","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1secrets~1{key}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestSetSecretRequest"}},"schemaId":"components/schemas/RestSetSecretRequest","pointer":"/paths/~1api~1projects~1{id}~1secrets~1{key}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/projects/{id}/secrets/{key}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"},{"name":"key","in":"path","required":true,"schemaId":"schema_596"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestSetSecretRequest"}},"responseCodes":["204"],"pointer":"/api/projects/{id}/secrets/{key}","href":"project/putprojectsecret","openApiOperationId":"putProjectSecret","summary":"Set a secret to a project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestSetSecretRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestSetSecretRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Treasure Workflow never returns content"}],"pointer":"/paths/~1api~1projects~1{id}~1secrets~1{key}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/putprojectsecret"}],"panels":[]}]},"httpPath":"/api/projects/{id}/secrets/{key}"},{"label":"List sessions of a project with filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getprojectsessions","routeSlug":"/apis/workflow/project/getprojectsessions","metadata":{"seo":{"title":"List sessions of a project with filters","description":"List sessions of a project with filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectSessions","name":"List sessions of a project with filters","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1sessions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sessions of a project with filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"project id","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1sessions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"workflow","in":"query","schemaId":"schema_596","description":"exact matching filter on workflow name"},{"name":"last_id","in":"query","schemaId":"schema_598","description":"List sessions whose ID is smaller than this ID for pagination. Sessions are returned in descending order by ID."},{"name":"page_size","in":"query","schemaId":"schema_599","description":"number of sessions to return"}],"pointer":"/paths/~1api~1projects~1{id}~1sessions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects/{id}/sessions","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[{"name":"workflow","in":"query","schemaId":"schema_596"},{"name":"last_id","in":"query","schemaId":"schema_598"},{"name":"page_size","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}/sessions","href":"project/getprojectsessions","openApiOperationId":"getProjectSessions","summary":"List sessions of a project with filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionCollection"}},"schemaId":"components/schemas/RestSessionCollection"}],"pointer":"/paths/~1api~1projects~1{id}~1sessions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSessionCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getprojectsessions"}],"panels":[]}]},"httpPath":"/api/projects/{id}/sessions"},{"label":"List workflows of a project with filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getworkflows","routeSlug":"/apis/workflow/project/getworkflows","metadata":{"seo":{"title":"List workflows of a project with filters","description":"List workflows of a project with filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflows","name":"List workflows of a project with filters","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1workflows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List workflows of a project with filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"project id","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1workflows/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"revision","in":"query","schemaId":"schema_596","description":"use a given revision of the project instead of the latest revision","required":true},{"name":"name","in":"query","schemaId":"schema_596","description":"exact matching filter on workflow name"}],"pointer":"/paths/~1api~1projects~1{id}~1workflows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects/{id}/workflows","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[{"name":"revision","in":"query","required":true,"schemaId":"schema_596"},{"name":"name","in":"query","schemaId":"schema_596"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}/workflows","href":"project/getworkflows","openApiOperationId":"getWorkflows","summary":"List workflows of a project with filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowDefinitionCollection"}},"schemaId":"components/schemas/RestWorkflowDefinitionCollection"}],"pointer":"/paths/~1api~1projects~1{id}~1workflows/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestWorkflowDefinitionCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowDefinitionCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getworkflows"}],"panels":[]}]},"httpPath":"/api/projects/{id}/workflows"},{"label":"getWorkflowByName","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/project/getworkflowbyname","routeSlug":"/apis/workflow/project/getworkflowbyname","metadata":{"seo":{"title":"getWorkflowByName"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowByName","name":"getWorkflowByName","isWebhook":false,"pointer":"/paths/~1api~1projects~1{id}~1workflows~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"getWorkflowByName","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","required":true},{"name":"name","in":"path","schemaId":"schema_596","required":true}],"pointer":"/paths/~1api~1projects~1{id}~1workflows~1{name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"revision","in":"query","schemaId":"schema_596"}],"pointer":"/paths/~1api~1projects~1{id}~1workflows~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/projects/{id}/workflows/{name}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"},{"name":"name","in":"path","required":true,"schemaId":"schema_596"}],"query":[{"name":"revision","in":"query","schemaId":"schema_596"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/projects/{id}/workflows/{name}","href":"project/getworkflowbyname","openApiOperationId":"getWorkflowByName"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowDefinition"}},"schemaId":"components/schemas/RestWorkflowDefinition"}],"pointer":"/paths/~1api~1projects~1{id}~1workflows~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestWorkflowDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowDefinition"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project/getworkflowbyname"}],"panels":[]}]},"httpPath":"/api/projects/{id}/workflows/{name}"}],"content":{"contentType":"group","meta":{"name":"Project"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/projects","summary":"List projects with filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getprojects","deprecated":false},{"title":"/api/projects","summary":"Upload a project archive as a new project or a new revision of an existing project","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project/putproject","deprecated":false},{"title":"/api/projects/{id}","summary":"Delete a project","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project/deleteproject","deprecated":false},{"title":"/api/projects/{id}","summary":"Get a project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getproject","deprecated":false},{"title":"/api/projects/{id}/archive","summary":"Download a project archive file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getarchive","deprecated":false},{"title":"/api/projects/{id}/revisions","summary":"List revisions of a project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getrevisions","deprecated":false},{"title":"/api/projects/{id}/schedules","summary":"List schedules of a project with filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getprojectschedules","deprecated":false},{"title":"/api/projects/{id}/secrets","summary":"List secret keys of a project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getprojectsecrets","deprecated":false},{"title":"/api/projects/{id}/secrets/{key}","summary":"Delete a secret from a project","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project/deleteprojectsecret","deprecated":false},{"title":"/api/projects/{id}/secrets/{key}","summary":"Set a secret to a project","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project/putprojectsecret","deprecated":false},{"title":"/api/projects/{id}/sessions","summary":"List sessions of a project with filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getprojectsessions","deprecated":false},{"title":"/api/projects/{id}/workflows","summary":"List workflows of a project with filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getworkflows","deprecated":false},{"title":"/api/projects/{id}/workflows/{name}","summary":"getWorkflowByName","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project/getworkflowbyname","deprecated":false}]}]}]}]}},{"type":"group","label":"Schedule","link":"/apis/workflow/schedule","routeSlug":"/apis/workflow/schedule","items":[{"label":"List schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/schedule/getschedules","routeSlug":"/apis/workflow/schedule/getschedules","metadata":{"seo":{"title":"List schedules","description":"List schedules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchedules","name":"List schedules","isWebhook":false,"pointer":"/paths/~1api~1schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"last_id","in":"query","schemaId":"schema_599","description":"List schedules whose ID is greater than this ID for pagination. Schedules are returned in ascending order by ID."}],"pointer":"/paths/~1api~1schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/schedules","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[{"name":"last_id","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/schedules","href":"schedule/getschedules","openApiOperationId":"getSchedules","summary":"List schedules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleCollection"}},"schemaId":"components/schemas/RestScheduleCollection"}],"pointer":"/paths/~1api~1schedules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestScheduleCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule/getschedules"}],"panels":[]}]},"httpPath":"/api/schedules"},{"label":"Get a schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/schedule/getschedule","routeSlug":"/apis/workflow/schedule/getschedule","metadata":{"seo":{"title":"Get a schedule","description":"Get a schedule"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchedule","name":"Get a schedule","isWebhook":false,"pointer":"/paths/~1api~1schedules~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"schedule id","required":true}],"pointer":"/paths/~1api~1schedules~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/schedules/{id}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/schedules/{id}","href":"schedule/getschedule","openApiOperationId":"getSchedule","summary":"Get a schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSchedule"}},"schemaId":"components/schemas/RestSchedule"}],"pointer":"/paths/~1api~1schedules~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSchedule"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule/getschedule"}],"panels":[]}]},"httpPath":"/api/schedules/{id}"},{"label":"Backfill sessions for past schedule times","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/schedule/backfillschedule","routeSlug":"/apis/workflow/schedule/backfillschedule","metadata":{"seo":{"title":"Backfill sessions for past schedule times","description":"Backfill sessions for past schedule times"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"backfillSchedule","name":"Backfill sessions for past schedule times","isWebhook":false,"pointer":"/paths/~1api~1schedules~1{id}~1backfill/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Backfill sessions for past schedule times","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"session id","required":true}],"pointer":"/paths/~1api~1schedules~1{id}~1backfill/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestScheduleBackfillRequest"}},"schemaId":"components/schemas/RestScheduleBackfillRequest","pointer":"/paths/~1api~1schedules~1{id}~1backfill/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/schedules/{id}/backfill","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestScheduleBackfillRequest"}},"responseCodes":["200"],"pointer":"/api/schedules/{id}/backfill","href":"schedule/backfillschedule","openApiOperationId":"backfillSchedule","summary":"Backfill sessions for past schedule times"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestScheduleBackfillRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestScheduleBackfillRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleAttemptCollection"}},"schemaId":"components/schemas/RestScheduleAttemptCollection"}],"pointer":"/paths/~1api~1schedules~1{id}~1backfill/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestScheduleAttemptCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleAttemptCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule/backfillschedule"}],"panels":[]}]},"httpPath":"/api/schedules/{id}/backfill"},{"label":"Disable scheduling of new sessions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/schedule/disableschedule","routeSlug":"/apis/workflow/schedule/disableschedule","metadata":{"seo":{"title":"Disable scheduling of new sessions","description":"Disable scheduling of new sessions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disableSchedule","name":"Disable scheduling of new sessions","isWebhook":false,"pointer":"/paths/~1api~1schedules~1{id}~1disable/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disable scheduling of new sessions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"session id","required":true}],"pointer":"/paths/~1api~1schedules~1{id}~1disable/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/schedules/{id}/disable","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/schedules/{id}/disable","href":"schedule/disableschedule","openApiOperationId":"disableSchedule","summary":"Disable scheduling of new sessions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleSummary"}},"schemaId":"components/schemas/RestScheduleSummary"}],"pointer":"/paths/~1api~1schedules~1{id}~1disable/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestScheduleSummary","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleSummary"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule/disableschedule"}],"panels":[]}]},"httpPath":"/api/schedules/{id}/disable"},{"label":"Re-enable disabled scheduling","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/schedule/enableschedule","routeSlug":"/apis/workflow/schedule/enableschedule","metadata":{"seo":{"title":"Re-enable disabled scheduling","description":"Re-enable disabled scheduling"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enableSchedule","name":"Re-enable disabled scheduling","isWebhook":false,"pointer":"/paths/~1api~1schedules~1{id}~1enable/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Re-enable disabled scheduling","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"session id","required":true}],"pointer":"/paths/~1api~1schedules~1{id}~1enable/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/RestScheduleEnableRequest"}},"schemaId":"components/schemas/RestScheduleEnableRequest","pointer":"/paths/~1api~1schedules~1{id}~1enable/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/schedules/{id}/enable","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/RestScheduleEnableRequest"}},"responseCodes":["200"],"pointer":"/api/schedules/{id}/enable","href":"schedule/enableschedule","openApiOperationId":"enableSchedule","summary":"Re-enable disabled scheduling"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestScheduleEnableRequest","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/RestScheduleEnableRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleSummary"}},"schemaId":"components/schemas/RestScheduleSummary"}],"pointer":"/paths/~1api~1schedules~1{id}~1enable/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestScheduleSummary","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleSummary"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule/enableschedule"}],"panels":[]}]},"httpPath":"/api/schedules/{id}/enable"},{"label":"Skip future sessions by count or time","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/schedule/skipschedule","routeSlug":"/apis/workflow/schedule/skipschedule","metadata":{"seo":{"title":"Skip future sessions by count or time","description":"Skip future sessions by count or time"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"skipSchedule","name":"Skip future sessions by count or time","isWebhook":false,"pointer":"/paths/~1api~1schedules~1{id}~1skip/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Skip future sessions by count or time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_599","description":"session id","required":true}],"pointer":"/paths/~1api~1schedules~1{id}~1skip/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestScheduleSkipRequest"}},"schemaId":"components/schemas/RestScheduleSkipRequest","pointer":"/paths/~1api~1schedules~1{id}~1skip/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/schedules/{id}/skip","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_599"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RestScheduleSkipRequest"}},"responseCodes":["200"],"pointer":"/api/schedules/{id}/skip","href":"schedule/skipschedule","openApiOperationId":"skipSchedule","summary":"Skip future sessions by count or time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"schemaId":"components/schemas/RestScheduleSkipRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RestScheduleSkipRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleSummary"}},"schemaId":"components/schemas/RestScheduleSummary"}],"pointer":"/paths/~1api~1schedules~1{id}~1skip/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestScheduleSummary","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestScheduleSummary"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule/skipschedule"}],"panels":[]}]},"httpPath":"/api/schedules/{id}/skip"}],"content":{"contentType":"group","meta":{"name":"Schedule"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedule","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/schedules","summary":"List schedules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule/getschedules","deprecated":false},{"title":"/api/schedules/{id}","summary":"Get a schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule/getschedule","deprecated":false},{"title":"/api/schedules/{id}/backfill","summary":"Backfill sessions for past schedule times","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schedule/backfillschedule","deprecated":false},{"title":"/api/schedules/{id}/disable","summary":"Disable scheduling of new sessions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schedule/disableschedule","deprecated":false},{"title":"/api/schedules/{id}/enable","summary":"Re-enable disabled scheduling","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schedule/enableschedule","deprecated":false},{"title":"/api/schedules/{id}/skip","summary":"Skip future sessions by count or time","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schedule/skipschedule","deprecated":false}]}]}]}]}},{"type":"group","label":"Session","link":"/apis/workflow/session","routeSlug":"/apis/workflow/session","items":[{"label":"List sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/session/getsessions","routeSlug":"/apis/workflow/session/getsessions","metadata":{"seo":{"title":"List sessions","description":"List sessions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSessions","name":"List sessions","isWebhook":false,"pointer":"/paths/~1api~1sessions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sessions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"last_id","in":"query","schemaId":"schema_598","description":"List sessions whose ID is smaller than this ID for pagination. Sessions are returned in descending order by ID."},{"name":"page_size","in":"query","schemaId":"schema_599","description":"number of sessions to return"}],"pointer":"/paths/~1api~1sessions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/sessions","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[{"name":"last_id","in":"query","schemaId":"schema_598"},{"name":"page_size","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/sessions","href":"session/getsessions","openApiOperationId":"getSessions","summary":"List sessions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionCollection"}},"schemaId":"components/schemas/RestSessionCollection"}],"pointer":"/paths/~1api~1sessions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSessionCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session/getsessions"}],"panels":[]}]},"httpPath":"/api/sessions"},{"label":"Get a session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/session/getsession","routeSlug":"/apis/workflow/session/getsession","metadata":{"seo":{"title":"Get a session","description":"Get a session"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSession","name":"Get a session","isWebhook":false,"pointer":"/paths/~1api~1sessions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_598","description":"session id","required":true}],"pointer":"/paths/~1api~1sessions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/sessions/{id}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/sessions/{id}","href":"session/getsession","openApiOperationId":"getSession","summary":"Get a session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSession"}},"schemaId":"components/schemas/RestSession"}],"pointer":"/paths/~1api~1sessions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSession","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSession"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session/getsession"}],"panels":[]}]},"httpPath":"/api/sessions/{id}"},{"label":"List attempts of a session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/session/getsessionattempts","routeSlug":"/apis/workflow/session/getsessionattempts","metadata":{"seo":{"title":"List attempts of a session","description":"List attempts of a session"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSessionAttempts","name":"List attempts of a session","isWebhook":false,"pointer":"/paths/~1api~1sessions~1{id}~1attempts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attempts of a session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_598","description":"session id","required":true}],"pointer":"/paths/~1api~1sessions~1{id}~1attempts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"last_id","in":"query","schemaId":"schema_598","description":"List attempts whose ID is smaller than this ID for pagination. Attempts are returned in descending order by ID."},{"name":"page_size","in":"query","schemaId":"schema_599","description":"number of attempts to return"}],"pointer":"/paths/~1api~1sessions~1{id}~1attempts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/sessions/{id}/attempts","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[{"name":"last_id","in":"query","schemaId":"schema_598"},{"name":"page_size","in":"query","schemaId":"schema_599"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/sessions/{id}/attempts","href":"session/getsessionattempts","openApiOperationId":"getSessionAttempts","summary":"List attempts of a session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptCollection"}},"schemaId":"components/schemas/RestSessionAttemptCollection"}],"pointer":"/paths/~1api~1sessions~1{id}~1attempts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestSessionAttemptCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestSessionAttemptCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session/getsessionattempts"}],"panels":[]}]},"httpPath":"/api/sessions/{id}/attempts"}],"content":{"contentType":"group","meta":{"name":"Session"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Session","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/sessions","summary":"List sessions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/session/getsessions","deprecated":false},{"title":"/api/sessions/{id}","summary":"Get a session","prefix":{"name":"get","color":"get"},"badges":[],"link":"/session/getsession","deprecated":false},{"title":"/api/sessions/{id}/attempts","summary":"List attempts of a session","prefix":{"name":"get","color":"get"},"badges":[],"link":"/session/getsessionattempts","deprecated":false}]}]}]}]}},{"type":"group","label":"Workflow","link":"/apis/workflow/workflow","routeSlug":"/apis/workflow/workflow","items":[{"label":"List workflows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/workflow/getworkflowdefinitions","routeSlug":"/apis/workflow/workflow/getworkflowdefinitions","metadata":{"seo":{"title":"List workflows","description":"List workflows"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowDefinitions","name":"List workflows","isWebhook":false,"pointer":"/paths/~1api~1workflows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List workflows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"last_id","in":"query","schemaId":"schema_598","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination. return workflows which id are greater than last_id with order 'asc', which id are less than the last_id with order 'desc'"},"children":[]}]}]}]},{"name":"count","in":"query","schemaId":"schema_599","description":"number of workflows to return"},{"name":"order","in":"query","schemaId":"schema_609","description":"Sort order. 'asc' or 'desc'"},{"name":"name_pattern","in":"query","schemaId":"schema_596","description":"name pattern to be partially matched"},{"name":"search_project_name","in":"query","schemaId":"schema_605","description":"name pattern to be partially matched"}],"pointer":"/paths/~1api~1workflows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/workflows","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[],"query":[{"name":"last_id","in":"query","schemaId":"schema_598"},{"name":"count","in":"query","schemaId":"schema_599"},{"name":"order","in":"query","schemaId":"schema_609"},{"name":"name_pattern","in":"query","schemaId":"schema_596"},{"name":"search_project_name","in":"query","schemaId":"schema_605"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/workflows","href":"workflow/getworkflowdefinitions","openApiOperationId":"getWorkflowDefinitions","summary":"List workflows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowDefinitionCollection"}},"schemaId":"components/schemas/RestWorkflowDefinitionCollection"}],"pointer":"/paths/~1api~1workflows/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestWorkflowDefinitionCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowDefinitionCollection"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow/getworkflowdefinitions"}],"panels":[]}]},"httpPath":"/api/workflows"},{"label":"Get a workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/workflow/getworkflowdefinition","routeSlug":"/apis/workflow/workflow/getworkflowdefinition","metadata":{"seo":{"title":"Get a workflow","description":"Get a workflow"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowDefinition","name":"Get a workflow","isWebhook":false,"pointer":"/paths/~1api~1workflows~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_598","description":"workflow id","required":true}],"pointer":"/paths/~1api~1workflows~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/workflows/{id}","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/workflows/{id}","href":"workflow/getworkflowdefinition","openApiOperationId":"getWorkflowDefinition","summary":"Get a workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowDefinition"}},"schemaId":"components/schemas/RestWorkflowDefinition"}],"pointer":"/paths/~1api~1workflows~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestWorkflowDefinition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowDefinition"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow/getworkflowdefinition"}],"panels":[]}]},"httpPath":"/api/workflows/{id}"},{"label":"Get truncated local time based on the time zone of a workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workflow/workflow/getworkflowtruncatedsessiontime","routeSlug":"/apis/workflow/workflow/getworkflowtruncatedsessiontime","metadata":{"seo":{"title":"Get truncated local time based on the time zone of a workflow","description":"Get truncated local time based on the time zone of a workflow"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkflowTruncatedSessionTime","name":"Get truncated local time based on the time zone of a workflow","isWebhook":false,"pointer":"/paths/~1api~1workflows~1{id}~1truncated_session_time/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get truncated local time based on the time zone of a workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"http","scheme":"TD1"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_598","description":"workflow id","required":true}],"pointer":"/paths/~1api~1workflows~1{id}~1truncated_session_time/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"session_time","in":"query","schemaId":"schema_596","description":"session time to be truncated","required":true},{"name":"mode","in":"query","schemaId":"schema_610","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"truncation mode - second, minute, hour, day, schedule, or next_schedule"},"children":[]}]}]}]}],"pointer":"/paths/~1api~1workflows~1{id}~1truncated_session_time/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/workflows/{id}/truncated_session_time","servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_598"}],"query":[{"name":"session_time","in":"query","required":true,"schemaId":"schema_596"},{"name":"mode","in":"query","schemaId":"schema_610"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/workflows/{id}/truncated_session_time","href":"workflow/getworkflowtruncatedsessiontime","openApiOperationId":"getWorkflowTruncatedSessionTime","summary":"Get truncated local time based on the time zone of a workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowSessionTime"}},"schemaId":"components/schemas/RestWorkflowSessionTime"}],"pointer":"/paths/~1api~1workflows~1{id}~1truncated_session_time/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RestWorkflowSessionTime","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RestWorkflowSessionTime"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workflow/getworkflowtruncatedsessiontime"}],"panels":[]}]},"httpPath":"/api/workflows/{id}/truncated_session_time"}],"content":{"contentType":"group","meta":{"name":"Workflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workflow","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/workflows","summary":"List workflows","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow/getworkflowdefinitions","deprecated":false},{"title":"/api/workflows/{id}","summary":"Get a workflow","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow/getworkflowdefinition","deprecated":false},{"title":"/api/workflows/{id}/truncated_session_time","summary":"Get truncated local time based on the time zone of a workflow","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workflow/getworkflowtruncatedsessiontime","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Attempt":{"id":"components/schemas/Attempt","kind":"json-schema","title":"Attempt","data":{"type":"object","description":"Attempts of session","properties":{"cancelRequested":{"type":"boolean","description":"true if kill requested"},"createdAt":{"type":"string","format":"date-time","description":"created time","example":"2023-08-18T06:52:33Z"},"done":{"type":"boolean","description":"true if the attempt finished"},"finishedAt":{"type":"string","format":"date-time","description":"finished time","example":"2023-08-18T06:52:33Z"},"id":{"type":"string","description":"attempt ID","example":"123456"},"params":{"type":"object","description":"passed parameters as JSON"},"poolId":{"type":"string","description":"ID of the pool to which this attempt is assigned.","example":"42"},"retryAttemptName":{"type":"string"},"status":{"type":"string","description":"The current status of the attempt.","enum":["blocked","queued","running","canceling","success","error","killed"],"example":"running"},"success":{"type":"boolean","description":"true if the attempt finished successfully"}},"required":["cancelRequested","createdAt","done","id","params","status","success"]}},"components/schemas/IdAndName":{"id":"components/schemas/IdAndName","kind":"json-schema","title":"IdAndName","data":{"type":"object","description":"Name and ID","properties":{"id":{"type":"string","description":"ID","example":"123456"},"name":{"type":"string","description":"name","example":"abcdefg"}},"required":["id","name"]}},"components/schemas/NameOptionalId":{"id":"components/schemas/NameOptionalId","kind":"json-schema","title":"NameOptionalId","data":{"type":"object","description":"Name and optional ID","properties":{"id":{"type":"string","description":"ID","example":"123456"},"name":{"type":"string","description":"name","example":"abcdefg"}},"required":["name"]}},"components/schemas/RestLogFileHandle":{"id":"components/schemas/RestLogFileHandle","kind":"json-schema","title":"RestLogFileHandle","data":{"type":"object","description":"A log file for a task","properties":{"agentId":{"type":"string","description":"internal information","example":"452660@ip-10-20-161-114"},"direct":{"type":"string","description":"path to download log directly","example":"https://digdag-server-development-eu01.s3.eu-central-1.amazonaws.com/log/2023-08-22/1.264c..."},"fileName":{"type":"string","description":"file name of log","example":"+wf1+t1@64e44ee12f7e43a0.452660@ip-10-20-161-114.log.gz"},"fileSize":{"type":"integer","format":"int64","description":"log size","example":65535},"fileTime":{"type":"string","format":"date-time","description":"file timestamp","example":"2023-08-18T06:52:33Z"},"fileTimestamp":{"type":"string","format":"date-time","description":"timestamp with sub second precision in ISO8601 format","example":"1970-01-23T04:56:01.23456Z"},"taskName":{"type":"string","description":"task name","example":"+wf1+t1"}},"required":["agentId","direct","fileName","fileSize","fileTime","fileTimestamp","taskName"]}},"components/schemas/RestLogFileHandleCollection":{"id":"components/schemas/RestLogFileHandleCollection","kind":"json-schema","title":"RestLogFileHandleCollection","data":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/RestLogFileHandle"}}}}},"components/schemas/RestPagination":{"id":"components/schemas/RestPagination","kind":"json-schema","title":"RestPagination","data":{"type":"object","description":"Pagination information","properties":{"nextPage":{"type":"string","description":"next page URL","example":"/api/console/projects?last_id=123&count=300"}}}},"components/schemas/RestPool":{"id":"components/schemas/RestPool","kind":"json-schema","title":"RestPool","data":{"type":"object","properties":{"concurrencyLimit":{"type":"integer","format":"int32","description":"Maximum number of concurrent attempts that can run in this pool. Total concurrency limit of all pools cannot exceed the account's concurrency limit.","example":10,"minimum":1},"default":{"type":"boolean","description":"Whether the pool is the default pool.","example":true},"id":{"type":"string","description":"ID of the pool.","example":"42","minimum":1},"name":{"type":"string","description":"Name of the pool. This name must be unique within the account.","example":"activation","maxLength":256,"minLength":1}},"required":["concurrencyLimit","default","id","name"]}},"components/schemas/RestPoolCollection":{"id":"components/schemas/RestPoolCollection","kind":"json-schema","title":"RestPoolCollection","data":{"type":"object","properties":{"pools":{"type":"array","description":"List of pools.","items":{"$ref":"#/components/schemas/RestPool"}}},"required":["pools"]}},"components/schemas/RestPoolCreateRequest":{"id":"components/schemas/RestPoolCreateRequest","kind":"json-schema","title":"RestPoolCreateRequest","data":{"type":"object","properties":{"concurrencyLimit":{"type":"integer","format":"int32","description":"Maximum number of concurrent attempts that can run in this pool. Total concurrency limit of all pools cannot exceed the account's concurrency limit.","example":10,"minimum":1},"name":{"type":"string","description":"Name of the pool. This name must be unique within the account.","example":"activation","maxLength":256,"minLength":1}},"required":["concurrencyLimit","name"]}},"components/schemas/RestPoolRule":{"id":"components/schemas/RestPoolRule","kind":"json-schema","title":"RestPoolRule","data":{"type":"object","properties":{"conditions":{"type":"array","description":"Conditions that must be met for the rule to assign an attempt to a pool. If multiple conditions are specified, all conditions must be met.","items":{"$ref":"#/components/schemas/RestPoolRuleCondition"},"maxItems":2,"minItems":1},"id":{"type":"string","description":"ID of the pool rule.","example":"42","minimum":1},"poolId":{"type":"string","description":"ID of the pool that this rule assigns attempts to.","example":"42","minimum":1},"priority":{"type":"integer","format":"int32","description":"Priority of the rule. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority.","example":10,"maximum":10000,"minimum":1}},"required":["conditions","id","poolId","priority"]}},"components/schemas/RestPoolRuleCollection":{"id":"components/schemas/RestPoolRuleCollection","kind":"json-schema","title":"RestPoolRuleCollection","data":{"type":"object","properties":{"poolRules":{"type":"array","description":"List of pool rules.","items":{"$ref":"#/components/schemas/RestPoolRule"}}},"required":["poolRules"]}},"components/schemas/RestPoolRuleCondition":{"id":"components/schemas/RestPoolRuleCondition","kind":"json-schema","title":"RestPoolRuleCondition","data":{"type":"object","anyOf":[{"$ref":"#/components/schemas/RestPoolRuleInvocationTypeCondition"},{"$ref":"#/components/schemas/RestPoolRuleProjectNameCondition"},{"$ref":"#/components/schemas/RestPoolRuleWorkflowNameCondition"},{"$ref":"#/components/schemas/RestPoolRuleWorkflowTypeCondition"}],"discriminator":{"mapping":{"invocation_type":"#/components/schemas/RestPoolRuleInvocationTypeCondition","project_name":"#/components/schemas/RestPoolRuleProjectNameCondition","workflow_name":"#/components/schemas/RestPoolRuleWorkflowNameCondition","workflow_type":"#/components/schemas/RestPoolRuleWorkflowTypeCondition"},"propertyName":"type"},"properties":{"type":{"type":"string"}},"required":["type"]}},"components/schemas/RestPoolRuleCreateRequest":{"id":"components/schemas/RestPoolRuleCreateRequest","kind":"json-schema","title":"RestPoolRuleCreateRequest","data":{"type":"object","properties":{"conditions":{"type":"array","description":"Conditions that must be met for the rule to assign an attempt to a pool. If multiple conditions are specified, all conditions must be met.","items":{"$ref":"#/components/schemas/RestPoolRuleCondition"},"maxItems":2,"minItems":1},"poolId":{"type":"string","description":"ID of the pool that this rule assigns attempts to.","example":"42","minimum":1},"priority":{"type":"integer","format":"int32","description":"Priority of the rule. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority.","example":10,"maximum":10000,"minimum":1}},"required":["conditions","poolId","priority"]}},"components/schemas/RestPoolRuleInvocationTypeCondition":{"id":"components/schemas/RestPoolRuleInvocationTypeCondition","kind":"json-schema","title":"RestPoolRuleInvocationTypeCondition","data":{"type":"object","properties":{"type":{"type":"string","description":"Type of the condition.","enum":["invocation_type","project_name","workflow_name","workflow_type"]},"values":{"type":"array","description":"Invocation types to match against. If multiple values are provided, the condition is met if the invocation type is one of the provided invocation types.","items":{"type":"string","description":"Invocation types to match against. If multiple values are provided, the condition is met if the invocation type is one of the provided invocation types.","enum":["on_demand","scheduled"]}}},"required":["type","values"]}},"components/schemas/RestPoolRuleProjectNameCondition":{"id":"components/schemas/RestPoolRuleProjectNameCondition","kind":"json-schema","title":"RestPoolRuleProjectNameCondition","data":{"type":"object","properties":{"operator":{"type":"string","description":"Operator to use for matching the project name.","enum":["starts_with"]},"type":{"type":"string","description":"Type of the condition.","enum":["invocation_type","project_name","workflow_name","workflow_type"]},"values":{"type":"array","description":"Values to match against the project name. If multiple values are provided, the condition is met if the project name matches one of the provided values.","items":{"type":"string","description":"Values to match against the project name. If multiple values are provided, the condition is met if the project name matches one of the provided values."}}},"required":["operator","type","values"]}},"components/schemas/RestPoolRuleUpdateRequest":{"id":"components/schemas/RestPoolRuleUpdateRequest","kind":"json-schema","title":"RestPoolRuleUpdateRequest","data":{"type":"object","properties":{"conditions":{"type":"array","description":"Conditions that must be met for the rule to assign an attempt to a pool. If multiple conditions are specified, all conditions must be met.","items":{"$ref":"#/components/schemas/RestPoolRuleCondition"},"maxItems":2,"minItems":1},"poolId":{"type":"string","description":"ID of the pool that this rule assigns attempts to.","example":"42","minimum":1},"priority":{"type":"integer","format":"int32","description":"Priority of the rule. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority.","example":10,"maximum":10000,"minimum":1}}}},"components/schemas/RestPoolRuleWorkflowNameCondition":{"id":"components/schemas/RestPoolRuleWorkflowNameCondition","kind":"json-schema","title":"RestPoolRuleWorkflowNameCondition","data":{"type":"object","properties":{"operator":{"type":"string","description":"Operator to use for matching the workflow name.","enum":["starts_with"]},"type":{"type":"string","description":"Type of the condition.","enum":["invocation_type","project_name","workflow_name","workflow_type"]},"values":{"type":"array","description":"Values to match against the workflow name. If multiple values are provided, the condition is met if the workflow name matches one of the provided values.","items":{"type":"string","description":"Values to match against the workflow name. If multiple values are provided, the condition is met if the workflow name matches one of the provided values."}}},"required":["operator","type","values"]}},"components/schemas/RestPoolRuleWorkflowTypeCondition":{"id":"components/schemas/RestPoolRuleWorkflowTypeCondition","kind":"json-schema","title":"RestPoolRuleWorkflowTypeCondition","data":{"type":"object","properties":{"type":{"type":"string","description":"Type of the condition.","enum":["invocation_type","project_name","workflow_name","workflow_type"]},"values":{"type":"array","description":"Workflow types to match against. If multiple values are provided, the condition is met if the workflow type is one of the provided workflow types.","items":{"type":"string","description":"Workflow types to match against. If multiple values are provided, the condition is met if the workflow type is one of the provided workflow types.","enum":["ab_test","audience","customer_journey","engage","predictive_scoring","realtime","segment_insights","syndication"]}}},"required":["type","values"]}},"components/schemas/RestPoolUpdateRequest":{"id":"components/schemas/RestPoolUpdateRequest","kind":"json-schema","title":"RestPoolUpdateRequest","data":{"type":"object","properties":{"concurrencyLimit":{"type":"integer","format":"int32","description":"Maximum number of concurrent attempts that can run in this pool. Total concurrency limit of all pools cannot exceed the account's concurrency limit.","example":10,"minimum":1},"name":{"type":"string","description":"Name of the pool. This name must be unique within the account.","example":"activation","maxLength":256,"minLength":1}}}},"components/schemas/RestProject":{"id":"components/schemas/RestProject","kind":"json-schema","title":"RestProject","data":{"type":"object","description":"Response of a project","properties":{"archiveMd5":{"type":"string","format":"byte","description":"MD5 of archive","example":"ZGRJdysyQ3VjZXI2UUN1c1ZhRXdDUT09"},"archiveType":{"type":"string","description":"archive type","example":"s3"},"createdAt":{"type":"string","format":"date-time","description":"created time","example":"2023-08-18T06:52:33Z"},"deletedAt":{"type":"string","format":"date-time","description":"deleted time","example":"2023-08-18T06:52:33Z"},"id":{"type":"string","description":"project ID","example":"123456"},"metadata":{"type":"array","description":"project metadata","items":{"$ref":"#/components/schemas/RestProjectMetadata"}},"name":{"type":"string","description":"project name","example":"project-a"},"revision":{"type":"string","description":"revision","example":"rev-20230101-1"},"updatedAt":{"type":"string","format":"date-time","description":"updated time","example":"2023-08-18T06:52:33Z"}},"required":["archiveType","createdAt","id","name","revision","updatedAt"]}},"components/schemas/RestProjectCollection":{"id":"components/schemas/RestProjectCollection","kind":"json-schema","title":"RestProjectCollection","data":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/RestProject"}}}}},"components/schemas/RestProjectMetadata":{"id":"components/schemas/RestProjectMetadata","kind":"json-schema","title":"RestProjectMetadata","data":{"type":"object","description":"project metadata","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"components/schemas/RestRevision":{"id":"components/schemas/RestRevision","kind":"json-schema","title":"RestRevision","data":{"type":"object","description":"Response of a revision","properties":{"archiveMd5":{"type":"string","format":"byte","description":"MD5 of archive","example":"ZGRJdysyQ3VjZXI2UUN1c1ZhRXdDUT09"},"archiveType":{"type":"string","description":"archive type","example":"s3"},"createdAt":{"type":"string","format":"date-time","description":"created time","example":"2023-08-18T06:52:33Z"},"revision":{"type":"string","description":"revision","example":"rev-20230101-1"},"userInfo":{"type":"object","description":"User information as json","example":"\"td\": {\"user\": {\"id\": 94,\"name\": \"Your name\",\"email\": \"example@treasure-data.com\"}"}},"required":["archiveType","revision"]}},"components/schemas/RestRevisionCollection":{"id":"components/schemas/RestRevisionCollection","kind":"json-schema","title":"RestRevisionCollection","data":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/RestPagination"},"revisions":{"type":"array","items":{"$ref":"#/components/schemas/RestRevision"}}}}},"components/schemas/RestSchedule":{"id":"components/schemas/RestSchedule","kind":"json-schema","title":"RestSchedule","data":{"type":"object","description":"Response of a schedule","properties":{"disabledAt":{"type":"string","format":"date-time","description":"disabled time","example":"2023-08-18T06:52:33Z"},"id":{"type":"string","description":"schedule ID","example":"123456"},"nextRunTime":{"type":"string","format":"date-time","description":"next run time","example":"2023-08-18T06:52:33Z"},"nextScheduleTime":{"type":"string","description":"next schedule time","example":"2022-12-31T23:59:00+00:00"},"project":{"$ref":"#/components/schemas/IdAndName"},"workflow":{"$ref":"#/components/schemas/IdAndName"}},"required":["id","nextRunTime","nextScheduleTime","project","workflow"]}},"components/schemas/RestScheduleAttemptCollection":{"id":"components/schemas/RestScheduleAttemptCollection","kind":"json-schema","title":"RestScheduleAttemptCollection","data":{"type":"object","description":"Response of a schedule with its attempts","properties":{"attempts":{"type":"array","description":"List of attempts","items":{"$ref":"#/components/schemas/RestSessionAttempt"}},"id":{"type":"string","description":"schedule ID","example":"123456"},"project":{"$ref":"#/components/schemas/IdAndName"},"workflow":{"$ref":"#/components/schemas/IdAndName"}},"required":["attempts","id","project","workflow"]}},"components/schemas/RestScheduleBackfillRequest":{"id":"components/schemas/RestScheduleBackfillRequest","kind":"json-schema","title":"RestScheduleBackfillRequest","data":{"type":"object","description":"Request body for backfill","properties":{"advanceSchedule":{"type":"boolean","description":"If true, advance nextScheduleTime/nextRunTime. When fromTime is not set, uses the current schedule's nextRunTime as starting point. Requires skipExisting to be true."},"attemptName":{"type":"string","description":"attempt name. Optional when skipExisting is true. Cannot be specified when advanceSchedule is true."},"count":{"type":"integer","format":"int32","description":"starts given number of sessions. run all sessions if not set."},"dryRun":{"type":"boolean","description":"dry run"},"fromTime":{"type":"string","format":"date-time","description":"backfill from","example":"2023-08-18T06:52:33Z"},"skipExisting":{"type":"boolean","description":"If true, silently skip sessions that already have attempts instead of returning 409 conflict error. Note that when count is set, skipped sessions are still counted towards the count."}},"required":["dryRun"]}},"components/schemas/RestScheduleCollection":{"id":"components/schemas/RestScheduleCollection","kind":"json-schema","title":"RestScheduleCollection","data":{"type":"object","properties":{"schedules":{"type":"array","items":{"$ref":"#/components/schemas/RestSchedule"}}}}},"components/schemas/RestScheduleEnableRequest":{"id":"components/schemas/RestScheduleEnableRequest","kind":"json-schema","title":"RestScheduleEnableRequest","data":{"type":"object","description":"Request body for enabling a schedule","properties":{"nextTime":{"type":"string","description":"time to skip","example":"2022-12-31T23:59:00+00:00"},"skipSchedule":{"type":"boolean","default":true,"description":"skip schedules"}}}},"components/schemas/RestScheduleSkipRequest":{"id":"components/schemas/RestScheduleSkipRequest","kind":"json-schema","title":"RestScheduleSkipRequest","data":{"type":"object","description":"Request body for skipping a schedule","properties":{"count":{"type":"integer","format":"int32","description":"skip given number of sessions. nextTime or (fromTime and count) are required."},"dryRun":{"type":"boolean","description":"dry run"},"fromTime":{"type":"string","format":"date-time","description":"skip before the time. nextTime or (fromTime and count) are required.","example":"2023-08-18T06:52:33Z"},"nextRunTime":{"type":"string","format":"date-time","description":"next run time","example":"2023-08-18T06:52:33Z"},"nextTime":{"type":"string","description":"next time. nextTime or (fromTime and count) are required.","example":"2022-12-31T23:59:00+00:00"}},"required":["dryRun"]}},"components/schemas/RestScheduleSummary":{"id":"components/schemas/RestScheduleSummary","kind":"json-schema","title":"RestScheduleSummary","data":{"type":"object","description":"Response of a schedule with summary","properties":{"createdAt":{"type":"string","format":"date-time","description":"created time","example":"2023-08-18T06:52:33Z"},"disabledAt":{"type":"string","format":"date-time","description":"disabled time","example":"2023-08-18T06:52:33Z"},"id":{"type":"string","description":"schedule ID","example":"123456"},"nextRunTime":{"type":"string","format":"date-time","description":"next run time","example":"2023-08-18T06:52:33Z"},"nextScheduleTime":{"type":"string","description":"next schedule time","example":"2022-12-31T23:59:00+00:00"},"project":{"$ref":"#/components/schemas/IdAndName"},"updatedAt":{"type":"string","format":"date-time","description":"updated time","example":"2023-08-18T06:52:33Z"},"workflow":{"$ref":"#/components/schemas/IdAndName"}},"required":["createdAt","id","nextRunTime","nextScheduleTime","project","updatedAt","workflow"]}},"components/schemas/RestSecretList":{"id":"components/schemas/RestSecretList","kind":"json-schema","title":"RestSecretList","data":{"type":"object","description":"Response of a secret","properties":{"secrets":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of RestSecretMetadata \"{ key: key1 }\""},"children":[]}]}]}],"example":"[{key: key1}, {key: key2}]","items":{"$ref":"#/components/schemas/RestSecretMetadata"}}},"required":["secrets"]}},"components/schemas/RestSecretMetadata":{"id":"components/schemas/RestSecretMetadata","kind":"json-schema","title":"RestSecretMetadata","data":{"type":"object","description":"Response of a secret","properties":{"key":{"type":"string","description":"key name","example":"td.apikey"}},"required":["key"]}},"components/schemas/RestSession":{"id":"components/schemas/RestSession","kind":"json-schema","title":"RestSession","data":{"type":"object","description":"Response of a session","properties":{"id":{"type":"string","description":"session ID","example":"123456"},"lastAttempt":{"$ref":"#/components/schemas/Attempt"},"project":{"$ref":"#/components/schemas/IdAndName"},"sessionTime":{"type":"string","description":"session time","example":"2022-12-31T23:59:00+00:00"},"sessionUuid":{"type":"string","format":"uuid"},"workflow":{"$ref":"#/components/schemas/NameOptionalId"}},"required":["id","project","sessionTime","workflow"]}},"components/schemas/RestSessionAttempt":{"id":"components/schemas/RestSessionAttempt","kind":"json-schema","title":"RestSessionAttempt","data":{"type":"object","description":"Response of an attempt","properties":{"cancelRequested":{"type":"boolean","description":"true if kill requested"},"createdAt":{"type":"string","format":"date-time","description":"created time","example":"2023-08-18T06:52:33Z"},"done":{"type":"boolean","description":"true if the attempt finished"},"finishedAt":{"type":"string","format":"date-time","description":"finished time","example":"2023-08-18T06:52:33Z"},"id":{"type":"string","description":"attempt ID","example":"123456"},"index":{"type":"integer","format":"int32","description":"index for multiple attempts","example":1},"params":{"type":"object","description":"passed parameters as JSON"},"poolId":{"type":"string","description":"ID of the pool to which this attempt is assigned.","example":"42"},"project":{"$ref":"#/components/schemas/IdAndName"},"retryAttemptName":{"type":"string","description":"attempt name for retry","example":"retry-12345"},"sessionId":{"type":"string","description":"session ID","example":"123456"},"sessionTime":{"type":"string","description":"session time","example":"2022-12-31T23:59:00+00:00"},"sessionUuid":{"type":"string","format":"uuid","description":"unique UUID of this session","example":"2b91a014-076e-4c6d-8b51-f4f91089cab2"},"status":{"type":"string","description":"The current status of the attempt.","enum":["blocked","queued","running","canceling","success","error","killed"],"example":"running"},"success":{"type":"boolean","description":"true if the attempt finished successfully"},"workflow":{"$ref":"#/components/schemas/NameOptionalId"}},"required":["cancelRequested","createdAt","done","id","index","params","project","retryAttemptName","sessionId","sessionTime","sessionUuid","status","success","workflow"]}},"components/schemas/RestSessionAttemptCollection":{"id":"components/schemas/RestSessionAttemptCollection","kind":"json-schema","title":"RestSessionAttemptCollection","data":{"type":"object","properties":{"attempts":{"type":"array","items":{"$ref":"#/components/schemas/RestSessionAttempt"}}}}},"components/schemas/RestSessionAttemptRequest":{"id":"components/schemas/RestSessionAttemptRequest","kind":"json-schema","title":"RestSessionAttemptRequest","data":{"type":"object","description":"Request body for new attempt","properties":{"allowQueueing":{"type":"boolean","description":"Whether an attempt can be queued when the maximum attempt limit is reached."},"params":{"type":"object","description":"parameters as json","example":{"key1":12345}},"projectName":{"type":"string","description":"project name. workflowId or (projectName and workflowName) are required","example":"project-a"},"resume":{"$ref":"#/components/schemas/Resume"},"retryAttemptName":{"type":"string","description":"unique attempt name for retry"},"sessionTime":{"type":"string","format":"date-time","description":"session time","example":"2023-08-17T18:56:24+09:00"},"workflowId":{"type":"string","description":"workflow ID. workflowId or (projectName and workflowName) are required","example":"123456"},"workflowName":{"type":"string","description":"workflow name. workflowId or (projectName and workflowName) are required","example":"workflow-a"}},"required":["params","sessionTime"]}},"components/schemas/RestSessionCollection":{"id":"components/schemas/RestSessionCollection","kind":"json-schema","title":"RestSessionCollection","data":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/RestSession"}}}}},"components/schemas/RestSetSecretRequest":{"id":"components/schemas/RestSetSecretRequest","kind":"json-schema","title":"RestSetSecretRequest","data":{"type":"object","description":"Request body to set a secret","properties":{"value":{"type":"string","description":"value of the secret","example":"TD1 12345..."}},"required":["value"]}},"components/schemas/RestTask":{"id":"components/schemas/RestTask","kind":"json-schema","title":"RestTask","data":{"type":"object","description":"Response of a task","properties":{"cancelRequested":{"type":"boolean","description":"true if kill requested"},"config":{"type":"object","description":"task definition","example":{"echo>":"test"}},"error":{"type":"object","description":"error information as JSON"},"exportParams":{"type":"object","description":"export parameters as JSON"},"fullName":{"type":"string","description":"full name of task","example":"+wf1+g1+t1"},"group":{"type":"boolean","description":"flag of group task or not"},"id":{"type":"string","description":"task ID","example":"123456"},"parentId":{"type":"string","description":"parent task ID","example":"123455"},"retryAt":{"type":"string","format":"date-time","description":"retried time","example":"2023-08-18T06:52:33Z"},"startedAt":{"type":"string","format":"date-time","description":"started time","example":"2023-08-18T06:52:33Z"},"state":{"type":"string","description":"state of task","example":"running"},"stateParams":{"type":"object","description":"state parameters as JSON"},"storeParams":{"type":"object","description":"store parameters as JSON"},"updatedAt":{"type":"string","format":"date-time","description":"updated time","example":"2023-08-18T06:52:33Z"},"upstreams":{"type":"array","description":"upstream tasks","example":["1547841"],"items":{"type":"string"}}},"required":["cancelRequested","config","error","exportParams","fullName","group","id","state","stateParams","storeParams","updatedAt","upstreams"]}},"components/schemas/RestTaskCollection":{"id":"components/schemas/RestTaskCollection","kind":"json-schema","title":"RestTaskCollection","data":{"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/RestTask"}}}}},"components/schemas/RestWorkflowDefinition":{"id":"components/schemas/RestWorkflowDefinition","kind":"json-schema","title":"RestWorkflowDefinition","data":{"type":"object","description":"Response of a workflow definition","properties":{"config":{"type":"object"},"id":{"type":"string","description":"workflow definition ID","example":"123456"},"name":{"type":"string","description":"workflow name","example":"wf-123"},"project":{"$ref":"#/components/schemas/IdAndName"},"revision":{"type":"string","description":"revision"},"timezone":{"type":"string","description":"timezone","example":"UTC"}},"required":["id","name","project","revision","timezone"]}},"components/schemas/RestWorkflowDefinitionCollection":{"id":"components/schemas/RestWorkflowDefinitionCollection","kind":"json-schema","title":"RestWorkflowDefinitionCollection","data":{"type":"object","properties":{"workflows":{"type":"array","items":{"$ref":"#/components/schemas/RestWorkflowDefinition"}}}}},"components/schemas/RestWorkflowSessionTime":{"id":"components/schemas/RestWorkflowSessionTime","kind":"json-schema","title":"RestWorkflowSessionTime","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response of truncated_session_time API of workflows"},"children":[]}]}]}],"properties":{"project":{"$ref":"#/components/schemas/IdAndName"},"revision":{"type":"string","description":"revision","example":"rev-20230101-1"},"sessionTime":{"type":"string","description":"session time","example":"2022-12-31T23:59:00+00:00"},"timezone":{"type":"string","description":"timezone","example":"UTC"}},"required":["project","revision","sessionTime","timezone"]}},"components/schemas/Resume":{"id":"components/schemas/Resume","kind":"json-schema","title":"Resume","data":{"type":"object","anyOf":[{"$ref":"#/components/schemas/ResumeFrom"},{"$ref":"#/components/schemas/ResumeFailed"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration to resume an attempt. {\"mode\": \"failed\", \"attemptId\": \"12345\"} or {\"mode\": \"from\", \"attemptId\": \"12345\", \"from\": \"+t1\"}"},"children":[]}]}]}],"discriminator":{"mapping":{"failed":"#/components/schemas/ResumeFailed","from":"#/components/schemas/ResumeFrom"},"propertyName":"mode"},"properties":{"mode":{"type":"string","description":"mode: \"from\" or \"failed\"","enum":["from","failed"],"example":"failed"}},"required":["attemptId","mode"]}},"components/schemas/ResumeFailed":{"id":"components/schemas/ResumeFailed","kind":"json-schema","title":"ResumeFailed","data":{"type":"object","description":"Configuration to resume an attempt from the failed task","properties":{"attemptId":{"type":"string","description":"attemptId","example":"12345"},"mode":{"type":"string","description":"\"failed\" (fixed value)","enum":["from","failed"]}},"required":["attemptId","mode"]}},"components/schemas/ResumeFrom":{"id":"components/schemas/ResumeFrom","kind":"json-schema","title":"ResumeFrom","data":{"type":"object","description":"Configuration to resume an attempt from the specified task","properties":{"attemptId":{"type":"string","description":"attemptId","example":"12345"},"from":{"type":"string","description":"the task name to resume"},"mode":{"type":"string","description":"\"from\" (fixed value)","enum":["from","failed"]}},"required":["attemptId","from","mode"]}},"schema_596":{"kind":"json-schema","data":{"type":"string"},"id":"schema_596"},"schema_597":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_597"},"schema_598":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_598"},"schema_599":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_599"},"schema_600":{"kind":"json-schema","data":{"type":"string","format":"byte"},"id":"schema_600"},"schema_601":{"kind":"json-schema","data":{"type":"integer","format":"int32","description":"ID of the rule"},"id":"schema_601"},"schema_602":{"kind":"json-schema","data":{"type":"integer","format":"int32","description":"ID of the pool."},"id":"schema_602"},"schema_603":{"kind":"json-schema","data":{"type":"integer","format":"int32","description":"ID of the pool"},"id":"schema_603"},"schema_604":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_604"},"schema_605":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_605"},"schema_606":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_606"},"schema_607":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_607"},"schema_608":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":100,"maximum":100,"minimum":0},"id":"schema_608"},"schema_609":{"kind":"json-schema","data":{"type":"string","default":"asc"},"id":"schema_609"},"schema_610":{"kind":"json-schema","data":{"type":"string","enum":["second","minute","hour","day","schedule","next_schedule"]},"id":"schema_610"}},"exampleStore":{},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"http","scheme":"TD1"}},"servers":[{"url":"https://api-workflow.treasuredata.com","description":"aws"},{"url":"https://api-workflow.treasuredata.co.jp","description":"aws-tokyo"},{"url":"https://api-workflow.eu01.treasuredata.com","description":"eu01"},{"url":"https://api-workflow.ap02.treasuredata.com","description":"ap02"},{"url":"https://api-workflow.ap03.treasuredata.com","description":"ap03"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/workflow.json?download"},{"url":"/_bundle/apis/workflow.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Treasure Workflow","description":"Treasure Workflow"}},"baseSlug":"/apis/workflow","routesMapping":{}}