Jump to

• Request
• Response
• Examples

Update a category

patch

/crmRestApi/resources/11.13.18.05/categories/{CategoryId}

Request

Path Parameters

• CategoryId(required): integer(int64)
  The unique identifier of the category.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BUOrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit associated with the category.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 255

  The name of the business unit associated with the category.
• CategoryName: string
  Title: Category Name

  Maximum Length: 400

  The name of the category.
• CSSFlag: boolean
  Title: Visible in Customer Self-Service

  Maximum Length: 1

  Default Value: true

  Indicates if the category is visible in the customer self-service portal.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the category is enabled. If enabled, the value is Y, else the value is N.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The reference to the original system from which the category was imported (if imported).
• ParentCategoryCode: string
  Title: Parent Category Code

  Maximum Length: 290

  The public unique identifier of the parent category.
• ParentCategoryId: integer (int64)
  Title: Parent Category ID

  The unique identifier of the parent category. The value is NULL, if the category is the root category.

{
    "type":"object",
    "properties":{
        "ParentCategoryCode":{
            "title":"Parent Category Code",
            "maxLength":"290",
            "type":"string",
            "description":"The public unique identifier of the parent category.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The reference to the original system from which the category was imported (if imported).",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryId"
                ]
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the category.",
            "nullable":false
        },
        "CSSFlag":{
            "title":"Visible in Customer Self-Service",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the category is visible in the customer self-service portal.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the category is enabled. If enabled, the value is Y, else the value is N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the business unit associated with the category.",
            "nullable":true
        },
        "ParentCategoryId":{
            "title":"Parent Category ID",
            "type":"integer",
            "description":"The unique identifier of the parent category. The value is NULL, if the category is the root category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : categories-item-response

Type: object

Show Source

• BUOrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit associated with the category.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 255

  The name of the business unit associated with the category.
• CategoryCode: string
  Title: Category Code

  Maximum Length: 290

  The public unique identifier of the category.
• CategoryId: integer (int64)
  Title: Category

  Read Only: true

  The unique identifier of the category.
• CategoryIdHierarchy: string
  Title: Category ID Hierarchy

  Read Only: true

  Maximum Length: 4000

  The hierarchy of the category identifiers in string format. For example: 132787 > 567754.
• CategoryName: string
  Title: Category Name

  Maximum Length: 400

  The name of the category.
• CategoryShortName: string
  Title: Category Short Name

  Maximum Length: 240

  The short name of the category. This value is auto-generated from CategoryName. However, you can edit the name to make it a unique value, if required.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the category.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the category was created.
• CSSFlag: boolean
  Title: Visible in Customer Self-Service

  Maximum Length: 1

  Default Value: true

  Indicates if the category is visible in the customer self-service portal.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates if the category has been deleted. The default value is false.
• Depth: integer (int64)
  Title: Depth

  Read Only: true

  The depth at which the service category occurs in the category hierarchy.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the category is enabled. If enabled, the value is Y, else the value is N.
• Hierarchy: string
  Title: Hierarchy

  Read Only: true

  Maximum Length: 4000

  The hierarchy of the category in a string format. For example Roaming > Technical Issue.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the category was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the category.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the row.
• LeafNodeFlag: boolean
  Title: Leaf Node

  Read Only: true

  Maximum Length: 12

  Indicates whether the current category has any children.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The reference to the original system from which the category was imported (if imported).
• ParentCategoryCode: string
  Title: Parent Category Code

  Maximum Length: 290

  The public unique identifier of the parent category.
• ParentCategoryId: integer (int64)
  Title: Parent Category ID

  The unique identifier of the parent category. The value is NULL, if the category is the root category.
• RootCategoryCode: string
  Title: Root Category Code

  Read Only: true

  Maximum Length: 4000

  Root Category Code
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The code indicating the application stripe of the service request category. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the category has been updated. The default value is false.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category",
            "type":"integer",
            "description":"The unique identifier of the category.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":"290",
            "type":"string",
            "description":"The public unique identifier of the category.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryName"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the category was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryIdHierarchy":{
            "title":"Category ID Hierarchy",
            "maxLength":"4000",
            "type":"string",
            "description":"The hierarchy of the category identifiers in string format. For example: 132787 > 567754.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Depth":{
            "title":"Depth",
            "type":"integer",
            "description":"The depth at which the service category occurs in the category hierarchy.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Hierarchy":{
            "title":"Hierarchy",
            "maxLength":"4000",
            "type":"string",
            "description":"The hierarchy of the category in a string format. For example Roaming > Technical Issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the category has been updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the category is enabled. If enabled, the value is Y, else the value is N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the business unit associated with the category.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentCategoryId":{
            "title":"Parent Category ID",
            "type":"integer",
            "description":"The unique identifier of the parent category. The value is NULL, if the category is the root category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCategoryCode":{
            "title":"Parent Category Code",
            "maxLength":"290",
            "type":"string",
            "description":"The public unique identifier of the parent category.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":"255",
            "type":"string",
            "description":"The reference to the original system from which the category was imported (if imported).",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryId"
                ]
            }
        },
        "CategoryShortName":{
            "title":"Category Short Name",
            "maxLength":"240",
            "type":"string",
            "description":"The short name of the category. This value is auto-generated from CategoryName. However, you can edit the name to make it a unique value, if required.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryCode",
                    "CategoryName"
                ]
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the category has been deleted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the application stripe of the service request category. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LeafNodeFlag":{
            "title":"Leaf Node",
            "maxLength":"12",
            "type":"boolean",
            "description":"Indicates whether the current category has any children.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the category.",
            "nullable":false,
            "x-queryable":true
        },
        "CSSFlag":{
            "title":"Visible in Customer Self-Service",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the category is visible in the customer self-service portal.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RootCategoryCode":{
            "title":"Root Category Code",
            "maxLength":"4000",
            "type":"string",
            "description":"Root Category Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the category was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

BusinessUnitLOV

Operation: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits

The list of values indicating the business units associated with the logged in user.

The following properties are defined on the LOV link relation:

• Source Attribute: BUOrgId; Target Attribute: BusinessUnitId
• Display Attribute: Name, BusinessUnitId

StripeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: StripeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

YesNoLookupPVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating the enabled status of the category.

The following properties are defined on the LOV link relation:

• Source Attribute: CSSFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

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

cURL Command

curl -u <username:password> \
 -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100558464163  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Request Body

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

{

"CategoryName": "66966478"

}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 Created
Date: Fri, 12 Aug 2016 13:02:50 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

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

{
    "CategoryId": 300100558464163,
    "ParentCategoryId": 300100558461305,
    "CategoryName": "66966478",
    "CategoryShortName": "ADULT",
    "CategoryCode": "ADULT-ORA_SVC_CRM-204",
    "ParentCategoryCode": "WELFARE-ORA_SVC_CRM-204",
    "EnabledFlag": true,
    "CreatedBy": "chris.warner",
    "CreationDate": "2022-06-07T14:05:29.149+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2022-08-09T08:27:26+00:00",
    "LastUpdateLogin": "E5B2B43EEACE7A09E0531C5CF00A8A06",
    "OriginalSystemReference": "300100558464163",
    "StripeCd": "ORA_SVC_CRM",
    "CSSFlag": true,
    "UpdateFlag": true,
    "DeleteFlag": true,
    "BUOrgId": 204,
    "BusinessUnitName": "Vision Operations",
    "Depth": 2,
    "Hierarchy": "Cases > Welfare > Adult",
    "LeafNodeFlag": true,
    "CategoryIdHierarchy": "300100543373684 > 300100558461305 > 300100558464163",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100558464163",
            "name": "categories",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100558464163",
            "name": "categories",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100558464163/lov/BusinessUnitLOV",
            "name": "BusinessUnitLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100558464163/lov/StripeCdLOV",
            "name": "StripeCdLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100558464163/lov/YesNoLookupPVO",
            "name": "YesNoLookupPVO",
            "kind": "collection"
        }
    ]
}

Back to Top