REST API Reference for Launch Cloud Service

Get a category

get

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

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

Query Parameters

eligibleVersionForProject: 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.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root 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 type

{
    "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 : type

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

Example of Response Body

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

{
    "subCategory": [
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32112",
            "version": "1.0",
            "name": "Fruit",
            "id": "32112"
        },
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32111",
            "version": "1.0",
            "name": "Juice",
            "id": "32111"
        },
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32113",
            "version": "1.0",
            "name": "Flavoring",
            "id": "32113"
        },
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32114",
            "version": "1.0",
            "name": "Starch",
            "id": "32114"
        },
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32115",
            "version": "1.0",
            "name": "Water",
            "id": "32115"
        },
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32116",
            "version": "1.0",
            "name": "Color",
            "id": "32116"
        },
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32117",
            "version": "1.0",
            "name": "Leavening",
            "id": "32117"
        },
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32118",
            "version": "1.0",
            "name": "Soda",
            "id": "32118"
        },
        {
            "@referredType": "CategoryOracle",
            "subCategory": [],
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000/32119",
            "version": "1.0",
            "name": "Coffee",
            "id": "32119"
        }
    ],
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/32000",
    "isRoot": false,
    "parentId": "30000",
    "description": "Beverage",
    "version": "1.0",
    "name": "Beverage",
    "id": "32000"
}