Publish Catalog Item

Publishes a catalog item and shares it with the members of a specified project.

Request

URI

POST

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

COPY

Request Body

OneOf

This class requires at least one of the following:

BlueprintCatalogItemPublishRequest

VmImageCatalogItemPublishRequest

VroWorkflowCatalogItemPublishRequest

Authentication/Authorization

This operation uses the following authentication methods.

bearerAuth

Responses

200

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

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

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

Information specific to the content type.

object

type

Required

Optional affected resources details to which the request applies to

400

Invalid request - bad data

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

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

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

Information specific to the content type.

object

type

Required

Optional affected resources details to which the request applies to

401

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

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

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

Information specific to the content type.

object

type

Required

Optional affected resources details to which the request applies to

403

Forbidden

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

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

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

Information specific to the content type.

object

type

Required

Optional affected resources details to which the request applies to

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/catalog/api/items:publish

On This Page

Description

Request

Request Body

Authentication/Authorization

Response

200 Response Body

Errors

Catalog Items Operations

Get Catalog Filter By Id

POST

Assign Catalog Item To Projects

POST

Republish Catalog Item

POST

Unpublish Catalog Item

GET

Get Catalog Item

GET

Geta Catalog Item Form

POST

Request Catalog Item Instances

Geta Catalog Item Version Form

POST

Publish Catalog Item