Get Deployment Requests

• Requests

Returns the requests for the deployment.

Request

URI

GET

https://{api_host}/deployment/api/deployments/{deploymentId}/requests

COPY

Path Parameters

string

deploymentId

Required

Deployment ID

Query Parameters

boolean

deleted

Optional

Retrieves the soft-deleted requests that have not yet been completely deleted.

boolean

inprogressRequests

Optional

Retrieves the requests that are currently in-progress for a deployment. In case of a false value the param is ignored.

string

search

Optional

Given string should be part of a searchable field of a deployment level request

integer

page

Optional

Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer

size

Optional

Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array

sort

Optional

Constraints: default: createdAt,DESC

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

integer

$top

Optional

Number of records you want

$top example

1

integer

$skip

Optional

Number of records you want to skip

$skip example

1

string

$orderby

Optional

Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

---

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Hide Details

OK

Returns PageRequest of type(s) application/json

{
    "content": [
        {
            "actionId": "string",
            "approvedAt": "string",
            "blueprintId": "string",
            "cancelable": false,
            "catalogItemId": "string",
            "completedAt": "string",
            "completedTasks": 0,
            "createdAt": "string",
            "deploymentId": "string",
            "details": "string",
            "dismissed": false,
            "estimatedCompletionTime": "string",
            "id": "string",
            "initializedAt": "string",
            "inputs": {
                "inputs": {}
            },
            "name": "string",
            "outputs": {
                "outputs": {}
            },
            "requestedBy": "string",
            "resourceIds": [
                "string"
            ],
            "resources": [
                {
                    "description": "string",
                    "id": "string",
                    "name": "string",
                    "version": "string"
                }
            ],
            "status": "string",
            "totalTasks": 0,
            "updatedAt": "string"
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "paged": false,
        "sort": [
            {
                "ascending": false,
                "direction": "string",
                "ignoreCase": false,
                "nullHandling": "string",
                "property": "string"
            }
        ],
        "unpaged": false
    },
    "size": 0,
    "sort": [
        {
            "ascending": false,
            "direction": "string",
            "ignoreCase": false,
            "nullHandling": "string",
            "property": "string"
        }
    ],
    "totalElements": 0,
    "totalPages": 0
}

array of object

content

Optional

Represents deployment requests.

boolean

empty

Optional

empty

boolean

first

Optional

first

boolean

last

Optional

last

integer As int32 As int32

number

Optional

number

integer As int32 As int32

numberOfElements

Optional

numberOfElements

object

pageable

Optional

pageable

integer As int32 As int32

size

Optional

size

array of object

sort

Optional

sort

integer As int64 As int64

totalElements

Optional

totalElements

integer As int32 As int32

totalPages

Optional

totalPages

401

Hide Details

Unauthorized

Returns PageRequest of type(s) application/json

"PageRequest Object"

array of object

content

Optional

Represents deployment requests.

boolean

empty

Optional

empty

boolean

first

Optional

first

boolean

last

Optional

last

integer As int32 As int32

number

Optional

number

integer As int32 As int32

numberOfElements

Optional

numberOfElements

object

pageable

Optional

pageable

integer As int32 As int32

size

Optional

size

array of object

sort

Optional

sort

integer As int64 As int64

totalElements

Optional

totalElements

integer As int32 As int32

totalPages

Optional

totalPages

404

Hide Details

Not Found

Returns PageRequest of type(s) application/json

"PageRequest Object"

array of object

content

Optional

Represents deployment requests.

boolean

empty

Optional

empty

boolean

first

Optional

first

boolean

last

Optional

last

integer As int32 As int32

number

Optional

number

integer As int32 As int32

numberOfElements

Optional

numberOfElements

object

pageable

Optional

pageable

integer As int32 As int32

size

Optional

size

array of object

sort

Optional

sort

integer As int64 As int64

totalElements

Optional

totalElements

integer As int32 As int32

totalPages

Optional

totalPages

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/deployment/api/deployments/{deploymentId}/requests
                

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Requests Operations

GET

Get Deployment Requests

POST

Submit Deployment Action Request

GET

Get Request

POST

Action Deployment Request

GET

Get Request Events

GET

Get Event Logs

GET

Get Event Logs Content

GET

List Resource Requests

POST

Submit Resource Action Request