Get one item rule set
get
/fscmRestApi/resources/11.13.18.05/itemRuleSets/{RuleSetId}
Request
Path Parameters
-
RuleSetId(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=
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:
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.
Root Schema : itemRuleSets-item-response
Type:
Show Source
object
-
Association1KeyValue: string
Title:
Association Name
Read Only:true
Maximum Length:30
Name of first association for the item rule set. -
Association2KeyValue: string
Read Only:
true
Maximum Length:80
Name of second association for the item rule set. -
AssociationType: string
Title:
Association Type
Read Only:true
Maximum Length:10
Value that uniquely identifies the association of the item rule set to the object. -
Composite: string
Title:
Composite
Read Only:true
Maximum Length:50
Contains one of the following values: Y or N. If Y, then the item rule set will be a composite. If N, then the item rule set won't be a composite. The default value is N. Composite functionality allow multiple item rule sets in a master rule set. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the item rule set. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the item rule set. -
Description: string
Title:
Description
Read Only:true
Maximum Length:256
Description for the item rule set. -
IsDraft: string
Read Only:
true
Maximum Length:2
Contains one of the following values: Y or null. If Y, then the item rule set will be draft rule set. If null, then the item rule set will be production. The default value is null. Draft status prevents the rule from being triggered during item transactions, and allows rule impact analysis on the rule set. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the item rule set. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the item rule set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RuleSetDisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:50
Display name of an item rule set. -
RuleSetId: integer
(int64)
Read Only:
true
Value that uniquely identifies an item rule set. -
RuleSetInternalName: string
Title:
Internal Name
Read Only:true
Maximum Length:50
Name of a item rule set. -
RuleSetType: string
Title:
Type
Read Only:true
Maximum Length:50
Value that uniquely identifies the item rule set type. -
RulesImplementation: string
Read Only:
true
Maximum Length:20
Value that uniquely identifies the implementation of the item rule set. -
translatableAttributes: array
Translatable Attributes
Title:
Translatable Attributes
Contains translated content for item rule sets based on the value for the language attribute. The description and display name for the rule set attributes are translatable for rule sets.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Translatable Attributes
Type:
array
Title:
Translatable Attributes
Contains translated content for item rule sets based on the value for the language attribute. The description and display name for the rule set attributes are translatable for rule sets.
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.
Nested Schema : itemRuleSets-translatableAttributes-item-response
Type:
Show Source
object
-
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the translated item rule set. -
Description: string
Read Only:
true
Maximum Length:256
Description for the translated item rule set. -
Language: string
Read Only:
true
Maximum Length:4
Name of the language associated with the item rule set. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the translated item rule set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RuleSetDisplayName: string
Read Only:
true
Maximum Length:50
Display name of a translated item rule set. -
RuleSetId: integer
(int64)
Read Only:
true
Value that uniquely identifies a translated item rule set. -
SourceLanguage: string
Read Only:
true
Maximum Length:4
Name of the source language associated with item rule set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- translatableAttributes
-
Parameters:
- RuleSetId:
$request.path.RuleSetId
Contains translated content for item rule sets based on the value for the language attribute. The description and display name for the rule set attributes are translatable for rule sets. - RuleSetId: