Jump to

• Request
• Response

Update one category hierarchy

patch

/fscmRestApi/resources/11.13.18.05/categoryHierarchies/{categoryHierarchiesUniqID}

Request

Path Parameters

• categoryHierarchiesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Catalog Category Hierarchies resource and used to uniquely identify an instance of Catalog Category Hierarchies. The client should not generate the hash key value. Instead, the client should query on the Catalog Category Hierarchies collection resource in order to navigate to a specific instance of Catalog Category Hierarchies to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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

• categoryAssignments: array Category Assignments
  Title: Category Assignments

  Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.
• CategoryDescription: string
  Title: Description

  Maximum Length: 255

  Description of the category hierarchy.
• CategoryImageURL: string
  Title: Image URL

  Maximum Length: 240

  URL that locates the image representing the category, if available.
• CategoryName: string
  Title: Category Name

  Maximum Length: 255

  Name of the category hierarchy.
• FeaturedCategoryFlag: boolean
  Maximum Length: 1

  Indicates whether the category is a top-level category featured on the Create Requisition home page. Valid values are - true (featured), false (not featured), null (value not set). Default is null.

{
    "type":"object",
    "properties":{
        "CategoryDescription":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the category hierarchy.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BrowseCategoryDescription",
                    "ItemCategoryDescription"
                ]
            }
        },
        "CategoryImageURL":{
            "title":"Image URL",
            "maxLength":240,
            "type":"string",
            "description":"URL that locates the image representing the category, if available.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the category hierarchy.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "dependencies":[
                    "BrowseCategoryName",
                    "ItemCategoryName"
                ]
            }
        },
        "FeaturedCategoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the category is a top-level category featured on the Create Requisition home page. Valid values are - true (featured), false (not featured), null (value not set). Default is null.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "categoryAssignments":{
            "title":"Category Assignments",
            "type":"array",
            "description":"Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.",
            "items":{
                "$ref":"#/components/schemas/categoryHierarchies-categoryAssignments-item-patch-request"
            }
        }
    }
}

Nested Schema : Category Assignments

Type: array

Title: Category Assignments

Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.

Show Source

• Array of: object categoryHierarchies-categoryAssignments-item-patch-request

{
    "title":"Category Assignments",
    "type":"array",
    "description":"Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.",
    "items":{
        "$ref":"#/components/schemas/categoryHierarchies-categoryAssignments-item-patch-request"
    }
}

Nested Schema : categoryHierarchies-categoryAssignments-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : categoryHierarchies-item-response

Type: object

Show Source

• categoryAssignments: array Category Assignments
  Title: Category Assignments

  Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.
• CategoryDescription: string
  Title: Description

  Maximum Length: 255

  Description of the category hierarchy.
• CategoryId: integer (int64)
  Value that uniquely identifies the category hierarchy.
• CategoryImageURL: string
  Title: Image URL

  Maximum Length: 240

  URL that locates the image representing the category, if available.
• CategoryName: string
  Title: Category Name

  Maximum Length: 255

  Name of the category hierarchy.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the category hierarchy.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the category hierarchy was created.
• FeaturedCategoryFlag: boolean
  Maximum Length: 1

  Indicates whether the category is a top-level category featured on the Create Requisition home page. Valid values are - true (featured), false (not featured), null (value not set). Default is null.
• HierarchyType: string
  Maximum Length: 30

  The type of catalog hierarchy. Valid values are - SHOPPING, SUPPLIER, SOURCING.
• ItemCategoryFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the category is a purchasing category. Valid values are - true (purchasing category), false (not a purchasing category). Default is false for browsing categories and true for item categories.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the category hierarchy was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the category hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentCategoryId: integer (int64)
  Value that uniquely identifies the parent category hierarchy.
• ParentCategoryName: string
  Title: Parent Category Name

  Read Only: true

  Maximum Length: 255

  Name of the parent category hierarchy.
• SupplierEnabledFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the category is shown in the supplier flow. Valid values are - true (shown), false (not shown).

{
    "type":"object",
    "properties":{
        "CategoryDescription":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the category hierarchy.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BrowseCategoryDescription",
                    "ItemCategoryDescription"
                ]
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "CategoryImageURL":{
            "title":"Image URL",
            "maxLength":240,
            "type":"string",
            "description":"URL that locates the image representing the category, if available.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the category hierarchy.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "dependencies":[
                    "BrowseCategoryName",
                    "ItemCategoryName"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the category hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the category hierarchy was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FeaturedCategoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the category is a top-level category featured on the Create Requisition home page. Valid values are - true (featured), false (not featured), null (value not set). Default is null.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "HierarchyType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of catalog hierarchy. Valid values are - SHOPPING, SUPPLIER, SOURCING.",
            "nullable":false,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "ItemCategoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the category is a purchasing category. Valid values are - true (purchasing category), false (not a purchasing category). Default is false for browsing categories and true for item categories.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the category hierarchy was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the category hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ParentCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent category hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "ParentCategoryName":{
            "title":"Parent Category Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the parent category hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "CategoryId3",
                    "CategoryNameMeaning"
                ]
            }
        },
        "SupplierEnabledFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the category is shown in the supplier flow. Valid values are - true (shown), false (not shown).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "categoryAssignments":{
            "title":"Category Assignments",
            "type":"array",
            "description":"Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.",
            "items":{
                "$ref":"#/components/schemas/categoryHierarchies-categoryAssignments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Category Assignments

Type: array

Title: Category Assignments

Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.

Show Source

• Array of: object categoryHierarchies-categoryAssignments-item-response

{
    "title":"Category Assignments",
    "type":"array",
    "description":"Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.",
    "items":{
        "$ref":"#/components/schemas/categoryHierarchies-categoryAssignments-item-response"
    }
}

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 : categoryHierarchies-categoryAssignments-item-response

Type: object

Show Source

• CategoryAssignmentId: integer (int64)
  Read Only: true

  Unique identifier for the category assignment.
• CategoryId: integer
  Read Only: true

  Unique identifier for the category.
• ContentName: string
  Title: Content Name

  Read Only: true

  Maximum Length: 250

  Name of the content.
• ContentType: string
  Title: Content Type

  Read Only: true

  Maximum Length: 80

  Type of content. Valid values are Smart Form, Informational Catalog, Punchout Catalog, and Local Catalog.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBU: string
  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit.

{
    "type":"object",
    "properties":{
        "CategoryAssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the category assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier for the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentName":{
            "title":"Content Name",
            "maxLength":250,
            "type":"string",
            "description":"Name of the content.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of content. Valid values are Smart Form, Informational Catalog, Punchout Catalog, and Local Catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBU":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

categoryAssignments

Operation: /fscmRestApi/resources/11.13.18.05/categoryHierarchies/{categoryHierarchiesUniqID}/child/categoryAssignments

Parameters:

• categoryHierarchiesUniqID: $request.path.categoryHierarchiesUniqID

Displays all content types (smart forms or catalogs) assigned to a category in the View Category Assignments page.

insertItemCategories

Operation: /fscmRestApi/resources/11.13.18.05/categoryHierarchies/{categoryHierarchiesUniqID}/action/insertItemCategories

Parameters:

• categoryHierarchiesUniqID: $request.path.categoryHierarchiesUniqID

Inserts item categories to create a hierarchy.

moveCategory

Operation: /fscmRestApi/resources/11.13.18.05/categoryHierarchies/{categoryHierarchiesUniqID}/action/moveCategory

Parameters:

• categoryHierarchiesUniqID: $request.path.categoryHierarchiesUniqID

Moves a browsing or item category under another browsing category.

Back to Top