Jump to

• Request
• Response

Call to initiate interaction

post

/hcmRestApi/resources/11.13.18.05/recruitingCESecuredAgentChat/action/invokeAsync

Invokes a call to initiate interaction.

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

• conversational: string
  Conversational element to prompt interaction.
• conversationId: string
  Conversation identifier to prompt interaction.
• message: string
  Message to prompt interaction.
• parameters: object parameters
  Additional Properties Allowed: additionalProperties

  Additional context parameter to prompt interaction.
• status: string
  Agent status to prompt interaction.
• version: number
  Agent version to prompt interaction.
• workflowCode: string
  Agent work flow code to initiate interaction

{
    "type":"object",
    "properties":{
        "workflowCode":{
            "type":"string",
            "description":"Agent work flow code to initiate interaction",
            "nullable":true
        },
        "conversationId":{
            "type":"string",
            "description":"Conversation identifier to prompt interaction.",
            "nullable":true
        },
        "conversational":{
            "type":"string",
            "description":"Conversational element to prompt interaction.",
            "nullable":true
        },
        "message":{
            "type":"string",
            "description":"Message to prompt interaction.",
            "nullable":true
        },
        "version":{
            "type":"number",
            "description":"Agent version to prompt interaction.",
            "nullable":true
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Additional context parameter to prompt interaction.",
            "nullable":true
        },
        "status":{
            "type":"string",
            "description":"Agent status to prompt interaction.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Additional context parameter to prompt interaction.",
    "nullable":true
}

Additional context parameter to prompt interaction.

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

  Return response for further interaction.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Return response for further interaction."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Return response for further interaction."
}

Return response for further interaction.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top