Cancel a submitted query

PATCH 
/query/:queryId/cancel

Request the cancellation of a submitted query.

caution

Due to the distributed nature of the Query API service, it may not be possible to cancel a query that is already being processed. In this case, users should request a new query - see: POST /query endpoint documentation.

Cancellation of a submitted query (identified by :queryId) can only be performed by the user who originally submitted it.

Required scope(s): [data.chf:query, data.indices:query]

Request

Path Parameters

queryId stringrequired
Unique identifier of the query.
Example: 4DDC21D9-E30C-458A-80E2-642CA3238541

application/json

Body

required

cancel boolean

Should always be set to True.

Responses

202

Accepted - request to cancel query has been submitted.

application/json

Schema

Schema

queryId string

Unique identifier of the query.

status boolean

Current status of the query if cancelled or not.

message string

Response message when cancel request submitted.

error string

Details of the error if query cancel request failed.

Example (from schema)

{
  "queryId": "4DDC21D9-E30C-458A-80E2-642CA3238541",
  "status": true,
  "message": "CANCELLED",
  "error": "string"
}

401

Unauthorized - invalid access token or requesting user is not the original query submitter.

application/json

Schema

Schema

message string

Details of the error.

Example (from schema)

{
  "message": "string"
}

403

Forbidden - invalid access token or user not authorised.

application/json

Schema

Schema

message string

Details of the error.

Example (from schema)

{
  "message": "string"
}

404

Query not found

application/json

Schema

Schema

message string

Details of the error.

Example (from schema)

{
  "message": "string"
}

500

Internal server error - contact tech@gardin.ag for further assistance.

application/json

Schema

Schema

message string

Details of the error.

Example (from schema)

{
  "message": "string"
}

Loading...