Get Deployment Resources

Get Deployment Resources

Returns a paginated list of resources corresponding to the deployment with the supplied ID.

Request
URI
GET
https://{api_host}/deployment/api/deployments/{deploymentId}/resources
COPY
Path Parameters
string
deploymentId
Required

Deployment ID

Query Parameters
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: type, name,ASC

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

string of array
names
Optional

Results must have exactly these resource names.

string of array
resourceTypes
Optional

A comma-separated list. Results must be associated with one of these resourceType Names.

string of array
tags
Optional

A comma-separated list. Results must be associated with one of these tags

string of array
expand
Optional

The expanded details of the requested comma separated objects. Ex. currentRequest

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.

string
$filter
Optional

A subset of records that satisfy the given predicate expression

$filter example
startswith(name, 'Act'), toupper(name) eq 'ACTIVATE', substringof('renameVM', name), name eq 'ABCD'

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageDeploymentResource of type(s) application/json
{
    "content": [
        {
            "createdAt": "string",
            "currentRequest": {
                "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"
            },
            "dependsOn": [
                "string"
            ],
            "description": "string",
            "expense": {
                "additionalExpense": "number",
                "code": "string",
                "computeExpense": "number",
                "lastUpdatedTime": "string",
                "message": "string",
                "networkExpense": "number",
                "storageExpense": "number",
                "totalExpense": "number",
                "unit": "string"
            },
            "id": "string",
            "inprogressRequests": {},
            "name": "string",
            "origin": "string",
            "properties": {
                "properties": {}
            },
            "state": "string",
            "syncStatus": "string",
            "type": "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

A resource part of a deployment.

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

Unauthorized

Returns PageDeploymentResource of type(s) application/json
"PageDeploymentResource Object"
array of object
content
Optional

A resource part of a deployment.

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

Not Found

Returns PageDeploymentResource of type(s) application/json
"PageDeploymentResource Object"
array of object
content
Optional

A resource part of a deployment.

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}/resources