Get Api

Get Api

Deprecated since version 7.5. Retrieves the resource (using a domain object targeted for direct REST API users) by its unique identifier. It retrieves a specific resource with its up to date Provider Data by its: unique id.

This API is very similar to /api/consumer/resources/{id}, with only difference being that the ConsumerResource objects are transformed into the more API-friendly ConsumerResourceView objects

Request
URI
GET
https://{api_host}/catalog-service/api/consumer/resourceViews/{id}
COPY
Path Parameters
string
id
Required

A unique identifier for the resource

Responses
200

successful operation

Returns CatalogResourceView of type(s) */* 
{
    "iconId": "string",
    "costs": {
        "leaseRate": {
            "basis": {
                "unit": "string",
                "amount": 0
            }
        }
    },
    "resourceId": "string",
    "hasChildren": false,
    "requestState": "string",
    "description": "string",
    "owners": [
        "string"
    ],
    "parentResourceId": "string",
    "catalogItemId": "string",
    "lastUpdated": "string",
    "dateCreated": "string",
    "requestId": "string",
    "businessGroupId": "string",
    "name": "string",
    "tenantId": "string",
    "links": [
        {
            "rel": "string",
            "href": "string"
        }
    ],
    "lease": {
        "start": "string",
        "end": "string"
    },
    "catalogItemLabel": "string",
    "status": "string",
    "resourceType": "string"
}
string
iconId
Optional

iconId

ResourceCosts
costs
Optional

costs

string
resourceId
Optional

resourceId

object
data
Optional

data

boolean
hasChildren
Optional

hasChildren

string
requestState
Optional

requestState

Possible values are : UNSUBMITTED, SUBMITTED, DELETED, PENDING_PRE_APPROVAL, CANCELLING, CANCELLED, 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,
string
description
Optional

description

array of string
owners
Optional

owners

string
parentResourceId
Optional

parentResourceId

string
catalogItemId
Optional

catalogItemId

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
dateCreated
Optional

dateCreated

string
requestId
Optional

requestId

literal
costToDate
Optional

costToDate

string
businessGroupId
Optional

businessGroupId

string
name
Optional

name

string
tenantId
Optional

tenantId

array of Link
links
Optional

links

ResourceLease
lease
Optional

lease

string
catalogItemLabel
Optional

catalogItemLabel

literal
totalCost
Optional

totalCost

string
status
Optional

status

string
resourceType
Optional

resourceType


On This Page
Api Operations
GET
Get Api