Update a staging header
patch
/fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}
Request
Path Parameters
-
LoadRequestId(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
-
LoaderId: integer
(int64)
Title:
Data Loader ID
The unique identifier for the import data load settings. -
statistics: array
Data Loader Statistics
Title:
Data Loader Statistics
Use the data loader statistics resource to view the statistics of the data import process.
Nested Schema : Data Loader Statistics
Type:
array
Title:
Data Loader Statistics
Use the data loader statistics resource to view the statistics of the data import process.
Show Source
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 : dataLoaderStagingHeaders-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Indicates who created a data loader common staging header. -
FileName: string
Title:
File Name
Maximum Length:250
The name of the file being processed or imported. -
FileTypeCode: string
Title:
File Type Code
Read Only:true
Maximum Length:30
Default Value:ORA_CSV
The type of file being set up for processing by the import data load process. The default value of the attribute is ORA_CSV. A list of accepted values is defined in the lookup type ORA_HEY_LOADER_FILE_TYPE. -
InitialLoadDateTime: string
(date-time)
Title:
Load Date Time
Read Only:true
The date and time of the initial data load. -
LastModifiedDate: string
(date-time)
Title:
Last Modified Date
Read Only:true
The date and time of the last modification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadCategoryCode: string
Title:
Load Category Code
Read Only:true
Maximum Length:30
Default Value:ORA_ADMISSIONS
The type of load that's being set up for processing by the import data load process. The default value of the attribute is ORA_ADMISSIONS_COMMON_APP. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_CATEGORY_CODE. -
LoadCategoryMeaning: string
Title:
Load Category
Read Only:true
Maximum Length:80
The meaning of the load category code. An example of a meaning is the admissions common application load. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_CATEGORY_CODE. -
LoaderCode: string
Title:
Loader Code
Read Only:true
Maximum Length:30
The alternate identifier for the import data load settings. -
LoaderId: integer
(int64)
Title:
Data Loader ID
The unique identifier for the import data load settings. -
LoaderName: string
Title:
Loader Name
Read Only:true
Maximum Length:50
The name of the data loader settings. -
LoadRequestId: integer
(int64)
Title:
Load Request ID
Read Only:true
The unique identifier for each file load. The import process populates this identifier. -
LoadStageCode: string
Title:
Load Stage Code
Read Only:true
Maximum Length:30
The stage code of the load. The default value of the attribute is ORA_INITIAL. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STAGE. -
LoadStageMeaning: string
Title:
Load Stage
Read Only:true
Maximum Length:80
The meaning of the load status code. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STATUS_CODE. -
LoadStatusCode: string
Title:
Load Status Code
Read Only:true
Maximum Length:30
Default Value:ORA_STAGED
The status code of the load. The default value of the attribute is ORA_NEW. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STATUS_CODE. -
LoadStatusMeaning: string
Title:
Load Status
Read Only:true
Maximum Length:80
The meaning of the load status code. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STATUS_CODE. -
ProcessingCode: string
Title:
Processing Required Flag
Read Only:true
Processing code that's used to process the load to the other stage. List of accepted values are PROCESS, IGNORE. -
statistics: array
Data Loader Statistics
Title:
Data Loader Statistics
Use the data loader statistics resource to view the statistics of the data import process.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Data Loader Statistics
Type:
array
Title:
Data Loader Statistics
Use the data loader statistics resource to view the statistics of the data import process.
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 : dataLoaderStagingHeaders-statistics-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadStatisticCode: string
Title:
Load Statistic Code
Read Only:true
Maximum Length:30
The code of the statistic from the import process. A list of accepted values is defined in the lookup type ORA_HEY_STAGING_STATISTICS. -
LoadStatisticInteger: integer
(int32)
Title:
Load Statistic Integer
Read Only:true
The value of the data import process statistic. -
LoadStatisticMeaning: string
Title:
Load Statistic Meaning
Read Only:true
Maximum Length:80
The meaning of the load statistic code. An example of a meaning is number of unprocessed rows. A list of accepted values is defined in the lookup type ORA_HEY_STAGING_STATISTICS. -
LoadStatisticsId: integer
(int64)
Title:
Load Statistic ID
Read Only:true
The unique identifier for the data loader statistic table.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- loadStageLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_LOAD_STAGE
The following properties are defined on the LOV link relation:- Source Attribute: LoadStageCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- loadStatusLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BLookupType%3DORA_HEY_LOAD_STATUS_CODE
The following properties are defined on the LOV link relation:- Source Attribute: LoadStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- statistics
-
Operation: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}/child/statisticsParameters:
- LoadRequestId:
$request.path.LoadRequestId
Use the data loader statistics resource to view the statistics of the data import process. - LoadRequestId: