Jump to

• Request
• Response

Submit Remove Person Information

post

/hcmRestApi/resources/11.13.18.05/removePersonInformation/action/submitRemove

Submits a request to remove person related information based on the template and population specified.

Request

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

• deleteSourceFileFlag: string
  Indicates if the source file should be deleted after the data is imported into the staging tables.
• importThreadCount: string
  Maximum number of concurrent threads to assign to the import process.
• invokePostProcessFlag: string
  Indicates if post processes should be submitted.
• loadThreadCount: string
  Maximum number of concurrent threads to assign to the load process.
• personNumberEncodedFile: string
  Base64 encoded comma-delimited file of the person numbers of the population to remove.
• personNumberFileName: string
  Name of the file to use when uploading.
• personNumberList: string
  Comma-delimited list of person numbers of the population to remove.
• processName: string
  Name to identify the process submission.
• templateCode: string
  Code of the template that defines the data to remove.

{
    "type":"object",
    "properties":{
        "deleteSourceFileFlag":{
            "type":"string",
            "description":"Indicates if the source file should be deleted after the data is imported into the staging tables.",
            "nullable":true
        },
        "loadThreadCount":{
            "type":"string",
            "description":"Maximum number of concurrent threads to assign to the load process.",
            "nullable":true
        },
        "processName":{
            "type":"string",
            "description":"Name to identify the process submission.",
            "nullable":true
        },
        "personNumberEncodedFile":{
            "type":"string",
            "description":"Base64 encoded comma-delimited file of the person numbers of the population to remove.",
            "nullable":true
        },
        "personNumberList":{
            "type":"string",
            "description":"Comma-delimited list of person numbers of the population to remove.",
            "nullable":true
        },
        "invokePostProcessFlag":{
            "type":"string",
            "description":"Indicates if post processes should be submitted.",
            "nullable":true
        },
        "templateCode":{
            "type":"string",
            "description":"Code of the template that defines the data to remove.",
            "nullable":true
        },
        "importThreadCount":{
            "type":"string",
            "description":"Maximum number of concurrent threads to assign to the import process.",
            "nullable":true
        },
        "personNumberFileName":{
            "type":"string",
            "description":"Name of the file to use when uploading.",
            "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 submit request. Returns the identifier of the request if it was submitted successfully.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Status of the submit request. Returns the identifier of the request if it was submitted successfully."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Status of the submit request. Returns the identifier of the request if it was submitted successfully."
}

Status of the submit request. Returns the identifier of the request if it was submitted successfully.

Back to Top