Solution Inference - Cancel

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Cancels a job for given solution id.

POST {endpoint}/solutions/{solutionId}:cancel?api-version=2023-11-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net
solutionId	path	True	string pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z0-9]{3,100}$	Id of solution for which job is to be cancelled.
api-version	query	True	string	The requested API version

Request Header

Name	Required	Type	Description
Authorization	True	string	Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Request Body

Name	Required	Type	Description
requestPath	True	string minLength: 1	RequestPath containing the api-version, query parameters and path route to be called for partner request. Expected format is "/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1". Not following this format may result into validation errors.
partnerRequestBody			Api input parameters required by partner to trigger/cancel job request.
partnerRequestHeaders		object	Additional Headers sent to partner.

Responses

Name	Type	Description
200 OK		Success
Other Status Codes	ErrorResponse	Error Headers x-ms-error-code: string

Security

Authorization

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Type: apiKey
In: header

Examples

SolutionInference_Cancel

Sample request

HTTP

POST {endpoint}/solutions/solution.solutionId:cancel?api-version=2023-11-01-preview

{
  "requestPath": "string"
}

Sample response

Status code:

200

{
  "requestPath": "string"
}

Definitions

Name	Description
Error	An error from the Azure AgPlatform service.
ErrorResponse	An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
SolutionInference	SolutionInference request model.

Error

Object

An error from the Azure AgPlatform service.

Name	Type	Description
code	string minLength: 1	Server-defined set of error codes.
details	Error[]	Array of details about specific errors that led to this reported error.
innererror	InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
message	string minLength: 1	Human-readable representation of the error.
target	string	Target of the error.

ErrorResponse

Object

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

Name	Type	Description
error	Error	An error from the Azure AgPlatform service.
traceId	string	Unique trace Id.

InnerError

Object

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Name	Type	Description
code	string	Specific error code than was provided by the containing error.
innererror	InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

SolutionInference

Object

SolutionInference request model.

Name	Type	Description
partnerRequestBody		Api input parameters required by partner to trigger/cancel job request.
partnerRequestHeaders	object	Additional Headers sent to partner.
requestPath	string minLength: 1	RequestPath containing the api-version, query parameters and path route to be called for partner request. Expected format is "/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1". Not following this format may result into validation errors.