Get one category

get

/fscmRestApi/resources/11.13.18.05/itemCategories/{itemCategoriesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Item Categories resource and used to uniquely identify an instance of Item Categories. The client should not generate the hash key value. Instead, the client should query on the Item Categories collection resource in order to navigate to a specific instance of Item Categories to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : itemCategories-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the catalog attachments.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Translatable Attributes
Type: array
Title: Translatable Attributes
The Translatable Attributes resource manages the translatable attributes of categories.
Show Source
Nested Schema : itemCategories-attachments-item-response
Type: object
Show Source
  • Descriptive Flexfields for Attachments
    Title: Descriptive Flexfields for Attachments
    The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments.
  • Title: Category
    Maximum Length: 30
    Name of the catalog attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
  • Title: Shared
    Contains one of the following values: true or false. If true, then the attachment is shared. If false, then it's not shared. The default value is false.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    User who created the attachment.
  • Title: Creation Date
    Read Only: true
    Date when the user created the attachment.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.
  • Title: Description
    Maximum Length: 255
    Description of the catalog attachment.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Path to the folder in which the attached file is uploaded.
  • Read Only: true
    Uniform resource locator of the catalog attachment.
  • Title: DownloadInfo
    JSON object represented as a string containing information used to programmatically retrieve a file attachment.
  • Title: Error Status Code
    Abbreviation that identifies the error code, if any, for the attachment.
  • Title: Error Status Message
    Text of the error message, if any, for the attachment.
  • Title: File Name
    Maximum Length: 2048
    Name of the file attached to the item.
  • Title: File Url
    Uniform resource locator of the attachment file.
  • Title: Last Update Date
    Read Only: true
    Date when the user most recently updated the attachment.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    User who most recently updated the attachment.
  • Links
  • Title: Title
    Title of the catalog attachment.
  • Title: Uploaded File Content Type
    Type of the file content.
  • Title: File Size
    Size of the attached file.
  • Title: Uploaded File Name
    Name of the attached file.
  • Title: Uploaded Text
    Content of the attached text file.
  • Title: Uri
    Maximum Length: 4000
    Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
  • Title: Url
    Maximum Length: 4000
    Uniform resource locator of the attachment.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    Display name of the attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task.
Nested Schema : Descriptive Flexfields for Attachments
Type: array
Title: Descriptive Flexfields for Attachments
The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the category attachments.
Show Source
Nested Schema : itemCategories-attachments-attachmentDFF-item-response
Type: object
Show Source
Nested Schema : itemCategories-DFF-item-response
Type: object
Show Source
Nested Schema : itemCategories-translatableAttributes-item-response
Type: object
Show Source
Back to Top