1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Categories

Update a category

patch

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

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : CategoryOracle
Title: CategoryOracle
Match All
Show Source
  • Category
    Title: Category
    Discriminator: { "propertyName":"@type", "mapping":{ "Category":"#/components/schemas/Category", "CategoryOracle":"#/components/schemas/CategoryOracle" } }
  • type
Nested Schema : Category
Type: object
Title: Category
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : CategoryOracle
Title: CategoryOracle
Match All
Show Source
  • Category
    Title: Category
    Discriminator: { "propertyName":"@type", "mapping":{ "Category":"#/components/schemas/Category", "CategoryOracle":"#/components/schemas/CategoryOracle" } }
  • type
Nested Schema : Category
Type: object
Title: Category
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source

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

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

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

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

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to create or update a category by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u username:password -X PATCH https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/category/Ofsec -H 'Content-Type: application/json' -D @update_category.json | json_pp

Example of Request Body

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

{
    "description" : "Linear Scanner Category",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
}

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"
        }
    ]
}
Back to Top