REST API Reference for Launch Cloud Service

Get all catalogs

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog

Request

Query Parameters

@baseType: string

The base class type of the resource.
@schemaLocation: string

The link to the location where the scheme of the resource is defined.
@type: string

The class type of the resource.
catalogType: string

Catalog Type
description: string

The description of the resource.
eligibleForProject: string

Project Id
fields: string

The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
id: string

The unique identifier of the resource item.
lifecycleStatus: string

The current lifecycle status of the resource.
limit: integer

The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
name: string

The name of the resource.
offset: string

The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
version: string

The current version of the resource.
whereUsed: string

enrich objects with usedBy information

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: array

Show Source

Array of: CatalogOracle

Title: CatalogOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CatalogOracle"
    }
}

Nested Schema : CatalogOracle

Title: CatalogOracle

Match All

Show Source

object Catalog

Title: Catalog

Discriminator: { "propertyName":"@type", "mapping":{ "Catalog":"#/components/schemas/Catalog", "CatalogOracle":"#/components/schemas/CatalogOracle" } }
object CatalogOracle-allOf[1]

{
    "title":"CatalogOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/Catalog"
        },
        {
            "type":"object",
            "properties":{
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the catalog"
                }
            }
        }
    ]
}

Nested Schema : Catalog

Type: object

Title: Catalog

Discriminator: @type

{
    "title":"Catalog",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique identifier of the Catalog"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the catalog"
        },
        "name":{
            "type":"string",
            "description":"Name of the catalog"
        },
        "description":{
            "type":"string",
            "description":"Description of this catalog"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "version":{
            "type":"string",
            "description":"Catalog version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "catalogType":{
            "type":"string",
            "description":"It indicates the type of catalog"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            }
        }
    },
    "required":[
        "name"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Catalog":"#/components/schemas/Catalog",
            "CatalogOracle":"#/components/schemas/CatalogOracle"
        }
    }
}

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type: string

Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
catalogType: string

It indicates the type of catalog
category: array category
description: string

Description of this catalog
href: string

Unique reference of the catalog
id: string

Maximum Length: 30

Unique identifier of the Catalog
lastUpdate: string (date-time)

Date and time of the last update
lifecycleStatus: string

Used to indicate the current lifecycle status
name(required): string

Name of the catalog
relatedParty: array relatedParty
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Catalog version

{
    "title":"Catalog",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique identifier of the Catalog"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the catalog"
        },
        "name":{
            "type":"string",
            "description":"Name of the catalog"
        },
        "description":{
            "type":"string",
            "description":"Description of this catalog"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "version":{
            "type":"string",
            "description":"Catalog version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "catalogType":{
            "type":"string",
            "description":"It indicates the type of catalog"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            }
        }
    },
    "required":[
        "name"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Catalog":"#/components/schemas/Catalog",
            "CatalogOracle":"#/components/schemas/CatalogOracle"
        }
    }
}

Nested Schema : CatalogOracle-allOf[1]

Type: object

Show Source

applicationName: string

name of the external application
created: string (date-time)

Date and time of the creation
createdBy: string

name of the person who created item
externalId: string

id of the external application
lastUpdatedBy: string

name of the person who updated item
project: object ProjectRef

Title: ProjectRef

Project Reference
versionState: number

Version state of the catalog

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the catalog"
        }
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

It provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Examples

The following example shows how to get a catalog by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog \ -H 'Content-Type: application/json'

Example of Response Body

The following example shows the contents of the response body in JSON format.

[
    {
        "id": "PSP_OFFERS",
        "name": "Offers Catalog",
        "description": "offers for PSP",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2020-08-11T16:46:55.000Z",
        "createdBy": "anonymous",
        "lastUpdate": "2020-08-19T18:14:01.000Z",
        "lastUpdatedBy": "anonymous",
        "@type": "CatalogOracle",
        "@baseType": "Catalog",
        "validFor": {
            "endDateTime": "2021-08-03T10:00:38.000Z",
            "startDateTime": "2020-08-11T00:00:00.000Z"
        },
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/PSP_OFFERS"
    },
    {
        "id": "Cat10Aug",
        "name": "Cat10Aug",
        "description": "Cat10Aug",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2020-08-10T12:19:52.000Z",
        "createdBy": "anonymous",
        "lastUpdate": "2020-08-10T12:19:52.000Z",
        "lastUpdatedBy": "anonymous",
        "@type": "CatalogOracle",
        "validFor": {
            "startDateTime": "2020-08-10T00:00:00.000Z"
        },
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/Cat10Aug"
    },
    ....
]