Jump to

• Request
• Response

Get a data set

get

/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}

Request

Path Parameters

• 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 Top

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.

Body ()

Root Schema : dataLoadDataSets-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LoadSuccessPercentage":{
            "type":"integer",
            "description":"Percentage of objects in the data set that are loaded successfully.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the data set was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ObjectUnprocessedCount":{
            "type":"integer",
            "description":"Count of unprocessed business objects within the data set.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "SpreadsheetTemplateName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the spreadsheet template used to create the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DataSetStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Overall data set status derived from the transfer, import and load statuses.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DataSetStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the data set status.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the source type of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Review":{
            "maxLength":"255",
            "type":"string",
            "description":"Link to generate a spreadsheet to review the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TransferStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the file data transfer status from the Oracle WebCenter Content server for the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ObjectSuccessCount":{
            "type":"integer",
            "description":"Number of successfully processed business objects within the data set.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "SpreadsheetMessage":{
            "maxLength":"500",
            "type":"string",
            "description":"Message associated with the spreadsheet data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DataSetName":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ImportStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the import status of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "IntegrationTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the integration type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ImportStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the import status of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FailedLinesFileEncryptionKey":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the PGP certificate used to encrypt the failed lines file generated for the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransferStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the transfer status for the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User name of the user who last updated the data set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SpreadsheetTemplateCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Code of the spreadsheet template used to create the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "processes":{
            "title":"Submitted Processes",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/dataLoadDataSets-processes-item-response"
            }
        },
        "SourceTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the source type of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User name of the person who submitted the data set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequestId":{
            "type":"integer",
            "description":"System-generated primary key for the request used to create the data set.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ImportSuccessPercentage":{
            "type":"integer",
            "description":"Percentage of records in the data set that are imported successfully.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SpreadsheetTemplateUserTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description for the user type of the spreadsheet template for the data set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FailedLinesFileEncryptionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Encryption key to use when encrypting the failed lines file. Specify the name of a valid PGP certificate other than fusion-key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LoadStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of load status of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ObjectLoadErrorCount":{
            "type":"integer",
            "description":"Number of objects within the data set that failed to load into the application tables.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "SpreadsheetTemplateUserTypeCode":{
            "maxLength":"50",
            "type":"string",
            "description":"Code for the user type of the spreadsheet template for the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LoadPercentageComplete":{
            "type":"integer",
            "description":"Percentage of records processed by the load process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DataSetId":{
            "type":"integer",
            "description":"System-generated unique identifier for the data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ImportPercentageComplete":{
            "type":"integer",
            "description":"Percentage of records processed by the import process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileLineImportSuccessCount":{
            "type":"integer",
            "description":"Number of data file lines within the data set that were successfully imported into the staging tables.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "businessObjects":{
            "title":"Data Set Business Objects",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/dataLoadDataSets-businessObjects-item-response"
            }
        },
        "FileLineTotalCount":{
            "type":"integer",
            "description":"Total number of data file lines found in all business objects files within the data set.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "FileLineImportErrorCount":{
            "type":"integer",
            "description":"Number of data file lines within the data set that failed to import into the staging tables.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "IntegrationTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the integration type of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FailedLinesFileContentId":{
            "maxLength":"30",
            "type":"string",
            "description":"Oracle WebCenter content server identifier for the generated failed lines file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "messages":{
            "title":"Messages",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/dataLoadDataSets-messages-item-response"
            }
        },
        "ContentId":{
            "maxLength":"30",
            "type":"string",
            "description":"Oracle WebCenter content server identifier for the file.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LoadStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the status of loading staging table data into the application tables.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ProtectedFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if the data set is protected from being deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ObjectTotalCount":{
            "type":"integer",
            "description":"Total number of business objects within the data set.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "ObjectRollbackErrorCount":{
            "type":"integer",
            "description":"Number of objects within the data set that failed to be rolled back.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileSize":{
            "type":"integer",
            "description":"File size in bytes transferred from the Oracle WebCenter Content server.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the data set was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

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

• Array of: object dataLoadDataSets-businessObjects-item-response

{
    "title":"Data Set Business Objects",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/dataLoadDataSets-businessObjects-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object dataLoadDataSets-messages-item-response

{
    "title":"Messages",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/dataLoadDataSets-messages-item-response"
    }
}

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

• Array of: object dataLoadDataSets-processes-item-response

{
    "title":"Submitted Processes",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/dataLoadDataSets-processes-item-response"
    }
}

Nested Schema : dataLoadDataSets-businessObjects-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LoadSuccessPercentage":{
            "type":"integer",
            "description":"Percentage of objects in the business object file or spreadsheet that are loaded successfully.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the business object was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ObjectUnprocessedCount":{
            "type":"integer",
            "description":"Number of unprocessed business objects in the data file or spreadsheet.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "RollbackEnabledFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if the business object supports being rolled back.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DataSetBusObjId":{
            "type":"integer",
            "description":"System-generated unique identifier for the business object within the data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LoadOrder":{
            "type":"integer",
            "description":"Loading order of the business object within the data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "TransferStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Transfer status code for the business object file data from the Oracle WebCenter Content server.",
            "nullable":false,
            "readOnly":true,
            "default":"UNPROCESSED",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ObjectSuccessCount":{
            "type":"integer",
            "description":"Number of successfully processed business objects in the data file or spreadsheet.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "ImportStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the import status of the business object objects.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ImportStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the import status for the business objects.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FailedLinesFileEncryptionKey":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the PGP certificate used to encrypt the failed lines file generated for the business object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessObjectDiscriminator":{
            "maxLength":"100",
            "type":"string",
            "description":"Discriminator that identifies the business object.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BusinessObjectName":{
            "maxLength":"100",
            "type":"string",
            "description":"Name of the business object.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TransferStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the transfer status.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User name of the person who last processed the data set business object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User name of the person who created the data set business object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequestId":{
            "type":"integer",
            "description":"Process identifier submitted to create the business object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "ImportSuccessPercentage":{
            "type":"integer",
            "description":"Percentage of records in the business object file or spreadsheet that are imported successfully.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FailedLinesFileEncryptionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Encryption details for the generated failed lines file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LoadStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the load status of the business objects.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ObjectLoadErrorCount":{
            "type":"integer",
            "description":"Number of objects in the business object file or spreadsheet that failed to load into the application tables.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "LoadPercentageComplete":{
            "type":"integer",
            "description":"Percentage of records processed by the load process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DataSetId":{
            "type":"integer",
            "description":"System-generated unique identifier for the data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "DatFileName":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the data file. Only applicable to compressed dat files processed by HCM Data Loader.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ImportPercentageComplete":{
            "type":"integer",
            "description":"Percentage of records processed by the import process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileLineImportSuccessCount":{
            "type":"integer",
            "description":"Number of data file lines within the business object file that were successfully imported into the staging tables.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "FileLineTotalCount":{
            "type":"integer",
            "description":"Total number of data lines found in the business object file.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "FileLineImportErrorCount":{
            "type":"integer",
            "description":"Number of data lines within the business object file that failed to import into the staging tables.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "BusinessObjectId":{
            "type":"integer",
            "description":"System-generated unique identifier for the business object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "FailedLinesFileContentId":{
            "maxLength":"30",
            "type":"string",
            "description":"Oracle WebCenter content server identifier for the generated failed lines file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LoadStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the loading status of the staging table data into the application tables.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ObjectTotalCount":{
            "type":"integer",
            "description":"Total number of objects found for the business object.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "ObjectRollbackErrorCount":{
            "type":"integer",
            "description":"Number of objects in the business object file or spreadsheet that failed to be rolled back.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the data set business object was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : dataLoadDataSets-messages-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "SourceReferenceName005":{
            "maxLength":"800",
            "type":"string",
            "description":"Fifth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName006":{
            "maxLength":"800",
            "type":"string",
            "description":"Sixth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference001":{
            "maxLength":"800",
            "type":"string",
            "description":"First source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReferenceName003":{
            "maxLength":"800",
            "type":"string",
            "description":"Third source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference002":{
            "maxLength":"800",
            "type":"string",
            "description":"Second source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveLatestChange":{
            "maxLength":"4",
            "type":"string",
            "description":"Effective latest change flag for the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName004":{
            "maxLength":"800",
            "type":"string",
            "description":"Fourth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference003":{
            "maxLength":"800",
            "type":"string",
            "description":"Third source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReferenceName009":{
            "maxLength":"800",
            "type":"string",
            "description":"Ninth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference004":{
            "maxLength":"800",
            "type":"string",
            "description":"Fourth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReference005":{
            "maxLength":"800",
            "type":"string",
            "description":"Fifth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName007":{
            "maxLength":"800",
            "type":"string",
            "description":"Seventh source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference006":{
            "maxLength":"800",
            "type":"string",
            "description":"Sixth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DataSetBusObjId":{
            "type":"integer",
            "description":"Surrogate identifier of the business object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceReferenceName008":{
            "maxLength":"800",
            "type":"string",
            "description":"Eighth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference007":{
            "maxLength":"800",
            "type":"string",
            "description":"Seventh source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MessageUserDetails":{
            "maxLength":"4000",
            "type":"string",
            "description":"User details of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference008":{
            "maxLength":"800",
            "type":"string",
            "description":"Eighth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReference009":{
            "maxLength":"800",
            "type":"string",
            "description":"Ninth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReportedAgainstCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the type of record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceSystemId":{
            "maxLength":"2000",
            "type":"string",
            "description":"Source system identifier used to uniquely identify the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReferenceName001":{
            "maxLength":"800",
            "type":"string",
            "description":"First source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName002":{
            "maxLength":"800",
            "type":"string",
            "description":"Second source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileLine":{
            "type":"integer",
            "description":"File line number in the data file associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "MessageTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Code for the message type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveSequence":{
            "type":"integer",
            "description":"Effective sequence number of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OriginatingProcessName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the originating process of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConcatenatedUserKey":{
            "maxLength":"240",
            "type":"string",
            "description":"Concatenated user key values that identify the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "BusinessObjectDiscriminator":{
            "maxLength":"100",
            "type":"string",
            "description":"Discriminator of the business object in the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceReference010":{
            "maxLength":"800",
            "type":"string",
            "description":"Tenth source reference value of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceSystemOwner":{
            "maxLength":"256",
            "type":"string",
            "description":"Source system owner used to uniquely identify the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ReportedAgainstMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the type of record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the record associated with the message.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FusionGUID":{
            "maxLength":"255",
            "type":"string",
            "description":"Globally unique identifier of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeneratedByCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Code for the generating source of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SurrogateId":{
            "type":"integer",
            "description":"Surrogate identifier of the record the message associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DataSetId":{
            "type":"integer",
            "description":"System-generated unique identifier of the data set.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "DatFileName":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the business object file.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":"500",
            "type":"string",
            "description":"Error or warning message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceReferenceName010":{
            "maxLength":"800",
            "type":"string",
            "description":"Tenth source reference name of the record associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OriginatingProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the originating process of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeneratedByMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the generating source of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageLineId":{
            "type":"integer",
            "description":"System-generated identifier for the message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "MessageTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of the message type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineOperation":{
            "maxLength":"80",
            "type":"string",
            "description":"Operation supplied for the file line associated with the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the record associated with the message.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : dataLoadDataSets-processes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the process was requested.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ProcessName":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the process name.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"Process end time.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ParentRequestId":{
            "type":"integer",
            "description":"Unique identifier of the parent request responsible for submitting this request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "FileActionCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Code of the action performed by the load business object process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DataSetBusObjId":{
            "type":"integer",
            "description":"Unique identifier of the business object being processed within the data set.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ElapsedTime":{
            "maxLength":"108",
            "type":"string",
            "description":"Process running time.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileActionMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the file action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SuccessCount":{
            "type":"integer",
            "description":"Number of successfully processed records.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "ErrorCount":{
            "type":"integer",
            "description":"Number of records that failed to be processed.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "UnprocessedCount":{
            "type":"integer",
            "description":"Count of unprocessed records.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessObjectName":{
            "maxLength":"100",
            "type":"string",
            "description":"Name of the business object associated with the process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ThreadsAllocated":{
            "type":"integer",
            "description":"Number of concurrent threads allocated for the process.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Last updated date and time for the process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User name of the user who submitted the process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RequestId":{
            "type":"integer",
            "description":"Unique identifier of the request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "ProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the process.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Process start time.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ThreadsUsed":{
            "type":"integer",
            "description":"Number of concurrent threads used by the process.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "DataSetId":{
            "type":"integer",
            "description":"Unique identifier of the data set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "DatFileName":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the file processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TotalCount":{
            "type":"integer",
            "description":"Total number of records to be processed.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "subprocesses":{
            "title":"Submitted Subprocesses",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/dataLoadDataSets-processes-subprocesses-item-response"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the process record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User name of the user who last updated the process.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object dataLoadDataSets-processes-subprocesses-item-response

{
    "title":"Submitted Subprocesses",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/dataLoadDataSets-processes-subprocesses-item-response"
    }
}

Nested Schema : dataLoadDataSets-processes-subprocesses-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User name of the user who last updated the subprocess.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the subprocess was requested.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStatusMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the subprocess status.",
            "nullable":false,
            "readOnly":true,
            "default":"NVL(post_proc_name,hcmlookuppeo_processname.meaning)",
            "x-queryable":true
        },
        "ProcessName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the subprocess.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User name of the user who submitted the process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"Unique identifier of the request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"Subprocess end time.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Elapsedtime":{
            "maxLength":"108",
            "type":"string",
            "description":"Subprocess running time.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessCode":{
            "maxLength":"500",
            "type":"string",
            "description":"Code that identifies the subprocess.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Subprocess start time.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStatusCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the subprocess status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Parentrequestid":{
            "type":"integer",
            "description":"Unique identifier of the request that initiated the subprocess.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier for the subprocess submission.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date and time for the subprocess.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

businessObjects

Operation: /hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/businessObjects

Parameters:

• RequestId: $request.path.RequestId

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.

deleteDataSet

Operation: /hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/deleteDataSet

Parameters:

• RequestId: $request.path.RequestId

Submits a request to delete the staging table data for the specified data set from the HCM Data Loader staging tables.

deleteSpreadsheetDataSet

Operation: /hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/deleteSpreadsheetDataSet

Parameters:

• RequestId: $request.path.RequestId

Submits a request to delete a spreadsheet data set from the HCM Spreadsheet Data Loader and HCM Data Loader staging tables.

generateFailedLinesFile

Operation: /hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/generateFailedLinesFile

Parameters:

• RequestId: $request.path.RequestId

Submits a request to generate files of the data lines that have failed to load for each business object within the data set which are then compressed into a single file.

messages

Operation: /hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/messages

Parameters:

• RequestId: $request.path.RequestId

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.

processes

Operation: /hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/processes

Parameters:

• RequestId: $request.path.RequestId

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.

stop

Operation: /hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/stop

Parameters:

• RequestId: $request.path.RequestId

Request that the data set processing is stopped. Any business object records already processed won't be rolled back.

submit

Operation: /hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/submit

Parameters:

• RequestId: $request.path.RequestId

Submits a request to load or rollback a data set. Roll back is only initiated for business objects that support the roll back action.

Back to Top