Jump to

• Request
• Response

Update goal progress and submit

post

/hcmRestApi/resources/11.13.18.05/goalsProgressDetails/action/postGoalsDetails

Updates progress information of an employee's goal and submits the specific goal plan for approval.

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

• contextMode: string
  Context for the create, update, or submit for approval action for the goal plan.
• payload: object payload
  Additional Properties Allowed: additionalProperties

  Includes details that uniquely identify the performance or development goal and indicates whether create, update, or submit action needs to be done.

{
    "type":"object",
    "properties":{
        "payload":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Includes details that uniquely identify the performance or development goal and indicates whether create, update, or submit action needs to be done.",
            "nullable":true
        },
        "contextMode":{
            "type":"string",
            "description":"Context for the create, update, or submit for approval action for the goal plan.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : payload

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Includes details that uniquely identify the performance or development goal and indicates whether create, update, or submit action needs to be done.",
    "nullable":true
}

Includes details that uniquely identify the performance or development goal and indicates whether create, update, or submit action needs to be done.

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

  Unique identifier for the goal and optionally the transaction after successfully creating or updating the goal in the goal plan.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Unique identifier for the goal and optionally the transaction after successfully creating or updating the goal in the goal plan."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Unique identifier for the goal and optionally the transaction after successfully creating or updating the goal in the goal plan."
}

Unique identifier for the goal and optionally the transaction after successfully creating or updating the goal in the goal plan.

Back to Top