Jump to

• Request
• Response

Validate file status for audience details

post

/hcmRestApi/resources/11.13.18.05/communicateUIQuickCampaigns/{CampaignId}/child/audienceDetails/action/resetMappings

Validates the file status for audience details during a quick campaign setup.

Request

Path Parameters

• CampaignId(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

• audienceId: number
  Unique identifier for the audience in the campaign.
• requestMap: object requestMap
  Additional Properties Allowed: additionalProperties

  Return value indicating the status of the file validation process.

{
    "type":"object",
    "properties":{
        "requestMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return value indicating the status of the file validation process.",
            "nullable":true
        },
        "audienceId":{
            "type":"number",
            "description":"Unique identifier for the audience in the campaign.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : requestMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return value indicating the status of the file validation process.",
    "nullable":true
}

Return value indicating the status of the file validation process.

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

  Audience identifier and operation type post reset operation.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Audience identifier and operation type post reset operation."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Audience identifier and operation type post reset operation."
}

Audience identifier and operation type post reset operation.

Back to Top