Update one default header for the item-staged transaction
patch
/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/{TransactionDefaultsHeaderId}
Request
Path Parameters
-
TransactionDefaultsHeaderId(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=
Header Parameters
-
Metadata-Context: string
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: string
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ActionCode(required): string
Maximum Length:
18Value that identifies the create or update action for a default header of an item-staged transaction. -
AttachmentEntityName: string
Indicates the entity name of the attachment.
-
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
FailedLines: integer
(int64)
Value that identifies the total number of lines that failed to process for the default header of an item-staged transaction.
-
ItemStagedTransactionDefaultsLine: array
Defaults Lines for Staged Item Transactions
Title:
Defaults Lines for Staged Item TransactionsA line that's ready to process staged item transactions. -
LockFlagValue: string
Maximum Length:
30Value that identifies whether the header is picked for processing or not. -
ObjectVersionNumber: integer
(int32)
Indicates object version number for the record.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
-
PersonName: string
Maximum Length:
255Name of the user who submitted the record. -
ProcessId: integer
(int64)
Application-generated unique identifier for the request to create or update item-transaction defaults.
-
ProcessMode: string
Maximum Length:
80Mode in which the process is run. -
StatusCode: string
Maximum Length:
32Abbreviation that identifies the default header status of an item-staged transaction. -
StatusCodeMeaning: string
Maximum Length:
255Status code meaning of an item-staged transaction. -
SuccessfulLines: integer
(int64)
Value that identifies the total number of lines processed successfully for the default header of an item-staged transaction.
-
TotalLines(required): integer
(int64)
Value that identifies the total number of lines requested for processing for the default header of an item-staged transaction.
-
TransactionDefaultsHeaderId(required): integer
(int64)
Value that uniquely identifies the default header of the item-staged transaction. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Defaults Lines for Staged Item Transactions
Type:
arrayTitle:
Defaults Lines for Staged Item TransactionsA line that's ready to process staged item transactions.
Show Source
Nested Schema : schema
Type:
Show Source
object-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object-
BatchId: integer
(int64)
Value that identifies the batch in which the record has been loaded into the table.
-
DefaultType: string
Maximum Length:
30Value that identifies the transaction type. -
DefaultTypeMeaning: string
Maximum Length:
80Value that identifies the meaning of the transaction type. -
ErrorCode: string
Maximum Length:
240Code that identifies the status of the staged transaction's default lines. -
ErrorExplanation: string
Maximum Length:
240Explanation for the status of the staged transaction's default lines. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item in the inventory organization.
-
ItemNumber: string
Maximum Length:
300Number that identifies the item. -
NewLocatorId: integer
(int64)
Value that uniquely identifies the updated locator.
-
NewLocatorName: string
Maximum Length:
240Name of the updated locator in a subinventory where default lines of an item-staged transaction are created in the inventory organization. -
NewSubinventoryCode: string
Maximum Length:
10Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization. -
OldLocatorId: integer
(int64)
Value that uniquely identifies the locator prior to the update.
-
OldLocatorName: string
Maximum Length:
240Name of the locator in a subinventory prior to an update where default lines for an item-staged transaction are created in the inventory organization. -
OldSubinventoryCode: string
Maximum Length:
10Name of the subinventory prior to the update in which default lines for item-staged transactions are created in the inventory organization. -
OrganizationCode: string
Maximum Length:
18Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
-
OrganizationName: string
Maximum Length:
240Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction. -
StatusCode: string
Maximum Length:
18Value that identifies if the status of the default lines of the staged transaction is valid. -
SubDefault: string
Maximum Length:
11Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization. -
TransactionDefaultsHeaderId: integer
(int64)
Value that uniquely identifies the item-staged transaction header. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
-
TransactionDefaultsLineId: integer
(int64)
Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.
Response
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 : itemStagedTransactionDefaults-item-response
Type:
Show Source
object-
ActionCode: string
Maximum Length:
18Value that identifies the create or update action for a default header of an item-staged transaction. -
AttachmentEntityName: string
Indicates the entity name of the attachment.
-
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CreatedBy: string
Read Only:
trueMaximum Length:64Indicates the user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate when the record was created. -
FailedLines: integer
(int64)
Value that identifies the total number of lines that failed to process for the default header of an item-staged transaction.
-
ItemStagedTransactionDefaultsLine: array
Defaults Lines for Staged Item Transactions
Title:
Defaults Lines for Staged Item TransactionsA line that's ready to process staged item transactions. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the row. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LockFlagValue: string
Maximum Length:
30Value that identifies whether the header is picked for processing or not. -
ObjectVersionNumber: integer
(int32)
Indicates object version number for the record.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
-
PersonName: string
Maximum Length:
255Name of the user who submitted the record. -
ProcessId: integer
(int64)
Application-generated unique identifier for the request to create or update item-transaction defaults.
-
ProcessMode: string
Maximum Length:
80Mode in which the process is run. -
StatusCode: string
Maximum Length:
32Abbreviation that identifies the default header status of an item-staged transaction. -
StatusCodeMeaning: string
Maximum Length:
255Status code meaning of an item-staged transaction. -
SuccessfulLines: integer
(int64)
Value that identifies the total number of lines processed successfully for the default header of an item-staged transaction.
-
TotalLines: integer
(int64)
Value that identifies the total number of lines requested for processing for the default header of an item-staged transaction.
-
TransactionDefaultsHeaderId: integer
(int64)
Value that uniquely identifies the default header of the item-staged transaction. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Defaults Lines for Staged Item Transactions
Type:
arrayTitle:
Defaults Lines for Staged Item TransactionsA line that's ready to process staged item transactions.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : itemStagedTransactionDefaults-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : itemStagedTransactionDefaults-ItemStagedTransactionDefaultsLine-item-response
Type:
Show Source
object-
BatchId: integer
(int64)
Value that identifies the batch in which the record has been loaded into the table.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the row. -
DefaultType: string
Maximum Length:
30Value that identifies the transaction type. -
DefaultTypeMeaning: string
Maximum Length:
80Value that identifies the meaning of the transaction type. -
ErrorCode: string
Maximum Length:
240Code that identifies the status of the staged transaction's default lines. -
ErrorExplanation: string
Maximum Length:
240Explanation for the status of the staged transaction's default lines. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item in the inventory organization.
-
ItemNumber: string
Maximum Length:
300Number that identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the row. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NewLocatorId: integer
(int64)
Value that uniquely identifies the updated locator.
-
NewLocatorName: string
Maximum Length:
240Name of the updated locator in a subinventory where default lines of an item-staged transaction are created in the inventory organization. -
NewSubinventoryCode: string
Maximum Length:
10Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization. -
NewSubinventoryName: string
Read Only:
trueMaximum Length:30This represents the subinventory where the item is being moved to or received in the transaction. -
OldLocatorId: integer
(int64)
Value that uniquely identifies the locator prior to the update.
-
OldLocatorName: string
Maximum Length:
240Name of the locator in a subinventory prior to an update where default lines for an item-staged transaction are created in the inventory organization. -
OldSubinventoryCode: string
Maximum Length:
10Name of the subinventory prior to the update in which default lines for item-staged transactions are created in the inventory organization. -
OldSubinventoryName: string
Read Only:
trueMaximum Length:30This represents the subinventory from which the item is being issued or transferred in the transaction. -
OrganizationCode: string
Maximum Length:
18Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
-
OrganizationName: string
Maximum Length:
240Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction. -
StatusCode: string
Maximum Length:
18Value that identifies if the status of the default lines of the staged transaction is valid. -
SubDefault: string
Maximum Length:
11Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization. -
TransactionDefaultsHeaderId: integer
(int64)
Value that uniquely identifies the item-staged transaction header. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
-
TransactionDefaultsLineId: integer
(int64)
Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- TransactionDefaultsHeaderId:
$request.path.TransactionDefaultsHeaderId
The attachments resource is used to view, create, and update attachments. - TransactionDefaultsHeaderId:
- ItemStagedTransactionDefaultsLine
-
Parameters:
- TransactionDefaultsHeaderId:
$request.path.TransactionDefaultsHeaderId
A line that's ready to process staged item transactions. - TransactionDefaultsHeaderId:
Examples
This example describes how to update one default header for the item-staged transaction.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/itemStagedTransactionDefaults/TransactionDefaultsHeaderId"
For
example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/itemStagedTransactionDefaults/17002"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"ActionCode": "CREATE"
}
Example Response Body
The following example includes the contents of the response
body in JSON format:
{
"TransactionDefaultsHeaderId" : "17002",
"ActionCode" : "CREATE",
"TotalLines" : "1",
"SuccessfulLines" : "1",
"FailedLines" : "0",
"StatusCode" : "ORA_SUCCESS",
"LockFlagValue" : null,
"CreatedBy" : "WHSE_MGR_M1",
"ObjectVersionNumber" : 2,
"CreationDate" : "2024-02-08T08:03:20.001+00:00",
"ProcessId" : null,
"ProcessMode" : null,
"AttachmentEntityName" : "InvTransactionDefaults",
"StatusCodeMeaning" : "Success",
"OrganizationId" : null,
"PersonName" : "Oliver, Sam",
"@context" : {
"key" : "17002",
"headers" : {
"ETag" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
},
"links" : [ {
"rel" : "self",
"href" : "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/rest/rv:0b7e587f-d821-48f7-8d08-4360c6e54241/en/11.13.18.05:9/itemStagedTransactionDefaults/17002",
"name" : "itemStagedTransactionDefaults",
"kind" : "item"
}, {
"rel" : "canonical",
"href" : "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/rest/rv:0b7e587f-d821-48f7-8d08-4360c6e54241/en/11.13.18.05:9/itemStagedTransactionDefaults/17002",
"name" : "itemStagedTransactionDefaults",
"kind" : "item"
}, {
"rel" : "child",
"href" : "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/rest/rv:0b7e587f-d821-48f7-8d08-4360c6e54241/en/11.13.18.05:9/itemStagedTransactionDefaults/17002/child/Attachments",
"name" : "Attachments",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/rest/rv:0b7e587f-d821-48f7-8d08-4360c6e54241/en/11.13.18.05:9/itemStagedTransactionDefaults/17002/child/ItemStagedTransactionDefaultsLine",
"name" : "ItemStagedTransactionDefaultsLine",
"kind" : "collection"
} ]
}
}