Insights - Get Cascade Delete Job Details

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Get a cascade delete job for specified insight.

GET {endpoint}/insights/cascade-delete/{jobId}?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
jobId	path	True	string	Id of the job.
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.

Responses

Name	Type	Description
200 OK	CascadeDeleteJob	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

Insights_GetCascadeDeleteJobDetails

Sample request

HTTP

GET {endpoint}/insights/cascade-delete/JOB123?api-version=2023-11-01-preview

Sample response

Status code:

200

{
  "id": "JOB123",
  "status": "Succeeded",
  "message": "Job completed successfully.",
  "durationInSeconds": 14.7977857,
  "createdDateTime": "2021-04-19T11:31:20Z",
  "lastActionDateTime": "2021-04-19T11:31:34Z",
  "startTime": "2021-04-19T11:31:19Z",
  "endTime": "2021-04-19T11:31:34Z",
  "partyId": "PARTY123",
  "resourceId": "farmId",
  "resourceType": "Farm"
}

Definitions

Name	Description
CascadeDeleteJob	Schema of cascade delete job.
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.
JobStatus	Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

CascadeDeleteJob

Object

Schema of cascade delete job.

Name	Type	Description
createdDateTime	string (date-time)	Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
durationInSeconds	number (double)	Duration of the job in seconds.
endTime	string (date-time)	Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
errorCode	string	Error Code when job failed.
id	string	Unique job id.
lastActionDateTime	string (date-time)	Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
message	string	Status message to capture more details of the job.
partyId	string minLength: 1	Party Id.
resourceId	string minLength: 1	The id of the resource.
resourceType	string minLength: 1	The type of the resource.
startTime	string (date-time)	Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
status	JobStatus	Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

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.

JobStatus

Enumeration

Status of the job. Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

Value	Description
Waiting
Running
Succeeded
Failed
Cancelled