CHcharthop
comp-review

Preview changes that will occur when resuming a paused comp review

post/v1/org/{orgId}/comp-review/{compReviewId}/dry-run

Request

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

compReviewIdstring required

Comp review id

Response

successful operation

hasChangesboolean required

Whether there are any changes at all

Example response

{
  "additions": [
    {
      "revieweeJobId": "588f7ee98f138b19220041a7",
      "revieweePersonId": "588f7ee98f138b19220041a7",
      "reviewerJobId": "588f7ee98f138b19220041a7",
      "reviewerPersonId": "588f7ee98f138b19220041a7"
    }
  ],
  "removals": [
    {
      "revieweeJobId": "588f7ee98f138b19220041a7",
      "revieweePersonId": "588f7ee98f138b19220041a7",
      "reviewerJobId": "588f7ee98f138b19220041a7",
      "reviewerPersonId": "588f7ee98f138b19220041a7"
    }
  ],
  "moves": [
    {
      "revieweeJobId": "588f7ee98f138b19220041a7",
      "revieweePersonId": "588f7ee98f138b19220041a7",
      "oldReviewerJobId": "588f7ee98f138b19220041a7",
      "oldReviewerPersonId": "588f7ee98f138b19220041a7",
      "newReviewerJobId": "588f7ee98f138b19220041a7",
      "newReviewerPersonId": "588f7ee98f138b19220041a7"
    }
  ],
  "ownershipChanges": [
    {
      "scenarioId": "588f7ee98f138b19220041a7",
      "oldOwnerJobId": "588f7ee98f138b19220041a7",
      "oldOwnerPersonId": "588f7ee98f138b19220041a7",
      "newOwnerJobId": "588f7ee98f138b19220041a7",
      "newOwnerPersonId": "588f7ee98f138b19220041a7"
    }
  ]
}

Changes

No recorded changes to this operation across all 30 revisions of this API.