Jump to

• Request
• Response

Mark a job application as a favorite.

post

/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/setFavorite

Marks a job application as a favorite for a user.

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

• favorite: boolean
  Favorite indicator for a job application. Values can be true or false.
• submissionIds: array submissionIds
  List of job application identifiers for the action to mark a job application as a favorite.

{
    "type":"object",
    "properties":{
        "submissionIds":{
            "type":"array",
            "description":"List of job application identifiers for the action to mark a job application as a favorite.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "favorite":{
            "type":"boolean",
            "description":"Favorite indicator for a job application. Values can be true or false.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : submissionIds

Type: array

List of job application identifiers for the action to mark a job application as a favorite.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of job application identifiers for the action to mark a job application as a favorite.",
    "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

  Returns the status of the action to update the job application favorite indicator.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns the status of the action to update the job application favorite indicator."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns the status of the action to update the job application favorite indicator."
}

Returns the status of the action to update the job application favorite indicator.

Back to Top