Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
scenario

Return all scenarios in the organization paginated

get/v1/org/{orgId}/scenario

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

fromstring

Scenario id to start paginating from

status'OPEN' | 'INACTIVE' | 'MERGED' | 'DRAFT' | 'ARCHIVED'

Scenario status to filter by

limitinteger

Number of results to return

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "name": "Q4 Conservative Plan",
      "description": "Q4 Conservative Plan",
      "startDate": "2017-01-15",
      "shareAccess": [
        {
          "userId": "5887a7718f138b6a2a0041a7",
          "groupId": "5887a7718f138b6a2a0041a7",
          "fields": "name,image,title"
        }
      ],
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteBehalfId": "588f7ee98f138b19220041a7",
      "deleteAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "deleteAt": "2017-01-24T13:57:52Z",
      "mergeId": "588f7ee98f138b19220041a7",
      "mergeAt": "2017-01-24T13:57:52Z",
      "calcStartAt": "2017-01-24T13:57:52Z",
      "calcEndAt": "2017-01-24T13:57:52Z",
      "changeAt": "2017-01-24T13:57:52Z",
      "changeId": "2017-01-24T13:57:52Z",
      "validJobIdSet": [
        "588f7ee98f138b19220041a7"
      ],
      "approvalRequestId": "588f7ee98f138b19220041a7",
      "entityId": "588f7ee98f138b19220041a7",
      "sharedViewConfig": [
        {
          "updateId": "588f7ee98f138b19220041a7"
        }
      ]
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}