REST API Reference for Launch Cloud Service

Get all categories

get

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

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.
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.
parentId: string

For filtering: Parent Category Id
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: 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" } }
object CategoryOracle-allOf[1]

{
    "title":"CategoryOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/Category"
        },
        {
            "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 category"
                }
            }
        }
    ]
}

Nested Schema : Category

Type: object

Title: Category

Discriminator: @type

{
    "title":"Category",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique identifier of the category"
        },
        "href":{
            "type":"string",
            "description":"Reference of the catalog"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "version":{
            "type":"string",
            "description":"Category version"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "parentId":{
            "type":"string",
            "description":"Unique identifier of the parent category"
        },
        "isRoot":{
            "type":"boolean",
            "description":"If true, this Boolean indicates that the category is a root of categories"
        },
        "name":{
            "type":"string",
            "description":"Name of the category"
        },
        "description":{
            "type":"string",
            "description":"Description of the category"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the Category"
        },
        "@baseType":{
            "type":"string",
            "description":"the base class type of the category"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"link to the schema describing this category"
        },
        "subCategory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            }
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            }
        }
    },
    "required":[
        "name"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Category":"#/components/schemas/Category",
            "CategoryOracle":"#/components/schemas/CategoryOracle"
        }
    }
}

Show Source

@baseType: string

the base class type of the category
@schemaLocation: string

link to the schema describing this category
@type: string

the class type of the Category
description: string

Description of the category
href: string

Reference of the catalog
id: string

Maximum Length: 30

Unique identifier of the category
isRoot: boolean

If true, this Boolean indicates that the category is a root of categories
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 category
parentId: string

Unique identifier of the parent category
productOffering: array productOffering
subCategory: array subCategory
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Category version

{
    "title":"Category",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique identifier of the category"
        },
        "href":{
            "type":"string",
            "description":"Reference of the catalog"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "version":{
            "type":"string",
            "description":"Category version"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "parentId":{
            "type":"string",
            "description":"Unique identifier of the parent category"
        },
        "isRoot":{
            "type":"boolean",
            "description":"If true, this Boolean indicates that the category is a root of categories"
        },
        "name":{
            "type":"string",
            "description":"Name of the category"
        },
        "description":{
            "type":"string",
            "description":"Description of the category"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the Category"
        },
        "@baseType":{
            "type":"string",
            "description":"the base class type of the category"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"link to the schema describing this category"
        },
        "subCategory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            }
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            }
        }
    },
    "required":[
        "name"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Category":"#/components/schemas/Category",
            "CategoryOracle":"#/components/schemas/CategoryOracle"
        }
    }
}

Nested Schema : CategoryOracle-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 category

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

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

Example of Response Body

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

[
    {
        "id": "Cat10Aug2_category7",
        "name": "Cat10Aug2_category7",
        "description": "Cat10Aug2_category7",
        "version": "Y",
        "lifecycleStatus": "In design",
        "created": "2020-08-10T15:34:09.000Z",
        "createdBy": "anonymous",
        "lastUpdate": "2020-08-10T15:34:09.000Z",
        "lastUpdatedBy": "anonymous",
        "@type": "CategoryOracle",
        "validFor": {
            "startDateTime": "2020-08-10T00:00:00.000Z"
        },
		 "project": {
        "id": "SpringProject",
        "name": "SpringProject"
		},
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/Cat10Aug2_category7"
    },
   {
        "id": "Cat10Aug_category11",
        "name": "Cat10Aug_category11",
        "description": "Cat10Aug_category11",
        "version": "Y",
        "lifecycleStatus": "In design",
        "created": "2020-08-10T14:06:52.000Z",
        "createdBy": "anonymous",
        "lastUpdate": "2020-08-10T14:06:52.000Z",
        "lastUpdatedBy": "anonymous",
        "@type": "CategoryOracle",
        "validFor": {
            "startDateTime": "2020-08-10T00:00:00.000Z"
        },
         "project": {
        "id": "SpringProject",
        "name": "SpringProject"
        },
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/Cat10Aug_category11"
    },
		....
]