approval-request

Return all approval request scenario responses for an org

get/v1/org/{orgId}/approval-request/entity/scenario

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/approval-request/entity/scenario
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

fromstring

Id to start paginating from

limitinteger

Number of results to return

entityIdsstring

entity ids to filter on

includeDeletedboolean

Include deleted approval requests

includeCompReviewScenariosboolean

Include scenario approval requests in comp reviews

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "activeStage": {
        "stageOverrideId": "588f7ee98f138b19220041a7",
        "approvalChainStageId": "588f7ee98f138b19220041a7",
        "groups": [
          {
            "groupId": "588f7ee98f138b19220041a7",
            "approvers": [
              {
                "jobId": "588f7ee98f138b19220041a7",
                "commentId": "588f7ee98f138b19220041a7",
                "reassignCommentId": "588f7ee98f138b19220041a7",
                "fallbackFor": "588f7ee98f138b19220041a7",
                "actedByJobId": "588f7ee98f138b19220041a7"
              }
            ]
          }
        ]
      },
      "proposerStage": {
        "stageOverrideId": "588f7ee98f138b19220041a7",
        "approvalChainStageId": "588f7ee98f138b19220041a7",
        "groups": [
          {
            "groupId": "588f7ee98f138b19220041a7",
            "approvers": [
              {
                "jobId": "588f7ee98f138b19220041a7",
                "commentId": "588f7ee98f138b19220041a7",
                "reassignCommentId": "588f7ee98f138b19220041a7",
                "fallbackFor": "588f7ee98f138b19220041a7",
                "actedByJobId": "588f7ee98f138b19220041a7"
              }
            ]
          }
        ]
      },
      "nextReviewerStage": {
        "stageOverrideId": "588f7ee98f138b19220041a7",
        "approvalChainStageId": "588f7ee98f138b19220041a7",
        "groups": [
          {
            "groupId": "588f7ee98f138b19220041a7",
            "approvers": [
              {
                "jobId": "588f7ee98f138b19220041a7",
                "commentId": "588f7ee98f138b19220041a7",
                "reassignCommentId": "588f7ee98f138b19220041a7",
                "fallbackFor": "588f7ee98f138b19220041a7",
                "actedByJobId": "588f7ee98f138b19220041a7"
              }
            ]
          }
        ]
      },
      "rejectedStage": {
        "stageOverrideId": "588f7ee98f138b19220041a7",
        "approvalChainStageId": "588f7ee98f138b19220041a7",
        "groups": [
          {
            "groupId": "588f7ee98f138b19220041a7",
            "approvers": [
              {
                "jobId": "588f7ee98f138b19220041a7",
                "commentId": "588f7ee98f138b19220041a7",
                "reassignCommentId": "588f7ee98f138b19220041a7",
                "fallbackFor": "588f7ee98f138b19220041a7",
                "actedByJobId": "588f7ee98f138b19220041a7"
              }
            ]
          }
        ]
      },
      "stageOverrides": [
        {
          "stageOverrideId": "588f7ee98f138b19220041a7",
          "approvalChainStageId": "588f7ee98f138b19220041a7",
          "groups": [
            {
              "groupId": "588f7ee98f138b19220041a7",
              "approvers": [
                {
                  "jobId": "588f7ee98f138b19220041a7",
                  "commentId": "588f7ee98f138b19220041a7",
                  "reassignCommentId": "588f7ee98f138b19220041a7",
                  "fallbackFor": "588f7ee98f138b19220041a7",
                  "actedByJobId": "588f7ee98f138b19220041a7"
                }
              ]
            }
          ]
        }
      ],
      "approvalChainId": "588f7ee98f138b19220041a7",
      "scenarioId": "588f7ee98f138b19220041a7",
      "createId": "588f7ee98f138b19220041a7",
      "updateId": "588f7ee98f138b19220041a7",
      "deleteId": "588f7ee98f138b19220041a7",
      "delegatedApproverJobId": "588f7ee98f138b19220041a7",
      "delegatedApproverJobIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

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