Jump to

• Request
• Response

Generate report URL

post

/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/buildBipReportUrlForGoals

Generates the report URL for performance or development goals.

Request

Path Parameters

• GoalPlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• 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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• bipReportParameters: object bipReportParameters
  Additional Properties Allowed: additionalProperties

  Parameters for generating the goals report. For performance goals, it can include attributes such as the person ID, goal plan ID, list of goal IDs, assignment ID, and indicators for showing weight, goal alignment, tasks, and target outcomes. For development goals, it can include attributes such as the person ID, list of goal IDs, assignment ID, and indicators for showing tasks and target outcomes.
• goalType: string
  Indicates whether the report needs to be generated for performance or development goals.
• hostName: string
  Unique label for the device used to generate the report for performance or development goals.

{
    "type":"object",
    "properties":{
        "goalType":{
            "type":"string",
            "description":"Indicates whether the report needs to be generated for performance or development goals.",
            "nullable":true
        },
        "hostName":{
            "type":"string",
            "description":"Unique label for the device used to generate the report for performance or development goals.",
            "nullable":true
        },
        "bipReportParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Parameters for generating the goals report. For performance goals, it can include attributes such as the person ID, goal plan ID, list of goal IDs, assignment ID, and indicators for showing weight, goal alignment, tasks, and target outcomes. For development goals, it can include attributes such as the person ID, list of goal IDs, assignment ID, and indicators for showing tasks and target outcomes.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : bipReportParameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Parameters for generating the goals report. For performance goals, it can include attributes such as the person ID, goal plan ID, list of goal IDs, assignment ID, and indicators for showing weight, goal alignment, tasks, and target outcomes. For development goals, it can include attributes such as the person ID, list of goal IDs, assignment ID, and indicators for showing tasks and target outcomes.",
    "nullable":true
}

Parameters for generating the goals report. For performance goals, it can include attributes such as the person ID, goal plan ID, list of goal IDs, assignment ID, and indicators for showing weight, goal alignment, tasks, and target outcomes. For development goals, it can include attributes such as the person ID, list of goal IDs, assignment ID, and indicators for showing tasks and target outcomes.

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
  The report URL for performance or development goals that can be printed as a PDF file.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The report URL for performance or development goals that can be printed as a PDF file."
        }
    },
    "additionalProperties":false
}

Back to Top