Get all data sets
get
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets
Request
Query Parameters
-
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- PrimaryKey Finds all the data sets that match the primary key criteria specified.
Finder Variables- DataSetId; integer; Unique identifier of the data set.
- findByRequestId Finds all the data sets that match the specified criteria.
Finder Variables- RequestId; integer; System-generated identifier for the request.
- PrimaryKey Finds all the data sets that match the primary key criteria specified.
-
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:- ContentId; string; Oracle WebCenter content server identifier for the file.
- DataSetId; integer; System-generated unique identifier for the data set.
- DataSetName; string; Name of the data set.
- DataSetStatusCode; string; Overall data set status derived from the transfer, import and load statuses.
- DataSetStatusMeaning; string; Description of the data set status.
- ImportStatusCode; string; Code for the import status of the data set.
- ImportStatusMeaning; string; Description of the import status of the data set.
- IntegrationTypeCode; string; Code for the integration type.
- IntegrationTypeMeaning; string; Description of the integration type of the data set.
- LoadStatusCode; string; Code for the status of loading staging table data into the application tables.
- LoadStatusMeaning; string; Description of load status of the data set.
- RequestId; integer; System-generated primary key for the request used to create the data set.
- SourceTypeCode; string; Code for the source type of the data set.
- SourceTypeMeaning; string; Description of the source type of the data set.
- SpreadsheetTemplateCode; string; Code of the spreadsheet template used to create the data set.
- SpreadsheetTemplateName; string; Name of the spreadsheet template used to create the data set.
- TransferStatusCode; string; Code for the file data transfer status from the Oracle WebCenter Content server for the data set.
- TransferStatusMeaning; string; Description of the transfer status for the data set.
-
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 : dataLoadDataSets
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 : dataLoadDataSets-item-response
Type:
Show Source
object
-
businessObjects: array
Data Set Business Objects
Title:
Data Set Business Objects
The businessObjects resource is a child of the dataLoadDataSets resource. It's used to view details of the business objects included in the data set. -
ContentId: string
Read Only:
true
Maximum Length:30
Oracle WebCenter content server identifier for the file. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User name of the person who submitted the data set. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the data set was created. -
DataSetId: integer
(int64)
Read Only:
true
System-generated unique identifier for the data set. -
DataSetName: string
Read Only:
true
Maximum Length:200
Name of the data set. -
DataSetStatusCode: string
Read Only:
true
Maximum Length:30
Overall data set status derived from the transfer, import and load statuses. -
DataSetStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the data set status. -
FailedLinesFileContentId: string
Read Only:
true
Maximum Length:30
Oracle WebCenter content server identifier for the generated failed lines file. -
FailedLinesFileEncryptionKey: string
Read Only:
true
Maximum Length:255
Name of the PGP certificate used to encrypt the failed lines file generated for the data set. -
FailedLinesFileEncryptionType: string
Read Only:
true
Maximum Length:30
Encryption key to use when encrypting the failed lines file. Specify the name of a valid PGP certificate other than fusion-key. -
FileLineImportErrorCount: integer
(int32)
Read Only:
true
Default Value:0
Number of data file lines within the data set that failed to import into the staging tables. -
FileLineImportSuccessCount: integer
(int32)
Read Only:
true
Default Value:0
Number of data file lines within the data set that were successfully imported into the staging tables. -
FileLineTotalCount: integer
(int32)
Read Only:
true
Default Value:0
Total number of data file lines found in all business objects files within the data set. -
FileSize: integer
(int64)
Read Only:
true
File size in bytes transferred from the Oracle WebCenter Content server. -
ImportPercentageComplete: integer
Read Only:
true
Percentage of records processed by the import process. -
ImportStatusCode: string
Read Only:
true
Maximum Length:30
Code for the import status of the data set. -
ImportStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the import status of the data set. -
ImportSuccessPercentage: integer
Read Only:
true
Percentage of records in the data set that are imported successfully. -
IntegrationTypeCode: string
Read Only:
true
Maximum Length:30
Code for the integration type. -
IntegrationTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the integration type of the data set. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the data set was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User name of the user who last updated the data set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadPercentageComplete: integer
Read Only:
true
Percentage of records processed by the load process. -
LoadStatusCode: string
Read Only:
true
Maximum Length:30
Code for the status of loading staging table data into the application tables. -
LoadStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of load status of the data set. -
LoadSuccessPercentage: integer
Read Only:
true
Percentage of objects in the data set that are loaded successfully. -
messages: array
Messages
Title:
Messages
The messages resource is a child of the dataLoadDataSets resource. It's used to view details of the messages raised for a data set, including the details of the record the message was raised against. -
ObjectLoadErrorCount: integer
(int32)
Read Only:
true
Default Value:0
Number of objects within the data set that failed to load into the application tables. -
ObjectRollbackErrorCount: integer
Read Only:
true
Number of objects within the data set that failed to be rolled back. -
ObjectSuccessCount: integer
(int32)
Read Only:
true
Default Value:0
Number of successfully processed business objects within the data set. -
ObjectTotalCount: integer
(int32)
Read Only:
true
Default Value:0
Total number of business objects within the data set. -
ObjectUnprocessedCount: integer
(int32)
Read Only:
true
Default Value:0
Count of unprocessed business objects within the data set. -
processes: array
Submitted Processes
Title:
Submitted Processes
The processes resource is a child of the dataLoadDataSets resource. It's used to view details of the processes submitted to action the data set. -
ProtectedFlag: boolean
Read Only:
true
Maximum Length:255
Indicates if the data set is protected from being deleted. -
RequestId: integer
(int64)
Read Only:
true
System-generated primary key for the request used to create the data set. -
Review: string
Read Only:
true
Maximum Length:255
Link to generate a spreadsheet to review the data set. -
SourceTypeCode: string
Read Only:
true
Maximum Length:30
Code for the source type of the data set. -
SourceTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the source type of the data set. -
SpreadsheetMessage: string
Read Only:
true
Maximum Length:500
Message associated with the spreadsheet data set. -
SpreadsheetTemplateCode: string
Read Only:
true
Maximum Length:80
Code of the spreadsheet template used to create the data set. -
SpreadsheetTemplateName: string
Read Only:
true
Maximum Length:120
Name of the spreadsheet template used to create the data set. -
SpreadsheetTemplateUserTypeCode: string
Read Only:
true
Maximum Length:50
Code for the user type of the spreadsheet template for the data set. -
SpreadsheetTemplateUserTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description for the user type of the spreadsheet template for the data set. -
TransferStatusCode: string
Read Only:
true
Maximum Length:30
Code for the file data transfer status from the Oracle WebCenter Content server for the data set. -
TransferStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the transfer status for the data set.
Nested Schema : Data Set Business Objects
Type:
array
Title:
Data Set Business Objects
The businessObjects resource is a child of the dataLoadDataSets resource. It's used to view details of the business objects included in the data set.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Messages
Type:
array
Title:
Messages
The messages resource is a child of the dataLoadDataSets resource. It's used to view details of the messages raised for a data set, including the details of the record the message was raised against.
Show Source
Nested Schema : Submitted Processes
Type:
array
Title:
Submitted Processes
The processes resource is a child of the dataLoadDataSets resource. It's used to view details of the processes submitted to action the data set.
Show Source
Nested Schema : dataLoadDataSets-businessObjects-item-response
Type:
Show Source
object
-
BusinessObjectDiscriminator: string
Read Only:
true
Maximum Length:100
Discriminator that identifies the business object. -
BusinessObjectId: integer
(int64)
Read Only:
true
System-generated unique identifier for the business object. -
BusinessObjectName: string
Read Only:
true
Maximum Length:100
Name of the business object. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User name of the person who created the data set business object. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the business object was created. -
DataSetBusObjId: integer
(int64)
Read Only:
true
System-generated unique identifier for the business object within the data set. -
DataSetId: integer
(int64)
Read Only:
true
System-generated unique identifier for the data set. -
DatFileName: string
Read Only:
true
Maximum Length:200
Name of the data file. Only applicable to compressed dat files processed by HCM Data Loader. -
FailedLinesFileContentId: string
Read Only:
true
Maximum Length:30
Oracle WebCenter content server identifier for the generated failed lines file. -
FailedLinesFileEncryptionKey: string
Read Only:
true
Maximum Length:255
Name of the PGP certificate used to encrypt the failed lines file generated for the business object. -
FailedLinesFileEncryptionType: string
Read Only:
true
Maximum Length:30
Encryption details for the generated failed lines file. -
FileLineImportErrorCount: integer
(int32)
Read Only:
true
Default Value:0
Number of data lines within the business object file that failed to import into the staging tables. -
FileLineImportSuccessCount: integer
(int32)
Read Only:
true
Default Value:0
Number of data file lines within the business object file that were successfully imported into the staging tables. -
FileLineTotalCount: integer
(int32)
Read Only:
true
Default Value:0
Total number of data lines found in the business object file. -
ImportPercentageComplete: integer
Read Only:
true
Percentage of records processed by the import process. -
ImportStatusCode: string
Read Only:
true
Maximum Length:30
Code for the import status of the business object objects. -
ImportStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the import status for the business objects. -
ImportSuccessPercentage: integer
Read Only:
true
Percentage of records in the business object file or spreadsheet that are imported successfully. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the data set business object was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User name of the person who last processed the data set business object. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadOrder: integer
(int64)
Read Only:
true
Default Value:1
Loading order of the business object within the data set. -
LoadPercentageComplete: integer
Read Only:
true
Percentage of records processed by the load process. -
LoadStatusCode: string
Read Only:
true
Maximum Length:30
Code for the loading status of the staging table data into the application tables. -
LoadStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the load status of the business objects. -
LoadSuccessPercentage: integer
Read Only:
true
Percentage of objects in the business object file or spreadsheet that are loaded successfully. -
ObjectLoadErrorCount: integer
(int32)
Read Only:
true
Default Value:0
Number of objects in the business object file or spreadsheet that failed to load into the application tables. -
ObjectRollbackErrorCount: integer
Read Only:
true
Number of objects in the business object file or spreadsheet that failed to be rolled back. -
ObjectSuccessCount: integer
(int32)
Read Only:
true
Default Value:0
Number of successfully processed business objects in the data file or spreadsheet. -
ObjectTotalCount: integer
(int32)
Read Only:
true
Default Value:0
Total number of objects found for the business object. -
ObjectUnprocessedCount: integer
(int32)
Read Only:
true
Default Value:0
Number of unprocessed business objects in the data file or spreadsheet. -
RequestId: integer
(int64)
Read Only:
true
Process identifier submitted to create the business object. -
RollbackEnabledFlag: boolean
Read Only:
true
Maximum Length:255
Indicates if the business object supports being rolled back. -
TransferStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:UNPROCESSED
Transfer status code for the business object file data from the Oracle WebCenter Content server. -
TransferStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the transfer status.
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 : dataLoadDataSets-messages-item-response
Type:
Show Source
object
-
BusinessObjectDiscriminator: string
Read Only:
true
Maximum Length:100
Discriminator of the business object in the message. -
ConcatenatedUserKey: string
Read Only:
true
Maximum Length:240
Concatenated user key values that identify the record. -
DataSetBusObjId: integer
(int64)
Read Only:
true
Surrogate identifier of the business object. -
DataSetId: integer
(int64)
Read Only:
true
System-generated unique identifier of the data set. -
DatFileName: string
Read Only:
true
Maximum Length:200
Name of the business object file. -
EffectiveEndDate: string
(date-time)
Read Only:
true
Effective end date of the record associated with the message. -
EffectiveLatestChange: string
Read Only:
true
Maximum Length:4
Effective latest change flag for the record associated with the message. -
EffectiveSequence: integer
Read Only:
true
Effective sequence number of the record associated with the message. -
EffectiveStartDate: string
(date-time)
Read Only:
true
Effective start date of the record associated with the message. -
FileLine: integer
Read Only:
true
File line number in the data file associated with the message. -
FusionGUID: string
Read Only:
true
Maximum Length:255
Globally unique identifier of the record associated with the message. -
GeneratedByCode: string
Read Only:
true
Maximum Length:120
Code for the generating source of the message. -
GeneratedByMeaning: string
Read Only:
true
Maximum Length:80
Name of the generating source of the message. -
LineOperation: string
Read Only:
true
Maximum Length:80
Operation supplied for the file line associated with the message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageLineId: integer
(int64)
Read Only:
true
System-generated identifier for the message. -
MessageText: string
Read Only:
true
Maximum Length:500
Error or warning message text. -
MessageTypeCode: string
Read Only:
true
Maximum Length:20
Code for the message type. -
MessageTypeMeaning: string
Read Only:
true
Maximum Length:80
Description of the message type. -
MessageUserDetails: string
Read Only:
true
Maximum Length:4000
User details of the message. -
OriginatingProcessCode: string
Read Only:
true
Maximum Length:30
Code for the originating process of the message. -
OriginatingProcessName: string
Read Only:
true
Maximum Length:80
Name of the originating process of the message. -
ReportedAgainstCode: string
Read Only:
true
Maximum Length:30
Code for the type of record associated with the message. -
ReportedAgainstMeaning: string
Read Only:
true
Maximum Length:80
Name of the type of record associated with the message. -
SourceReference001: string
Read Only:
true
Maximum Length:800
First source reference value of the record associated with the message. -
SourceReference002: string
Read Only:
true
Maximum Length:800
Second source reference value of the record associated with the message. -
SourceReference003: string
Read Only:
true
Maximum Length:800
Third source reference value of the record associated with the message. -
SourceReference004: string
Read Only:
true
Maximum Length:800
Fourth source reference value of the record associated with the message. -
SourceReference005: string
Read Only:
true
Maximum Length:800
Fifth source reference value of the record associated with the message. -
SourceReference006: string
Read Only:
true
Maximum Length:800
Sixth source reference value of the record associated with the message. -
SourceReference007: string
Read Only:
true
Maximum Length:800
Seventh source reference value of the record associated with the message. -
SourceReference008: string
Read Only:
true
Maximum Length:800
Eighth source reference value of the record associated with the message. -
SourceReference009: string
Read Only:
true
Maximum Length:800
Ninth source reference value of the record associated with the message. -
SourceReference010: string
Read Only:
true
Maximum Length:800
Tenth source reference value of the record associated with the message. -
SourceReferenceName001: string
Read Only:
true
Maximum Length:800
First source reference name of the record associated with the message. -
SourceReferenceName002: string
Read Only:
true
Maximum Length:800
Second source reference name of the record associated with the message. -
SourceReferenceName003: string
Read Only:
true
Maximum Length:800
Third source reference name of the record associated with the message. -
SourceReferenceName004: string
Read Only:
true
Maximum Length:800
Fourth source reference name of the record associated with the message. -
SourceReferenceName005: string
Read Only:
true
Maximum Length:800
Fifth source reference name of the record associated with the message. -
SourceReferenceName006: string
Read Only:
true
Maximum Length:800
Sixth source reference name of the record associated with the message. -
SourceReferenceName007: string
Read Only:
true
Maximum Length:800
Seventh source reference name of the record associated with the message. -
SourceReferenceName008: string
Read Only:
true
Maximum Length:800
Eighth source reference name of the record associated with the message. -
SourceReferenceName009: string
Read Only:
true
Maximum Length:800
Ninth source reference name of the record associated with the message. -
SourceReferenceName010: string
Read Only:
true
Maximum Length:800
Tenth source reference name of the record associated with the message. -
SourceSystemId: string
Read Only:
true
Maximum Length:2000
Source system identifier used to uniquely identify the record associated with the message. -
SourceSystemOwner: string
Read Only:
true
Maximum Length:256
Source system owner used to uniquely identify the record associated with the message. -
SurrogateId: integer
Read Only:
true
Surrogate identifier of the record the message associated with the message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : dataLoadDataSets-processes-item-response
Type:
Show Source
object
-
BusinessObjectName: string
Read Only:
true
Maximum Length:100
Name of the business object associated with the process. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User name of the user who submitted the process. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the process was requested. -
DataSetBusObjId: integer
(int64)
Read Only:
true
Unique identifier of the business object being processed within the data set. -
DataSetId: integer
(int64)
Read Only:
true
Unique identifier of the data set. -
DatFileName: string
Read Only:
true
Maximum Length:200
Name of the file processed. -
ElapsedTime: string
Read Only:
true
Maximum Length:108
Process running time. -
EndTime: string
(date-time)
Read Only:
true
Process end time. -
ErrorCount: integer
(int32)
Read Only:
true
Number of records that failed to be processed. -
FileActionCode: string
Read Only:
true
Maximum Length:120
Code of the action performed by the load business object process. -
FileActionMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the file action. -
LastUpdateDate: string
(date-time)
Read Only:
true
User name of the user who last updated the process. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last updated date and time for the process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentRequestId: integer
(int64)
Read Only:
true
Unique identifier of the parent request responsible for submitting this request. -
ProcessCode: string
Read Only:
true
Maximum Length:30
Name of the process. -
ProcessId: integer
(int64)
Read Only:
true
Unique identifier of the process record. -
ProcessName: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the process name. -
RequestId: integer
(int64)
Read Only:
true
Unique identifier of the request. -
StartTime: string
(date-time)
Read Only:
true
Process start time. -
subprocesses: array
Submitted Subprocesses
Title:
Submitted Subprocesses
The subprocesses resource is a child of the processes resource. It provides details of the subprocesses submitted by a specific HCM Data Loader data set process. -
SuccessCount: integer
(int32)
Read Only:
true
Number of successfully processed records. -
ThreadsAllocated: integer
(int32)
Read Only:
true
Number of concurrent threads allocated for the process. -
ThreadsUsed: integer
(int32)
Read Only:
true
Number of concurrent threads used by the process. -
TotalCount: integer
(int32)
Read Only:
true
Total number of records to be processed. -
UnprocessedCount: integer
(int32)
Read Only:
true
Count of unprocessed records.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Submitted Subprocesses
Type:
array
Title:
Submitted Subprocesses
The subprocesses resource is a child of the processes resource. It provides details of the subprocesses submitted by a specific HCM Data Loader data set process.
Show Source
Nested Schema : dataLoadDataSets-processes-subprocesses-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User name of the user who submitted the process. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the subprocess was requested. -
Elapsedtime: string
Read Only:
true
Maximum Length:108
Subprocess running time. -
EndTime: string
(date-time)
Read Only:
true
Subprocess end time. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last updated date and time for the subprocess. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User name of the user who last updated the subprocess. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Parentrequestid: integer
(int64)
Read Only:
true
Unique identifier of the request that initiated the subprocess. -
ProcessCode: string
Read Only:
true
Maximum Length:500
Code that identifies the subprocess. -
ProcessId: integer
(int64)
Read Only:
true
Unique identifier for the subprocess submission. -
ProcessName: string
Read Only:
true
Maximum Length:255
Name of the subprocess. -
ProcessStatusCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Code of the subprocess status. -
ProcessStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Default Value:NVL(post_proc_name,hcmlookuppeo_processname.meaning)
Description of the subprocess status. -
RequestId: integer
(int64)
Read Only:
true
Unique identifier of the request. -
StartTime: string
(date-time)
Read Only:
true
Subprocess start time.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- createFileDataSet
-
Submits a previously loaded compressed file to the Oracle WebCenter content server for processing by the HCM Data Loader. Specify whether to only import the file data into staging tables, or import and load valid objects into the application tables. The identifier for the data set creation request is returned. Use this to get the current data set status and perform additional actions.
- createSpreadsheetDataSet
-
Submits a file previously loaded to the Oracle WebCenter content server for processing by Oracle Fusion Cloud HCM Spreadsheet Data Loader. Specify the template code and whether to only import the file into the staging tables, or to import and load valid objects into the application tables. When you import and load data, the application returns the identifier for the data set creation request. Use this identifier to get the current data set status and perform other actions. When you only import the file into the staging tables, the application returns the data set name. You'll then need to manually load the data set from a spreadsheet generated using the same template. You can't initiate the load using REST service, if you've only imported the data to the staging tables.
- findByAdvancedSearchQuery
-
Finds all data sets using the specified advanced search query criteria.
- uploadFile
-
Uploads file to the HCM Data Loader import account of the Oracle WebCenter content server for processing by HCM Data Loader or HCM Spreadsheet Data Loader.