Jump to

• Request
• Response
• Examples

Get a category

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

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

Discriminator Values

• Category
• CategoryOracle

{
    "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"
        },
        "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"
            }
        },
        "parent":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            }
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            }
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "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(required): 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
• parent: array parent
• 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"
        },
        "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"
            }
        },
        "parent":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            }
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            }
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "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.

Body ()

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.

Body ()

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 does not exist.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top

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/v5/category/32000 \ -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",
    "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-02-19T07:01:46.060Z",
    "lastUpdatedBy": "booth",
    "@type": "CategoryOracle",
    "validFor": {
        "startDateTime": "2025-02-19T07:01:45.407Z"
    },
    "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": "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"
        }
    ]
}

Back to Top