Sign in

v7

latestSwagger 2.02026-07-13186148695.0 KB
Farms

Create a cascade delete job for specified farm.

put/farms/cascade-delete/{jobId}

Path parameters

jobIdstring required

Job ID supplied by end user.

Query parameters

partyIdstring required

ID of the associated party.

farmIdstring required

ID of the farm to be deleted.

api-versionstring required

The requested API version

Response

Accepted

partyIdstring required

Party Id.

resourceIdstring required

The id of the resource.

resourceTypestring required

The type of the resource.

idstring

Unique job id.

status'Waiting' | 'Running' | 'Succeeded' | 'Failed' | 'Cancelled'

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

durationInSecondsnumber double

Duration of the job in seconds.

messagestring

Status message to capture more details of the job.

errorCodestring

Error Code when job failed.

createdDateTimestring date-time

Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.

lastActionDateTimestring date-time

Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.

startTimestring date-time

Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.

endTimestring date-time

Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.