Get all item revisions
get
/fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemRevision
Request
Path Parameters
-
itemsV2UniqID(required): string
This is the hash key of the attributes which make up the composite key for the Items Version 2 resource and used to uniquely identify an instance of Items Version 2. The client should not generate the hash key value. Instead, the client should query on the Items Version 2 collection resource in order to navigate to a specific instance of Items Version 2 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 -
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: Not exposed in code.
Finder Variables:- AltRevisionCode; string; Not exposed in code.
- PrimaryKey: Finds item revisions according to the primary key criteria.
Finder Variables:- InventoryItemId; integer; Value that uniquely identifies the item.
- OrganizationId; integer; Value that uniquely identifies the organization.
- RevisionId; integer; Value that uniquely identifies the item revision.
- AltRevisionCodeKey: Not exposed in code.
-
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:- CreatedBy; string; User who created the item.
- CreationDateTime; string; Date and time when the user created the item revision.
- EffectivityDate; string; Date when the revision goes into effect.
- EndEffectivityDate; string; Date and time when the effectivity of the revision ends.
- ImplementationDate; string; Date and time when the revision was implemented.
- ItemId; integer; Value that uniquely identifies the part, item, product, or service.
- ItemRevisionDescription; string; Description of the item revision.
- LastUpdateDateTime; string; Date and time when the user most recently updated the item revision.
- LastUpdateLogin; string; Login that the user used when updating the item.
- LastUpdatedBy; string; User who most recently updated the item.
- OrganizationId; integer; 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.
- RequestId; integer; Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.
- RevisionCode; string; Value that identifies the revision.
- RevisionReasonValue; string; Reason for the revision. A list of accepted values is defined in the lookup type ORA_EGP_SAFETY_STK_PLN_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
-
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:
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 : itemsV2-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 : itemsV2-ItemRevision-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the item. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the item revision. -
EffectivityDate: string
(date-time)
Title:
Effective Date
Date when the revision goes into effect. -
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. -
ItemId: integer
(int64)
Value that uniquely identifies the part, item, product, or service.
-
ItemRevisionDescription: string
Title:
Description
Maximum Length:240
Description of the item revision. -
ItemRevisionDFF: array
Descriptive Flexfields for Item Revisions
Title:
Descriptive Flexfields for Item Revisions
The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision. -
ItemRevisionEffCategory: array
Extensible Flexfields for Item Revisions
Title:
Extensible Flexfields for Item Revisions
The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes. -
ItemRevisionTranslation: array
Item Revision Translatable Attributes
Title:
Item Revision Translatable Attributes
The Item Revision Translatable Attributes resource manages the translatable attributes of item revision. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the item revision. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
true
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. -
RequestId: integer
(int64)
Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.
-
RevisionAttachment: array
Item Revision Attachments
Title:
Item Revision Attachments
The Item Revision Attachments resource manages attachments associated with item revisions. -
RevisionCode: string
Title:
Revision Code
Maximum Length:18
Value that identifies the revision. -
RevisionExtensibleFlexfieldCategoryCode: string
Maximum Length:
240
Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task. -
RevisionId: integer
(int64)
Value that uniquely identifies the revision of the item.
-
RevisionReasonValue: string
Reason for the revision. A list of accepted values is defined in the lookup type ORA_EGP_SAFETY_STK_PLN_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
Nested Schema : Descriptive Flexfields for Item Revisions
Type:
array
Title:
Descriptive Flexfields for Item Revisions
The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.
Show Source
Nested Schema : Extensible Flexfields for Item Revisions
Type:
array
Title:
Extensible Flexfields for Item Revisions
The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.
Show Source
-
Array of:
object Discriminator: CategoryCode
Discriminator:
{ "propertyName":"CategoryCode", "mapping":{ "ROOT_ICC":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response" } }
Nested Schema : Item Revision Translatable Attributes
Type:
array
Title:
Item Revision Translatable Attributes
The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Item Revision Attachments
Type:
array
Title:
Item Revision Attachments
The Item Revision Attachments resource manages attachments associated with item revisions.
Show Source
Nested Schema : itemsV2-ItemRevision-ItemRevisionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context name for item revision. -
__FLEX_Context_DisplayValue: string
Title:
Context
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: integer
(int64)
Value that uniquely identifies the revision of the item.
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.
Nested Schema : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
240
Default Value:ROOT_ICC
Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: integer
(int64)
Value that uniquely identifies the revision.
-
VersionId: integer
Default Value:
-1
Value that uniquely identifies the item version.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : itemsV2-ItemRevision-ItemRevisionTranslation-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the item. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the item revision translatable attribute. -
Description: string
Maximum Length:
240
Not exposed in code. -
Language: string
Maximum Length:
4
Language associated with item long description. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the item revision translatable attribute. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: integer
(int64)
Value that uniquely identifies the revision of the item.
-
SourceLanguage: string
Maximum Length:
4
Language from which the item revision values are translated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : itemsV2-ItemRevision-RevisionAttachment-item-response
Type:
Show Source
object
-
AttachedDocumentId: integer
(int64)
An unique identifier for document that is an attachment in the repository.
-
CategoryName: string
Title:
Category
Maximum Length:30
Name of the item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Not exposed in code. -
Description: string
Title:
Description
Maximum Length:255
Description of the item revision attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the document in repository. -
DmFolderPath: string
Maximum Length:
1000
Path to the folder in which the attachment file is uploaded. -
DmVersionNumber: string
Maximum Length:
255
Version number that identifies the attachment in repository. -
DocumentURL: string
Read Only:
true
Complete URL (Uniform Resource Locator) of the item attachment uploaded to web center. -
DownloadInfo: string
JSON object represented as a string containing information used to programmatically retrieve a file attachment.
-
ErrorStatusCode: string
Abbreviation that identifies the error code, if any, for the attachment.
-
ErrorStatusMessage: string
Text of the error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Date when the contents of the attachment are no longer valid.
-
FileContents: string
(byte)
Not exposed in code.
-
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attached to the item. -
FileUrl: string
Path of the document file.
-
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the item revision attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Read Only:
true
Login that the user used when updating the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the item revision attachment. -
UploadedFileContentType: string
Content type of the attached file.
-
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Name of the attached file.
-
UploadedText: string
Contents of text file that is attached.
-
Uri: string
Maximum Length:
4000
URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Maximum Length:
4000
Uniform resource locator of the attachment. -
UserName: string
Read Only:
true
Maximum Length:255
Display name of the attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source