Delete a parse job

DELETE

/v1/parse-jobs/{job_id}

curl --request DELETE \
  --url http://127.0.0.1:8000/v1/parse-jobs/example

• Default local ParseHawk API

Delete a terminal job immediately, or return 202 while cancellation completes for a running job.

Parameters

Path Parameters

job_id

required

Job Id

Immutable parse job identifier.

string

Immutable parse job identifier.

Responses

202

Cancellation and deletion accepted.

204

Successful Response

404

The requested ParseHawk resource does not exist.

Media typeapplication/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

code

Any of:

string

string

null

null

detail

required

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": [
    {}
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

500

Unexpected server error.

Media typeapplication/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

code

Any of:

string

string

null

null

detail

required

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": [
    {}
  ]
}

503

Persistence is temporarily busy and the request can be retried.

Media typeapplication/json

ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object

code

Any of:

string

string

null

null

detail

required

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

Example^generated

{
  "code": "example",
  "detail": [
    {}
  ]
}