Get all revisions of an item
get
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItem/{AffectedItemUniqID}/child/ItemRevision
Request
Path Parameters
-
AffectedItemUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Affected Items resource and used to uniquely identify an instance of Affected Items. The client should not generate the hash key value. Instead, the client should query on the Affected Items collection resource in order to navigate to a specific instance of Affected Items to get the hash key.
-
AffectedObjectUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Affected Objects resource and used to uniquely identify an instance of Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Affected Objects collection resource in order to navigate to a specific instance of Affected Objects to get the hash key.
-
ChangeId(required): integer
Value that uniquely identifies the change.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- AltRevisionCodeKey: Finds the revision based on the alternate key.
Finder Variables:- AltRevisionCode; string; Value that uniquely identifies the alternate revision.
- PrimaryKey: Finds item revisions based on the primary key
Finder Variables:- InventoryItemId; integer; Value that uniquely identifies the inventory item.
- OrganizationId; integer; Value that uniquely identifies the organization.
- RevisionId; integer; Value that uniquely identifies revision.
- AltRevisionCodeKey: Finds the revision based on the alternate key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AltRevisionCode; string
- AttachmentEntityName; string
- ChangeLineId; integer
- CreatedBy; string; Who column: An attribute which indicates the user that created the item revision.
- CreationDateTime; string; Who column: An attribute that indicates the date and time of the creation of the item revision.
- EffectivityDate; string; Revision effectively date
- EndEffectivityDate; string; Date and time when the effectivity of the revision ends.
- ImplementationDate; string; Date and time when the revision was implemented.
- InventoryItemId; integer
- ItemId; integer; An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
- ItemRevisionDescription; string; The description for on item revision.
- LastUpdateDateTime; string; Who column: An attribute which indicates the date and time of the last update of the item revision.
- LastUpdateLogin; string; Who column: An attribute which indicates the user that logged in last for the item revision
- LastUpdatedBy; string; Who column: An attribute which indicates the user that last updated the item revision
- ObjectVersionNumber; integer; This value is set to value of '1" when the item is created and incremented every time the item is updated.
- ObjectVersionNumber1; integer
- OrganizationId; integer; An 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
- RequestId; integer; This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID.
- RevisionCode; string; An attribute value that represents a revision.
- RevisionReason; string
- RevisionReasonValue; string; An attribute value that represents the reason for a revision.
- VersionAsOfDate; string
- VersionId; integer
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : productChangeOrders-AffectedObject-AffectedItem-ItemRevision
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-item-response
Type:
Show Source
object
-
AltRevisionCode: string
Maximum Length:
40
-
AttachmentEntityName: string
Maximum Length:
255
Default Value:ITEM_REVISION_ENTITY
-
ChangeLineId: integer
(int64)
-
ContextChangeLineId: integer
Default Value:
-1
-
ContextDate: string
(date-time)
-
ContextVersionId: integer
Default Value:
-1
-
CopyAttachments: boolean
-
CopyDocuments: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Who column: An attribute which indicates the user that created the item revision. -
CreationDateTime: string
(date-time)
Read Only:
true
Who column: An attribute that indicates the date and time of the creation of the item revision. -
EffectivityDate: string
(date-time)
Title:
Effective Date
Revision effectively date -
EndEffectivityDate: string
(date-time)
Read Only:
true
Date and time when the effectivity of the revision ends. -
ImplementationDate: string
(date-time)
Read Only:
true
Date and time when the revision was implemented. -
InventoryItemId: integer
(int64)
Read Only:
true
-
InvItemIdChar: string
Read Only:
true
Maximum Length:255
-
ItemId: integer
(int64)
An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
-
ItemRevisionDescription: string
Title:
Description
Maximum Length:240
The description for on item revision. -
ItemRevisionEffCategory: array
ItemRevisionEffCategory
ItemService.ItemRevisionEffCategory
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Who column: An attribute which indicates the date and time of the last update of the item revision. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Who column: An attribute which indicates the user that last updated the item revision -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Who column: An attribute which indicates the user that logged in last for the item revision -
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.
-
ObjectVersionNumber1: integer
(int32)
Read Only:
true
-
OrganizationId: integer
(int64)
Read Only:
true
An 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)
-
OrgIdChar: string
Read Only:
true
Maximum Length:255
-
RequestId: integer
(int64)
This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID.
-
RevisionCode: string
Title:
Revision Code
Maximum Length:18
An attribute value that represents a revision. -
RevisionExtensibleFlexfieldCategoryCode: string
Maximum Length:
240
An attribute value for the EFF category code for the Item revision. -
RevisionId: integer
(int64)
An unique identifier of a revision.
-
RevisionIdChar: string
Read Only:
true
Maximum Length:255
-
RevisionReason: string
Title:
Revision Reason
Maximum Length:30
-
RevisionReasonValue: string
An attribute value that represents the reason for a revision.
-
VersionAsOfDate: string
(date-time)
-
VersionId: integer
Default Value:
-1
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-response
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
240
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: integer
(int64)
-
VersionId: integer
Default Value:
-1
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.