Get one category
get
/fscmRestApi/resources/11.13.18.05/supplierProducts/{supplierProductsUniqID}/child/categories/{InterfaceTableUniqueId}
Request
Path Parameters
-
InterfaceTableUniqueId(required): integer(int64)
Value that uniquely identifies the category association row in staging.
-
supplierProductsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Products resource and used to uniquely identify an instance of Supplier Products. The client should not generate the hash key value. Instead, the client should query on the Supplier Products collection resource in order to navigate to a specific instance of Supplier Products 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 : supplierProducts-categories-item-response
Type:
Show Source
object
-
CategoryCode: string
Title:
Category Code
Maximum Length:820
Abbreviation that identifies the catalog category. Review and update the value for this attribute using the Product Information Management work area, and the Manage Catalogs task. -
CategoryName: string
Title:
Category
Maximum Length:250
Name of the catalog category. Review and update the value for this attribute using the Product Information Management work area, and the Manage Catalogs task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the category association. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the application created the category association. -
EndDate: string
(date)
Date when the item category assignment becomes inactive.
-
InterfaceTableUniqueId: integer
(int64)
Value that uniquely identifies the category association row in staging.
-
ItemCatalog: string
Title:
Catalog
Maximum Length:30
Name of the catalog. Review and update the value for this attribute using the Product Information Management work area, and the Manage Catalogs task. -
ItemCatalogId: integer
(int64)
Title:
Catalog
Value that uniquely identifies the catalog. -
ItemNumber: string
Title:
Item
Maximum Length:300
Name or number of the part, item, product, or service. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the category association was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the category association. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Title:
Default Organization
Maximum Length:18
Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
OrganizationId: integer
(int64)
Title:
Default Organization
Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
ProductNumber: string
Title:
Spoke Item
Maximum Length:255
Name or number of the spoke part, item, product, or service. -
SpokeSystemCode: string
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SpokeSystemId: integer
(int64)
Title:
Spoke System ID
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task. -
StartDate: string
(date)
Date when the item category assignment becomes active.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
-
SupplierName: string
Title:
Supplier
Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task. -
TransactionId: integer
(int64)
Value that identifies the product row in staging.
-
TransactionType: string
Title:
Transaction Type
Maximum Length:10
Type of action to be taken when importing a record. Valid values include SYNC and DELETE.
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.