Get Catalog Item

• Catalog Items

Returns the catalog item with the specified ID.

Request

URI

GET

https://{api_host}/catalog/api/items/{id}

COPY

Path Parameters

string

id

Required

Catalog item ID

Query Parameters

boolean

expandProjects

Optional

Retrieves the 'projects' field of the catalog item

string

expand

Optional

The expanded details of the requested comma separated objects.

Possible values are : spec, user,

---

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Hide Details

OK

Returns CatalogItem of type(s) application/json

{
    "additionalActions": [
        {
            "bundleKey": "string",
            "id": "string",
            "name": "string"
        }
    ],
    "bulkRequestLimit": 0,
    "createdAt": "string",
    "createdBy": "string",
    "creator": {
        "email": "string",
        "firstname": "string",
        "id": "string",
        "lastname": "string",
        "type": "string"
    },
    "description": "string",
    "externalId": "string",
    "formId": "string",
    "global": false,
    "iconId": "string",
    "id": "string",
    "isRequestable": false,
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "lastUpdater": {
        "email": "string",
        "firstname": "string",
        "id": "string",
        "lastname": "string",
        "type": "string"
    },
    "name": "string",
    "organizationSharings": [
        {
            "orgId": "string"
        }
    ],
    "projectIds": [
        "string"
    ],
    "projects": [
        {
            "description": "string",
            "id": "string",
            "name": "string",
            "version": "string"
        }
    ],
    "schema": {
        "$data": "string",
        "$dynamicDefault": "string",
        "$ref": "string",
        "additionalProperties": false,
        "allOf": [
            "JsonSchemaImpl Object"
        ],
        "anyOf": [
            "JsonSchemaImpl Object"
        ],
        "const": {},
        "default": {},
        "description": "string",
        "encrypted": false,
        "enum": [
            {}
        ],
        "format": "string",
        "formatMaximum": "string",
        "formatMinimum": "string",
        "items": "ObjectOrListJsonSchemaImpl Object",
        "maxItems": 0,
        "maxLength": 0,
        "maxProperties": 0,
        "maximum": "number",
        "minItems": 0,
        "minLength": 0,
        "minProperties": 0,
        "minimum": "number",
        "not": "JsonSchemaImpl Object",
        "oneOf": [
            "JsonSchemaImpl Object"
        ],
        "pattern": "string",
        "patternProperties": {
            "patternProperties": "JsonSchemaImpl Object"
        },
        "properties": {
            "properties": "JsonSchemaImpl Object"
        },
        "readOnly": false,
        "required": [
            "string"
        ],
        "title": "string",
        "type": "string",
        "uniqueItems": false,
        "writeOnly": false
    },
    "sourceId": "string",
    "sourceName": "string",
    "sourceProjectId": "string",
    "spec": {},
    "type": {
        "description": "string",
        "id": "string",
        "name": "string",
        "version": "string"
    }
}

array of object

additionalActions

Optional

A List of available actions for the catalog item, e.g Unpublish, Edit Projects

integer As int32 As int32

bulkRequestLimit

Optional

Max number of instances that can be requested at a time

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

object

creator

Optional

Expanded policy last updater details

string

description

Optional

CatalogItem description

string

externalId

Optional

External ID

string

formId

Optional

Form ID

boolean

global

Optional

Indicates whether the catalog item can be assigned to other projects

string As uuid As uuid

iconId

Optional

Icon ID

string As uuid As uuid

id

Required

CatalogItem id

boolean

isRequestable

Optional

Boolean flag to indicate whether the catalog item is requestable or not

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

object

lastUpdater

Optional

Expanded policy last updater details

string

name

Required

CatalogItem name

array of object

organizationSharings

Optional

List of organizations that the catalog item is being shared with.

array of string

projectIds

Required

Associated project IDs that can be used for requesting

array of object

projects

Optional

Associated projects that can be used for requesting

object

schema

Optional

Schema describing a policy object of this type

string As uuid As uuid

sourceId

Optional

LibraryItem source ID.

string

sourceName

Optional

LibraryItem source name.

string

sourceProjectId

Optional

Project ID with which the catalog item was associated when created

object

spec

Optional

Publish spec for the catalog item

object

type

Required

Optional affected resources details to which the request applies to

401

Hide Details

Unauthorized

Returns CatalogItem of type(s) application/json

"CatalogItem Object"

array of object

additionalActions

Optional

A List of available actions for the catalog item, e.g Unpublish, Edit Projects

integer As int32 As int32

bulkRequestLimit

Optional

Max number of instances that can be requested at a time

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

object

creator

Optional

Expanded policy last updater details

string

description

Optional

CatalogItem description

string

externalId

Optional

External ID

string

formId

Optional

Form ID

boolean

global

Optional

Indicates whether the catalog item can be assigned to other projects

string As uuid As uuid

iconId

Optional

Icon ID

string As uuid As uuid

id

Required

CatalogItem id

boolean

isRequestable

Optional

Boolean flag to indicate whether the catalog item is requestable or not

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

object

lastUpdater

Optional

Expanded policy last updater details

string

name

Required

CatalogItem name

array of object

organizationSharings

Optional

List of organizations that the catalog item is being shared with.

array of string

projectIds

Required

Associated project IDs that can be used for requesting

array of object

projects

Optional

Associated projects that can be used for requesting

object

schema

Optional

Schema describing a policy object of this type

string As uuid As uuid

sourceId

Optional

LibraryItem source ID.

string

sourceName

Optional

LibraryItem source name.

string

sourceProjectId

Optional

Project ID with which the catalog item was associated when created

object

spec

Optional

Publish spec for the catalog item

object

type

Required

Optional affected resources details to which the request applies to

404

Hide Details

Not Found

Returns CatalogItem of type(s) application/json

"CatalogItem Object"

array of object

additionalActions

Optional

A List of available actions for the catalog item, e.g Unpublish, Edit Projects

integer As int32 As int32

bulkRequestLimit

Optional

Max number of instances that can be requested at a time

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

object

creator

Optional

Expanded policy last updater details

string

description

Optional

CatalogItem description

string

externalId

Optional

External ID

string

formId

Optional

Form ID

boolean

global

Optional

Indicates whether the catalog item can be assigned to other projects

string As uuid As uuid

iconId

Optional

Icon ID

string As uuid As uuid

id

Required

CatalogItem id

boolean

isRequestable

Optional

Boolean flag to indicate whether the catalog item is requestable or not

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

object

lastUpdater

Optional

Expanded policy last updater details

string

name

Required

CatalogItem name

array of object

organizationSharings

Optional

List of organizations that the catalog item is being shared with.

array of string

projectIds

Required

Associated project IDs that can be used for requesting

array of object

projects

Optional

Associated projects that can be used for requesting

object

schema

Optional

Schema describing a policy object of this type

string As uuid As uuid

sourceId

Optional

LibraryItem source ID.

string

sourceName

Optional

LibraryItem source name.

string

sourceProjectId

Optional

Project ID with which the catalog item was associated when created

object

spec

Optional

Publish spec for the catalog item

object

type

Required

Optional affected resources details to which the request applies to

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/catalog/api/items/{id}
                

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Catalog Items Operations

GET

Get Catalog Items

GET

Get Catalog Item

POST

Request Catalog Item Instances 1

POST

Submit Upfront Price Request For Catalog Item

GET

Get Upfront Price Response For Catalog Item

GET

Get Versions

GET

Get Version By Id