Jump to

• Request
• Response

Process a file

post

/hcmRestApi/resources/11.13.18.05/communicateUIAudExclusions/action/processFile

Processes an uploaded audience exclusion file for validation and stores it as an attachment for the audience exclusion tracking record.

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

• attachments: array attachments
  Attachment details that contain the audience exclusion file to process.
• columnMapping: string
  Mapping of valid email columns in the uploaded file for audience exclusion processing.
• status: string
  Processing status of the uploaded exclusion file.

{
    "type":"object",
    "properties":{
        "attachments":{
            "type":"array",
            "description":"Attachment details that contain the audience exclusion file to process.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "columnMapping":{
            "type":"string",
            "description":"Mapping of valid email columns in the uploaded file for audience exclusion processing.",
            "nullable":true
        },
        "status":{
            "type":"string",
            "description":"Processing status of the uploaded exclusion file.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : attachments

Type: array

Attachment details that contain the audience exclusion file to process.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Attachment details that contain the audience exclusion file to process.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

  Returns the result of processing the audience exclusion file.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns the result of processing the audience exclusion file."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns the result of processing the audience exclusion file."
}

Returns the result of processing the audience exclusion file.

Back to Top