Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchSteps

Searches for steps.

Request Syntax


POST /2023-10-12/farms/farmId/search/steps HTTP/1.1 Content-type: application/json { "filterExpressions": { "filters": [ { ... } ], "operator": "string" }, "itemOffset": number, "jobId": "string", "pageSize": number, "queueIds": [ "string" ], "sortExpressions": [ { ... } ] }

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID to use for the step search.

Pattern: farm-[0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

filterExpressions

The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().

Type: SearchGroupedFilterExpressions object

Required: No

itemOffset

Defines how far into the scrollable list to start the return of results.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000.

Required: Yes

jobId

The job ID to use in the step search.

Type: String

Pattern: job-[0-9a-f]{32}

Required: No

pageSize

Specifies the number of items per page for the resource.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

queueIds

The queue IDs in the step search.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: queue-[0-9a-f]{32}

Required: Yes

sortExpressions

The search terms for a resource.

Type: Array of SearchSortExpression objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: No

Response Syntax


HTTP/1.1 200 Content-type: application/json { "nextItemOffset": number, "steps": [ { "createdAt": "string", "createdBy": "string", "endedAt": "string", "jobId": "string", "lifecycleStatus": "string", "lifecycleStatusMessage": "string", "name": "string", "parameterSpace": { "combination": "string", "parameters": [ { "name": "string", "type": "string" } ] }, "queueId": "string", "startedAt": "string", "stepId": "string", "targetTaskRunStatus": "string", "taskFailureRetryCount": number, "taskRunStatus": "string", "taskRunStatusCounts": { "string" : number }, "updatedAt": "string", "updatedBy": "string" } ], "totalResults": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextItemOffset

The next incremental starting point after the defined itemOffset.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000.

steps

The steps in the search.

Type: Array of StepSearchSummary objects

totalResults

The total number of results in the search.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

context: Information about the resources in use when the exception was thrown.

HTTP Status Code: 403

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

retryAfterSeconds: The number of seconds a client should wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

context: Information about the resources in use when the exception was thrown.
resourceId: The identifier of the resource that couldn't be found.
resourceType: The type of the resource that couldn't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

context: Information about the resources in use when the exception was thrown.
quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service that is being throttled.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

context: Information about the resources in use when the exception was thrown.
fieldList: A list of fields that failed validation.
reason: The reason that the request failed validation.

HTTP Status Code: 400