658339767b
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
50 lines
1.3 KiB
YAML
50 lines
1.3 KiB
YAML
post:
|
||
operationId: PostBatchJobsBatchJobCancel
|
||
summary: Cancel a Batch Job
|
||
description: >-
|
||
Mark a batch job as canceled. When a batch job is canceled, the processing
|
||
of the batch job doesn’t automatically stop.
|
||
x-authenticated: true
|
||
parameters:
|
||
- in: path
|
||
name: id
|
||
required: true
|
||
description: The ID of the batch job.
|
||
schema:
|
||
type: string
|
||
x-codegen:
|
||
method: cancel
|
||
x-codeSamples:
|
||
- lang: JavaScript
|
||
label: JS Client
|
||
source:
|
||
$ref: ../code_samples/JavaScript/admin_batch-jobs_{id}_cancel/post.js
|
||
- lang: Shell
|
||
label: cURL
|
||
source:
|
||
$ref: ../code_samples/Shell/admin_batch-jobs_{id}_cancel/post.sh
|
||
security:
|
||
- api_token: []
|
||
- cookie_auth: []
|
||
tags:
|
||
- Batch Jobs
|
||
responses:
|
||
'200':
|
||
description: OK
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: ../components/schemas/AdminBatchJobRes.yaml
|
||
'400':
|
||
$ref: ../components/responses/400_error.yaml
|
||
'401':
|
||
$ref: ../components/responses/unauthorized.yaml
|
||
'404':
|
||
$ref: ../components/responses/not_found_error.yaml
|
||
'409':
|
||
$ref: ../components/responses/invalid_state_error.yaml
|
||
'422':
|
||
$ref: ../components/responses/invalid_request_error.yaml
|
||
'500':
|
||
$ref: ../components/responses/500_error.yaml
|