Get one category
get
/fscmRestApi/resources/11.13.18.05/itemsLOV/{itemsLOVUniqID}/child/ItemCategories/{ItemCategoryAssignmentId}
Request
Path Parameters
-
ItemCategoryAssignmentId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
itemsLOVUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Items List of Values resource and used to uniquely identify an instance of Items List of Values. The client should not generate the hash key value. Instead, the client should query on the Items List of Values collection resource in order to navigate to a specific instance of Items List of Values to get the hash key.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : itemsLOV-ItemCategories-item-response
Type:
Show Source
object
-
AltItemCatCode: string
Maximum Length:
40
Abbreviation that identifies the item catalog. -
CategoryCode: string
Maximum Length:
255
A unique code that represents a component of the catalog used for classification of items. -
CategoryId: integer
(int64)
Title:
Category
Value that uniquely identifies the category. -
CategoryName: string
Name of the category.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the item category assignment. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time of the creation of the item catalog category assignment. -
EndDate: string
(date)
Date when the item association ends. The end date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.
-
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the part, item, product, or service. -
ItemCatalog: string
Name of the item catalog.
-
ItemCategoryAssignmentId: integer
(int64)
Value that uniquely identifies the item category assignment.
-
ItemCategoryHierarchyCode: string
Read Only:
true
Value that represents category hierarchy using category codes. -
ItemCategoryHierarchyName: string
Read Only:
true
Value that represents category hierarchy using category names. -
ItemCategoryId: integer
(int64)
Title:
Catalog
Value that uniquely identifies the category -
ItemId: integer
(int64)
Value that uniquely identifies the part, item, product, or service.
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the item-category association. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item-category association. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the item-category association.. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
This value is set to value of 1 when the item is created and incremented every time the item is updated.
-
OrganizationId: integer
(int64)
Read Only:
true
A unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting. -
OrganizationId1: integer
(int64)
A unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
-
RequestId: integer
(int64)
The request ID generated at import. Its use case is to verify the import. The items are published based on RequestID.
-
SequenceNumber: integer
(int32)
Value that indicates the sequence number of the item category assignments.
-
StartDate: string
(date)
Date when the item association begins. The start date can't be specified for functional area catalogs, except for the catalog assigned to the service logistics functional area.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.