REST API Reference for Launch Cloud Service

Get all catalogs

get

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

Returns a list of catalogs that match the search criteria.

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

The catalog type value for filtering resource results.
depth: string

The depth at which a resource item occurs in a resource hierarchy.
description: string

The description of the resource.
eligibleForProject: string

The project ID.
expand: array[string]
The expand value for filtering resource results.
- Allowed Values: [ "catalog.category", "catalog.category.subCategory" ]
```
[
    "catalog.category",
    "catalog.category.subCategory"
]
```
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 ID of the resource item.
lastUpdate: string

Filters resources by their last update date and time.
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.
project.id: string

The ID of the project for filtering resource results.
project.version: string

The project version for filtering entities.
validFor.endDateTime: string

The valid for end date time for filtering entities.
validFor.startDateTime: string

The valid for start date time for filtering entities.
version: string

The current version of the resource.
whereUsed: string

Whether to enrich objects with usedBy information.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The list of catalogs was returned successfully.

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" } }

The catalog resource.
object CatalogOracle-allOf[1]

{
    "title":"CatalogOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/Catalog"
        },
        {
            "type":"object",
            "properties":{
                "project":{
                    "$ref":"#/components/schemas/ProjectRef",
                    "description":"The project associated with the catalog."
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date and time of the creation."
                },
                "createdBy":{
                    "type":"string",
                    "description":"The name of the person who created item."
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"The name of the person who updated item."
                },
                "externalId":{
                    "type":"string",
                    "description":"The ID of the external associated with the catalog."
                },
                "applicationName":{
                    "type":"string",
                    "description":"The name of the application associated with the catalog."
                },
                "versionState":{
                    "type":"number",
                    "description":"The 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":"The ID of the catalog."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the catalog."
        },
        "name":{
            "type":"string",
            "description":"The name of the catalog."
        },
        "description":{
            "type":"string",
            "description":"The 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":"The URI of the schema that defines the catalog."
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates the base class type of this REST resource."
        },
        "version":{
            "type":"string",
            "description":"The catalog version."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the catalog is valid."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the catalog was last updated."
        },
        "catalogType":{
            "type":"string",
            "description":"The type or classification of the catalog."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the catalog."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A list of related parties associated with the catalog."
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of categories associated with the catalog."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Catalog":"#/components/schemas/Catalog",
            "CatalogOracle":"#/components/schemas/CatalogOracle"
        }
    },
    "description":"The catalog resource."
}

The catalog resource.

Show Source

@baseType: string

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

The URI of the schema that defines the catalog.
@type(required): string

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

The type or classification of the catalog.
category: array category

A list of categories associated with the catalog.
description: string

The description of this catalog.
href: string

The hyperlink reference to the catalog.
id: string

Maximum Length: 30

The ID of the catalog.
lastUpdate: string (date-time)

The date and time when the catalog was last updated.
lifecycleStatus: string

The status of the catalog.
name(required): string

The name of the catalog.
relatedParty: array relatedParty

A list of related parties associated with the catalog.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The catalog version.

{
    "title":"Catalog",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the catalog."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the catalog."
        },
        "name":{
            "type":"string",
            "description":"The name of the catalog."
        },
        "description":{
            "type":"string",
            "description":"The 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":"The URI of the schema that defines the catalog."
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates the base class type of this REST resource."
        },
        "version":{
            "type":"string",
            "description":"The catalog version."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the catalog is valid."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the catalog was last updated."
        },
        "catalogType":{
            "type":"string",
            "description":"The type or classification of the catalog."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the catalog."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A list of related parties associated with the catalog."
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of categories associated with the catalog."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Catalog":"#/components/schemas/Catalog",
            "CatalogOracle":"#/components/schemas/CatalogOracle"
        }
    },
    "description":"The catalog resource."
}

Nested Schema : CatalogOracle-allOf[1]

Type: object

Show Source

applicationName: string

The name of the application associated with the catalog.
created: string (date-time)

The date and time of the creation.
createdBy: string

The name of the person who created item.
externalId: string

The ID of the external associated with the catalog.
lastUpdatedBy: string

The name of the person who updated item.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
versionState: number

The version state of the catalog.

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

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The 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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

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

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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/v5/catalog \ -H 'Content-Type: application/json'

Example of Response Body

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

[
    {
        "id": "ConsumerCatalog",
        "name": "ConsumerCatalog",
        "description": "Catalog definition for Consumers",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/catalog/ConsumerCatalog",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2025-02-18T07:51:47.000Z",
        "createdBy": "booth",
        "lastUpdate": "2025-03-06T13:47:51.153Z",
        "lastUpdatedBy": "booth",
        "@type": "CatalogOracle",
        "@baseType": "Catalog",
        "catalogType": "PRODUCT",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "project": {
            "id": "DBE_RI_ProdModel_PreSeed_PSP",
            "name": "DBE RI Product Model Preseed",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
            "version": "1.0",
            "@referredType": "ProjectOracle"
        },
        "relatedParty": [
            {
                "role": "ROLE1",
                "partyOrPartyRole": {
                    "id": "PartyRoleID",
                    "name": "PartyRoleName",
                    "partyId": "partyid123",
                    "partyName": "partyName",
                    "@referredType": "PartyRole",
                    "@type": "PartyRoleRef"
                },
                "@type": "RelatedPartyRefOrPartyRoleRef"
            }
        ],
        "category": [
            {
                "id": "88-4KXTW",
                "name": "2D Scanners",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/88-4KXTW",
                "version": "1.0",
                "@referredType": "CategoryOracle",
                "@type": "CategoryOracle"
            },
            {
                "id": "88-4KXTY",
                "name": "Android Scanners",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/88-4KXTY",
                "version": "1.0",
                "@referredType": "CategoryOracle",
                "@type": "CategoryOracle"
            }
        ]
    },
    {
        "id": "ConsumerCatalogAPAC",
        "name": "Consumer Catalog APAC",
        "description": "Catalog definition for Consumers",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/catalog/ConsumerCatalogAPAC",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2025-02-18T07:51:47.000Z",
        "createdBy": "booth",
        "lastUpdate": "2025-03-06T13:47:51.153Z",
        "lastUpdatedBy": "booth",
        "@type": "CatalogOracle",
        "@baseType": "Catalog",
        "catalogType": "PRODUCT",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "project": {
            "id": "DBE_RI_ProdModel_PreSeed_PSP",
            "name": "DBE RI Product Model Preseed",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
            "version": "1.0",
            "@referredType": "ProjectOracle"
        },
        "relatedParty": [
            {
                "role": "ROLE1",
                "partyOrPartyRole": {
                    "id": "PartyRoleID",
                    "name": "PartyRoleName",
                    "partyId": "partyid123",
                    "partyName": "partyName",
                    "@referredType": "PartyRole",
                    "@type": "PartyRoleRef"
                },
                "@type": "RelatedPartyRefOrPartyRoleRef"
            }
        ],
        "category": [
            {
                "id": "88-4KXTW",
                "name": "2D Scanners",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/88-4KXTW",
                "version": "1.0",
                "@referredType": "CategoryOracle",
                "@type": "CategoryOracle"
            },
            {
                "id": "88-4KXTY",
                "name": "Android Scanners",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/88-4KXTY",
                "version": "1.0",
                "@referredType": "CategoryOracle",
                "@type": "CategoryOracle"
            }
        ]
    }
]