Jump to

• Request
• Response

Add an interaction note

post

/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/action/addInteraction

Adds an interaction note to a candidate or job application.

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

• contextIds: array contextIds
  List of context identifiers that match with the given person identifiers.
• contextTypeCode: string
  Interaction context type code.
• interactionDate: string
  Interaction date.
• interactionText: string
  Interaction text.
• interactionTypeCode: string
  Interaction type code.
• personIds: array personIds
  List of person identifiers that match with the given context identifiers

{
    "type":"object",
    "properties":{
        "interactionDate":{
            "type":"string",
            "description":"Interaction date.",
            "nullable":true
        },
        "interactionText":{
            "type":"string",
            "description":"Interaction text.",
            "nullable":true
        },
        "interactionTypeCode":{
            "type":"string",
            "description":"Interaction type code.",
            "nullable":true
        },
        "contextIds":{
            "type":"array",
            "description":"List of context identifiers that match with the given person identifiers.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "personIds":{
            "type":"array",
            "description":"List of person identifiers that match with the given context identifiers",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "contextTypeCode":{
            "type":"string",
            "description":"Interaction context type code.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : contextIds

Type: array

List of context identifiers that match with the given person identifiers.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of context identifiers that match with the given person identifiers.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : personIds

Type: array

List of person identifiers that match with the given context identifiers

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of person identifiers that match with the given context identifiers",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

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

  Response returned when using the interaction action with success or error message.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Response returned when using the interaction action with success or error message."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Response returned when using the interaction action with success or error message."
}

Response returned when using the interaction action with success or error message.

Back to Top