Jump to

• Request
• Response

Create an interaction

post

/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• InteractionRecipients: array Recruiting Interaction Recipients
  Title: Recruiting Interaction Recipients

  The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.

{
    "type":"object",
    "properties":{
        "InteractionRecipients":{
            "title":"Recruiting Interaction Recipients",
            "type":"array",
            "description":"The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIInteractions-InteractionRecipients-item-post-request"
            }
        }
    }
}

Nested Schema : Recruiting Interaction Recipients

Type: array

Title: Recruiting Interaction Recipients

The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.

Show Source

• Array of: object recruitingUIInteractions-InteractionRecipients-item-post-request

{
    "title":"Recruiting Interaction Recipients",
    "type":"array",
    "description":"The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIInteractions-InteractionRecipients-item-post-request"
    }
}

Nested Schema : recruitingUIInteractions-InteractionRecipients-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : recruitingUIInteractions-item-response

Type: object

Show Source

• AddedByPersonId: integer
  Read Only: true

  Unique identifier of the person who added the interaction.
• ContextId: integer
  Read Only: true

  Unique identifier of the context.
• ContextTypeCode: string
  Title: Context

  Read Only: true

  Maximum Length: 30

  Code of the context type
• DisplayName: string
  Title: Name

  Read Only: true

  Display name of the interaction.
• EventName: string
  Read Only: true

  Name of the event of the interaction.
• EventNumber: string
  Read Only: true

  Number of the event of the interaction.
• HiringTeamInternalFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the interaction is internal to the hiring team.
• InteractionDate: string
  Title: Interaction Date

  Read Only: true

  Date of the interaction.
• InteractionId: integer
  Read Only: true

  Unique identifier of the interaction.
• InteractionRecipients: array Recruiting Interaction Recipients
  Title: Recruiting Interaction Recipients

  The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.
• InteractionTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code of the type of interaction.
• InteractionTypeLabel: string
  Title: Interaction Type

  Read Only: true

  Label of the type of interaction.
• InteractionView: string
  Read Only: true

  Type of interaction view.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer
  Read Only: true

  Unique identifier of the person.
• PoolName: string
  Read Only: true

  Name of the pool to which the interaction is related.
• RequisitionNumber: string
  Read Only: true

  Requisition number of the requisition to which the interaction is related.
• Text: string
  Title: Interaction Note

  Read Only: true

  Text of the interaction.
• Title: string
  Read Only: true

  Title of the interaction.

{
    "type":"object",
    "properties":{
        "AddedByPersonId":{
            "type":"integer",
            "description":"Unique identifier of the person who added the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContextId":{
            "type":"integer",
            "description":"Unique identifier of the context.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContextTypeCode":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Code of the context type",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "type":"string",
            "description":"Display name of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventName":{
            "type":"string",
            "description":"Name of the event of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventNumber":{
            "type":"string",
            "description":"Number of the event of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HiringTeamInternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the interaction is internal to the hiring team.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionDate":{
            "title":"Interaction Date",
            "type":"string",
            "description":"Date of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "type":"integer",
            "description":"Unique identifier of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionRecipients":{
            "title":"Recruiting Interaction Recipients",
            "type":"array",
            "description":"The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIInteractions-InteractionRecipients-item-response"
            }
        },
        "InteractionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the type of interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionTypeLabel":{
            "title":"Interaction Type",
            "type":"string",
            "description":"Label of the type of interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionView":{
            "type":"string",
            "description":"Type of interaction view.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PoolName":{
            "type":"string",
            "description":"Name of the pool to which the interaction is related.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "type":"string",
            "description":"Requisition number of the requisition to which the interaction is related.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Text":{
            "title":"Interaction Note",
            "type":"string",
            "description":"Text of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "type":"string",
            "description":"Title of the interaction.",
            "nullable":true,
            "readOnly":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 : Recruiting Interaction Recipients

Type: array

Title: Recruiting Interaction Recipients

The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.

Show Source

• Array of: object recruitingUIInteractions-InteractionRecipients-item-response

{
    "title":"Recruiting Interaction Recipients",
    "type":"array",
    "description":"The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIInteractions-InteractionRecipients-item-response"
    }
}

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 : recruitingUIInteractions-InteractionRecipients-item-response

Type: object

Show Source

• AgentId: integer
  Read Only: true

  Unique identifier of the agent.
• ContextTypeCode: string
  Read Only: true

  Code of the context type.
• DisplayName: string
  Read Only: true

  Display name of the recipient.
• InteractionId: integer
  Read Only: true

  Unique identifier of the interaction.
• InteractionRecipientId: integer
  Read Only: true

  Unique identifier of the interaction recipient.
• InteractionView: string
  Read Only: true

  Type of interaction view.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer
  Read Only: true

  Unique identifier of the person.

{
    "type":"object",
    "properties":{
        "AgentId":{
            "type":"integer",
            "description":"Unique identifier of the agent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContextTypeCode":{
            "type":"string",
            "description":"Code of the context type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "type":"string",
            "description":"Display name of the recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionId":{
            "type":"integer",
            "description":"Unique identifier of the interaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionRecipientId":{
            "type":"integer",
            "description":"Unique identifier of the interaction recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InteractionView":{
            "type":"string",
            "description":"Type of interaction view.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person.",
            "nullable":true,
            "readOnly":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 : 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 : 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."
        }
    }
}

Links

InteractionRecipients

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}/child/InteractionRecipients

Parameters:

• recruitingUIInteractionsUniqID: $request.path.recruitingUIInteractionsUniqID

The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.

Back to Top