Get Catalog Resource Item

Get Catalog Resource Item

Retrieves a catalog item related to the container item.

Request
URI
GET
https://{api_host}/container-service/api/resources/containers/{id}/manage
COPY
Path Parameters
string
id
Required

id

Responses
200

OK with the CatalogResource

Returns catalogResource of type(s) */* 
{
    "hasChildren": false,
    "requestState": "string",
    "destroyDate": "string",
    "description": "string",
    "owners": [
        {
            "ref": "string",
            "tenantName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "expenseMonthToDate": {
        "amount": "number",
        "asOnDate": "string",
        "currencyCode": "string"
    },
    "parentResourceRef": {
        "id": "string",
        "label": "string"
    },
    "leaseForDisplay": {
        "unit": "string",
        "amount": 0
    },
    "lastUpdated": "string",
    "dateCreated": "string",
    "operations": [
        {
            "iconId": "string",
            "name": "string",
            "providerTypeId": "string",
            "description": "string",
            "hasForm": false,
            "id": "string",
            "bindingId": "string",
            "formScale": "string",
            "type": "string",
            "extensionId": "string"
        }
    ],
    "hasCosts": false,
    "requestId": "string",
    "resourceData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "id": "string",
    "iconId": "string",
    "costs": {
        "leaseRate": {
            "basis": {
                "unit": "string",
                "amount": 0
            }
        }
    },
    "providerBinding": {
        "providerRef": {
            "id": "string",
            "label": "string"
        },
        "bindingId": "string"
    },
    "hasLease": false,
    "resourceTypeRef": {
        "id": "string",
        "label": "string"
    },
    "organization": {
        "tenantRef": "string",
        "subtenantRef": "string",
        "tenantLabel": "string",
        "subtenantLabel": "string"
    },
    "name": "string",
    "lease": {
        "start": "string",
        "end": "string"
    },
    "catalogItem": {
        "id": "string",
        "label": "string"
    },
    "forms": {
        "catalogResourceInfoHidden": false,
        "requestFormScale": "string",
        "catalogRequestInfoHidden": false
    },
    "status": "string"
}
boolean
hasChildren
Optional

hasChildren

string
requestState
Optional

requestState

Possible values are : UNSUBMITTED, SUBMITTED, DELETED, PENDING_PRE_APPROVAL, PRE_APPROVAL_SEND_ERROR, PRE_APPROVED, PRE_REJECTED, PROVIDER_DELETION_ERROR, IN_PROGRESS, PROVIDER_SEND_ERROR, PROVIDER_COMPLETED, PROVIDER_FAILED, PENDING_POST_APPROVAL, POST_APPROVAL_SEND_ERROR, POST_APPROVED, POST_REJECTION_RECEIVED, ROLLBACK_ERROR, POST_REJECTED, SUCCESSFUL, PARTIALLY_SUCCESSFUL, FAILED, CANCELLING, CANCELLED,
string As date-time As date-time
destroyDate
Optional

destroyDate

string
description
Optional

description

array of catalogPrincipal
owners
Optional

owners

CostToDate
expenseMonthToDate
Optional

expenseMonthToDate

labelledReference
parentResourceRef
Optional

parentResourceRef

timeSpan
leaseForDisplay
Optional

leaseForDisplay

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
dateCreated
Optional

dateCreated

array of consumerResourceOperation
operations
Optional

operations

boolean
hasCosts
Optional

hasCosts

string
requestId
Optional

requestId

literal
costToDate
Optional

costToDate

literalMap
resourceData
Optional

resourceData

string
id
Optional

id

string
iconId
Optional

iconId

ResourceCosts
costs
Optional

costs

ProviderBinding
providerBinding
Optional

providerBinding

boolean
hasLease
Optional

hasLease

labelledReference
resourceTypeRef
Optional

resourceTypeRef

catalogOrganizationReference
organization
Optional

organization

string
name
Optional

name

ResourceLease
lease
Optional

lease

labelledReference
catalogItem
Optional

catalogItem

literal
totalCost
Optional

totalCost

ResourceForms
forms
Optional

forms

string
status
Optional

status

Possible values are : ACTIVE, ACTIVE_PENDING_COMPLETION, INITIALIZING, REJECTED, DELETED, DELETED_PENDING_DISMISS,

404

'Not Found' if no CatalogResourceItem with provided id

Operation doesn't return any data structure

On This Page
Container Operations
POST
Create Container Description
POST
Create Container Network Description
POST
Create Container Network State
POST
Create Container State
POST
Create Container Type
POST
Create Container Volume Description
POST
Create Container Volume State
PUT
Create Or Update Container Type
DELETE
Delete Container Description
DELETE
Delete Container Network Description
DELETE
Delete Container Network State
DELETE
Delete Container State
DELETE
Delete Container Type
DELETE
Delete Container Volume Description
DELETE
Delete Container Volume State
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Container Description
GET
Get Container Network Description
GET
Get Container Network State
GET
Get Container State
GET
Get Container Stats
GET
Get Container Stats
GET
Get Container Type
GET
Get Container Volume Description
GET
Get Container Volume State
GET
List Container Description
GET
List Container Network Description
GET
List Container Network State
GET
List Container State
GET
List Container Types
GET
List Container Volume Description
GET
List Container Volume State
PATCH
Patch Container Description
PATCH
Patch Container Network Description
PATCH
Patch Container Network State
PATCH
Patch Container State
PATCH
Patch Container Volume Description
PATCH
Patch Container Volume State
POST
Publishes A container description To catalog.
PUT
Update Container Description
PUT
Update Container Host Spec
PUT
Update Container Network Description
PUT
Update Container Network State
PUT
Update Container State
PUT
Update Container Volume Description
PUT
Update Container Volume State
PUT
Update PKS Endpoint Spec