Get a business object
get
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/businessObjects/{DataSetBusObjId}
Request
Path Parameters
-
DataSetBusObjId(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=
-
RequestId(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=
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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. -
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.
Links
- stop
-
Parameters:
- DataSetBusObjId:
$request.path.DataSetBusObjId
- RequestId:
$request.path.RequestId
Request that the processing of a business object is stopped. Any business object records already processed won't be rolled back. - DataSetBusObjId:
- submit
-
Parameters:
- DataSetBusObjId:
$request.path.DataSetBusObjId
- RequestId:
$request.path.RequestId
Submits a request to load or roll back a business object. - DataSetBusObjId: