Jump to

• Request
• Response

Generate a failed lines file for the business object.

post

/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/businessObjects/{DataSetBusObjId}/action/generateFailedLinesFile

Submits a request to generate the data file lines that have failed to load for the specified business object.

Request

Path Parameters

• DataSetBusObjId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• RequestId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• encryptionKey: string
  Submits a request to generate the data file lines that have failed to load for the specified business object.
• fileEncryption: string
  Encryption type of the generated dat file. Valid values are NONE, PGPSIGNED, and PGPUNSIGNED.
• includeMessagesFlag: string
  Indicates if error messages should be included in the generated files. Valid valued are Y and N.
• messageLanguage: string
  Language of the error messages included in the generated file. Defaults to the session language.

{
    "type":"object",
    "properties":{
        "messageLanguage":{
            "type":"string",
            "description":"Language of the error messages included in the generated file. Defaults to the session language.",
            "nullable":true
        },
        "encryptionKey":{
            "type":"string",
            "description":"Submits a request to generate the data file lines that have failed to load for the specified business object.",
            "nullable":true
        },
        "fileEncryption":{
            "type":"string",
            "description":"Encryption type of the generated dat file. Valid values are NONE, PGPSIGNED, and PGPUNSIGNED.",
            "nullable":true
        },
        "includeMessagesFlag":{
            "type":"string",
            "description":"Indicates if error messages should be included in the generated files. Valid valued are Y and N.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Status of the generated failed lines file request.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Status of the generated failed lines file request."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Status of the generated failed lines file request."
}

Status of the generated failed lines file request.

Back to Top