Jump to

• Request
• Response

Initiate interaction and wait for result

post

/hcmRestApi/resources/11.13.18.05/recruitingCESecuredAgentChat/action/invokeAsyncAndWaitForResult

Invokes the prompt asynchronously and waits for the result.

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
  Option that indicates whether the interaction is one-way or conversational.
• conversationId: string
  Conversation identifier associated with prompt interaction.
• message: string
  Details of the prompt.
• parameters: object parameters
  Additional Properties Allowed: additionalProperties

  Context and parameters required to execute the prompt.
• status: string
  Agent status after prompt invocation.
• workflowCode: string
  Agent workflow code to initiate the prompt.

{
    "type":"object",
    "properties":{
        "workflowCode":{
            "type":"string",
            "description":"Agent workflow code to initiate the prompt.",
            "nullable":true
        },
        "conversationId":{
            "type":"string",
            "description":"Conversation identifier associated with prompt interaction.",
            "nullable":true
        },
        "conversational":{
            "type":"string",
            "description":"Option that indicates whether the interaction is one-way or conversational.",
            "nullable":true
        },
        "message":{
            "type":"string",
            "description":"Details of the prompt.",
            "nullable":true
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Context and parameters required to execute the prompt.",
            "nullable":true
        },
        "status":{
            "type":"string",
            "description":"Agent status after prompt invocation.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Context and parameters required to execute the prompt.",
    "nullable":true
}

Context and parameters required to execute the prompt.

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 from the prompt execution.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Return response from the prompt execution."
        }
    },
    "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 from the prompt execution."
}

Return response from the prompt execution.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

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

Back to Top