CHcharthop
comp-review

Get the aggregated Impact Dashboard payload for a comp review

Changed on
post/v1/org/{orgId}/comp-review/{compReviewId}/impact-dashboard

Request

  • Base URL
    https://localhost
  • URL
    https://localhost/v1/org/{orgId}/comp-review/{compReviewId}/impact-dashboard
  • Auth
    none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

compReviewIdstring required

Comp review id

Query parameters

viewJobIdstring

The job you would like to view as

previewboolean

Are we requesting a preview of the dashboard

includeAllRequestsboolean

Allows users with multiple roles to request full access for owner or final approver roles

Request body

changeIdsstring[]

A set of Change ObjectIds used to scope the dashboard to specific changes

viewInCurrencystring

Currency to view money-valued cards in

includeCollaboratorsboolean

Whether to include approval requests the user collaborates on

isCollabicientViewboolean required

Whether the dashboard is being viewed by a collaborator

scenarioIdsstring[]

A set of Scenario ObjectIds used to scope the dashboard to a reviewer's scenarios

Example request

{
  "changeIds": [
    "588f7ee98f138b19220041a7"
  ],
  "scenarioIds": [
    "588f7ee98f138b19220041a7"
  ]
}

Response

successful operation

Example response

{
  "budgetPools": {
    "pools": [
      {
        "budgetPoolId": "588f7ee98f138b19220041a7"
      }
    ]
  },
  "pivot": {
    "changes": [
      {
        "changeId": "588f7ee98f138b19220041a7",
        "jobId": "588f7ee98f138b19220041a7"
      }
    ]
  }
}

Changes