Get one change type
get
/fscmRestApi/resources/11.13.18.05/productChangeTypes/{Id}
Request
Path Parameters
-
Id(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(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 : productChangeTypes-item-response
Type:
Show Source
object
-
AssigneeRole: string
Maximum Length:
255
Assignee role name for a change type. -
AssigneeRoleId: string
Maximum Length:
64
Assignee role ID for a change type. -
AssociatedRuleSetId: integer
Associated rule-set ID for a change type.
-
AssociatedRuleSetName: string
Maximum Length:
255
Associated rule-set name for a change type. -
AutoCompleteOnCancelFlag: boolean
Title:
Autocomplete on Cancel
Maximum Length:1
Default Value:true
Contains one of the following values: true or false. If true, then the change type, when canceled, automatically changes to completed. If false, then the change type doesn't show as completed. -
BaseChangeTypeCode: string
Title:
Copied From
Maximum Length:30
Type code of the base change type. -
BaseChangeTypeFlag: boolean
Maximum Length:
1
Type mark of a base change type. -
BaseChangeTypeValue: string
Maximum Length:
255
Type value of the base change type. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the change type. -
DefaultAssignee: string
Maximum Length:
255
Default assignee's role name for a change type. -
DefaultAssigneeId: string
Maximum Length:
64
Default assignee's ID for a change type. -
Description: string
Maximum Length:
240
Description of the change type. -
EffectiveImmediatelyFlag: boolean
Maximum Length:
5
Contains one of the following values: true or false. If true, then the change type is effective immediately. If false, then the change type isn't effective immediately. -
EffectivityIncrementDays: integer
Default Value:
1
The number of days after which the change type is effective. -
EndDate: string
(date)
End date of the change type.
-
Id: integer
(int64)
Read Only:
true
ID of the change type. -
Increment: number
Title:
Increment
Increment value of the change type. -
InternalName: string
Title:
Internal Name
Maximum Length:30
Internal name of the change type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandateCommentsCode: string
Maximum Length:
30
Code for mandate comments of the change type. -
MandateCommentsValue: string
Maximum Length:
255
Value of the mandate comments of the change type. -
Name: string
Maximum Length:
80
Name of the change type. -
NumberGenerationMethodCode: string
Maximum Length:
30
Code for the number generation method of the change type. -
NumberGenerationMethodValue: string
Maximum Length:
255
Number generation method's value of the change type. -
ObjectVersionNumber: integer
(int32)
Version number indicated for the change type.
-
Prefix: string
Prefix value of the name of the change type.
-
PriorityCode: string
Maximum Length:
30
Code that identifies the priority of the change type. -
PriorityValue: string
Maximum Length:
255
Value that determines the priority of the change type. -
ReasonCode: string
Maximum Length:
30
Code that identifies the reason for the change. -
ReasonValue: string
Maximum Length:
255
Value that determines the reason for the change type. -
StartDate: string
(date)
Start date of the change type.
-
StartingNumber: number
Title:
Starting Number
Starting number of the change type. -
Suffix: string
Suffix value of the name of the change type.
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.