Jump to

• Request
• Response

Perform actions on goals

post

/hcmRestApi/resources/11.13.18.05/goalActions/action/perform

Performs various actions such as cancel, copy, assign, and share on 1 or more goals.

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

• action: string
  Type of action to be performed on the performance goals.
• goalIds: array goalIds
  Comma separated list of unique goal identifiers.
• params: object params
  Additional Properties Allowed: additionalProperties

  Additional parameters required for the goal action.

{
    "type":"object",
    "properties":{
        "goalIds":{
            "type":"array",
            "description":"Comma separated list of unique goal identifiers.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "action":{
            "type":"string",
            "description":"Type of action to be performed on the performance goals.",
            "nullable":true
        },
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Additional parameters required for the goal action.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : goalIds

Type: array

Comma separated list of unique goal identifiers.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Comma separated list of unique goal identifiers.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : params

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Additional parameters required for the goal action.",
    "nullable":true
}

Additional parameters required for the goal action.

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): string
  Success or failure status of the goal action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Success or failure status of the goal action."
        }
    },
    "additionalProperties":false
}

Back to Top