REST API Reference for Launch Cloud Service

Get all categories

get

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

Returns a list of categories 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.
catalogId: string

The ID of the catalog associated with the resource.
description: string

The description of the resource.
eligibleForProject: string

The 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 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 categories was returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: CategoryOracle

Title: CategoryOracle

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

Nested Schema : CategoryOracle

Title: CategoryOracle

Match All

Show Source

object Category

Title: Category

Discriminator: { "propertyName":"@type", "mapping":{ "Category":"#/components/schemas/Category", "CategoryOracle":"#/components/schemas/CategoryOracle" } }

The category resource.
object CategoryOracle-allOf[1]

{
    "title":"CategoryOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/Category"
        },
        {
            "type":"object",
            "properties":{
                "project":{
                    "$ref":"#/components/schemas/ProjectRef",
                    "description":"The project associated with the category."
                },
                "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 category."
                },
                "applicationName":{
                    "type":"string",
                    "description":"The name of the application associated with the category."
                },
                "versionState":{
                    "type":"number",
                    "description":"The version state of the category."
                }
            }
        }
    ]
}

Nested Schema : Category

Type: object

Title: Category

Discriminator: @type

{
    "title":"Category",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the category."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the category."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the category was last updated."
        },
        "version":{
            "type":"string",
            "description":"The category version."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the category."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the category is valid."
        },
        "isRoot":{
            "type":"boolean",
            "description":"If true, this Boolean indicates that the category is a root of categories."
        },
        "name":{
            "type":"string",
            "description":"The name of the category."
        },
        "description":{
            "type":"string",
            "description":"The description of the category."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the category."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the category."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the category."
        },
        "subCategory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of sub categories associated with the category."
        },
        "parent":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of parents associated with the category."
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            },
            "description":"A list of product offerings associated with the category."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Category":"#/components/schemas/Category",
            "CategoryOracle":"#/components/schemas/CategoryOracle"
        }
    },
    "description":"The category resource."
}

The category resource.

Show Source

@baseType: string

The base type of the category.
@schemaLocation: string

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

The class type of the category.
description: string

The description of the category.
href: string

The hyperlink reference to the category.
id: string

Maximum Length: 30

The ID of the category.
isRoot: boolean

If true, this Boolean indicates that the category is a root of categories.
lastUpdate: string (date-time)

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

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

The name of the category.
parent: array parent

A list of parents associated with the category.
productOffering: array productOffering

A list of product offerings associated with the category.
subCategory: array subCategory

A list of sub categories associated with the category.
validFor: object TimePeriod

Title: TimePeriod

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

The category version.

{
    "title":"Category",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the category."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the category."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the category was last updated."
        },
        "version":{
            "type":"string",
            "description":"The category version."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the category."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the category is valid."
        },
        "isRoot":{
            "type":"boolean",
            "description":"If true, this Boolean indicates that the category is a root of categories."
        },
        "name":{
            "type":"string",
            "description":"The name of the category."
        },
        "description":{
            "type":"string",
            "description":"The description of the category."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the category."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the category."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the category."
        },
        "subCategory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of sub categories associated with the category."
        },
        "parent":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of parents associated with the category."
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            },
            "description":"A list of product offerings associated with the category."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Category":"#/components/schemas/Category",
            "CategoryOracle":"#/components/schemas/CategoryOracle"
        }
    },
    "description":"The category resource."
}

Nested Schema : CategoryOracle-allOf[1]

Type: object

Show Source

applicationName: string

The name of the application associated with the category.
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 category.
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 category.

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The project associated with the category."
        },
        "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 category."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the category."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the category."
        }
    }
}

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 all categories 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/productCatalogManagement/v5/category \ -H 'Content-Type: application/json'

Example of Response Body

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

[
    {
        "id": "sc-3663970456-1739948122141",
        "name": "Linear",
        "description": "Linear Scanner Category",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/sc-3663970456-1739948122141",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2025-02-19T06:56:32.000Z",
        "createdBy": "booth",
        "lastUpdate": "2025-03-06T14:00:24.025Z",
        "lastUpdatedBy": "booth",
        "@type": "CategoryOracle",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "project": {
            "id": "ini_prom45",
            "name": "ini_prom45",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/ini_prom45",
            "version": "1.0",
            "@referredType": "ProjectOracle",
            "@type": "ProjectRef"
        },
        "parent": [
            {
                "id": "88-4KXTX",
                "@referredType": "CategoryOracle",
                "@type": "CategoryRef"
            }
        ],
        "subCategory": [
            {
                "id": "sc-1628564045-1739948456946",
                "name": "Ful Page Scanner",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/sc-1628564045-1739948456946",
                "version": "1.0",
                "@referredType": "CategoryOracle",
                "@type": "CategoryRef"
            },
            {
                "id": "sc-106984183-1739948494484",
                "name": "Line Scanner",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/sc-106984183-1739948494484",
                "version": "1.0",
                "@referredType": "CategoryOracle",
                "@type": "CategoryRef"
            }
        ]
    },
    {
        "id": "sc-1628564045-1739948456946",
        "name": "Ful Page Scanner",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/sc-1628564045-1739948456946",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2025-02-19T07:01:47.000Z",
        "createdBy": "booth",
        "lastUpdate": "2025-03-03T05:09:02.135Z",
        "lastUpdatedBy": "booth",
        "@type": "CategoryOracle",
        "validFor": {
            "startDateTime": "2025-02-19T07:01:46.711Z"
        },
        "project": {
            "id": "ini_prom45",
            "name": "ini_prom45",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/ini_prom45",
            "version": "1.0",
            "@referredType": "ProjectOracle",
            "@type": "ProjectRef"
        },
        "versionState": 0,
        "parent": [
            {
                "id": "sc-3663970456-1739948122141",
                "name": "Linear",
                "version": "1.0",
                "@referredType": "CategoryOracle",
                "@type": "CategoryRef"
            }
        ]
    }
]