Jump to

• Request
• Response

Create a secure agent chat

post

/hcmRestApi/resources/11.13.18.05/recruitingCESecuredAgentChat

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Citations: object Citations
  Citation for secure agent chat.
• ConversationId: string
  Conversation identifier for secure agent chat.
• EndDate: integer
  End date of a secure agent chat.
• Error: string
  Error of a secure agent chat.
• FollowUpQuestions: object FollowUpQuestions
  Follow up question for a secure agent chat.
• Input: string
  Key for a secure agent chat.
• JobId: string
  Job identifier of a secure agent chat.
• Output: string
  Results returned from a secure agent chat.
• StartDate: integer
  Start date of a secure agent chat.
• States: object States
  State of a secure agent chat.
• Status: string
  Status of a secure agent chat.
• SupportingChunks: object SupportingChunks
  Supporting chunk of a secure agent chat.
• TraceId: string
  Trace identifier of a secure agent chat.
• WorkflowCode: string
  Workflow code for a secure agent chat.
• WorkflowStatus: string
  Workflow status for a secure agent chat.
• WorkflowVersion: integer
  Workflow version for a secure agent chat.

{
    "type":"object",
    "properties":{
        "Citations":{
            "type":"object",
            "description":"Citation for secure agent chat.",
            "nullable":true
        },
        "ConversationId":{
            "type":"string",
            "description":"Conversation identifier for secure agent chat.",
            "nullable":true
        },
        "EndDate":{
            "type":"integer",
            "description":"End date of a secure agent chat.",
            "nullable":true
        },
        "Error":{
            "type":"string",
            "description":"Error of a secure agent chat.",
            "nullable":true
        },
        "FollowUpQuestions":{
            "type":"object",
            "description":"Follow up question for a secure agent chat.",
            "nullable":true
        },
        "Input":{
            "type":"string",
            "description":"Key for a secure agent chat.",
            "nullable":true
        },
        "JobId":{
            "type":"string",
            "description":"Job identifier of a secure agent chat.",
            "nullable":true
        },
        "Output":{
            "type":"string",
            "description":"Results returned from a secure agent chat.",
            "nullable":true
        },
        "StartDate":{
            "type":"integer",
            "description":"Start date of a secure agent chat.",
            "nullable":true
        },
        "States":{
            "type":"object",
            "description":"State of a secure agent chat.",
            "nullable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of a secure agent chat.",
            "nullable":true
        },
        "SupportingChunks":{
            "type":"object",
            "description":"Supporting chunk of a secure agent chat.",
            "nullable":true
        },
        "TraceId":{
            "type":"string",
            "description":"Trace identifier of a secure agent chat.",
            "nullable":true
        },
        "WorkflowCode":{
            "type":"string",
            "description":"Workflow code for a secure agent chat.",
            "nullable":true
        },
        "WorkflowStatus":{
            "type":"string",
            "description":"Workflow status for a secure agent chat.",
            "nullable":true
        },
        "WorkflowVersion":{
            "type":"integer",
            "description":"Workflow version for a secure agent chat.",
            "nullable":true
        }
    }
}

Nested Schema : Citations

Type: object

Citation for secure agent chat.

Nested Schema : FollowUpQuestions

Type: object

Follow up question for a secure agent chat.

Nested Schema : States

Type: object

State of a secure agent chat.

Nested Schema : SupportingChunks

Type: object

Supporting chunk of a secure agent chat.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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:
  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.

Body ()

Root Schema : recruitingCESecuredAgentChat-item-response

Type: object

Show Source

• Citations: object Citations
  Citation for secure agent chat.
• ConversationId: string
  Conversation identifier for secure agent chat.
• EndDate: integer
  End date of a secure agent chat.
• Error: string
  Error of a secure agent chat.
• FollowUpQuestions: object FollowUpQuestions
  Follow up question for a secure agent chat.
• Input: string
  Key for a secure agent chat.
• JobId: string
  Job identifier of a secure agent chat.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Output: string
  Results returned from a secure agent chat.
• StartDate: integer
  Start date of a secure agent chat.
• States: object States
  State of a secure agent chat.
• Status: string
  Status of a secure agent chat.
• SupportingChunks: object SupportingChunks
  Supporting chunk of a secure agent chat.
• TraceId: string
  Trace identifier of a secure agent chat.
• WorkflowCode: string
  Workflow code for a secure agent chat.
• WorkflowStatus: string
  Workflow status for a secure agent chat.
• WorkflowVersion: integer
  Workflow version for a secure agent chat.

{
    "type":"object",
    "properties":{
        "Citations":{
            "type":"object",
            "description":"Citation for secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversationId":{
            "type":"string",
            "description":"Conversation identifier for secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"integer",
            "description":"End date of a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "Error":{
            "type":"string",
            "description":"Error of a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "FollowUpQuestions":{
            "type":"object",
            "description":"Follow up question for a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "Input":{
            "type":"string",
            "description":"Key for a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"string",
            "description":"Job identifier of a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "Output":{
            "type":"string",
            "description":"Results returned from a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"integer",
            "description":"Start date of a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "States":{
            "type":"object",
            "description":"State of a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "SupportingChunks":{
            "type":"object",
            "description":"Supporting chunk of a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "TraceId":{
            "type":"string",
            "description":"Trace identifier of a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkflowCode":{
            "type":"string",
            "description":"Workflow code for a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkflowStatus":{
            "type":"string",
            "description":"Workflow status for a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkflowVersion":{
            "type":"integer",
            "description":"Workflow version for a secure agent chat.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Citations

Type: object

Citation for secure agent chat.

Nested Schema : FollowUpQuestions

Type: object

Follow up question for a secure agent chat.

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : States

Type: object

State of a secure agent chat.

Nested Schema : SupportingChunks

Type: object

Supporting chunk of a secure agent chat.

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top