Retrieve a sandbox scenario | Collate API Documentation

curl https://api.sandbox.trycollate.ai/v1/sandbox/scenarios/scenario_id \
     -H "Authorization: Bearer <apiKey>"

{
  "id": "string",
  "title": "string",
  "description": "string",
  "manifestVersion": "string",
  "create": {
    "providerNpi": "string",
    "request": {
      "payerId": "string",
      "coverageState": "string",
      "requestType": "inpatient",
      "serviceCode": {
        "system": "hcpcs",
        "code": "string"
      }
    },
    "policy": {
      "finalSubmission": "automatic"
    },
    "answers": {
      "item": [
        {
          "linkId": "string",
          "answer": [
            {
              "valueString": "string",
              "valueBoolean": true,
              "valueDate": "string",
              "valueDecimal": 1.1,
              "valueCoding": {
                "code": "string"
              }
            }
          ],
          "item": [
            null
          ]
        }
      ]
    },
    "requiredAnswerPaths": [
      "string"
    ],
    "requiredDocumentTypes": [
      "string"
    ]
  },
  "ciSafe": true,
  "timeoutSeconds": 1,
  "expectedObservations": [
    {
      "phase": "string",
      "status": "requires_action",
      "nextActionType": "resolve_requirements",
      "outcome": "approved",
      "submissionFields": [
        "string"
      ],
      "notes": "string"
    }
  ],
  "requiredEndpoints": [
    "string"
  ]
}

Retrieves one deterministic sandbox scenario by ID.

Use this endpoint to load the create inputs and expected observations for a single scenario before running a smoke test.

Returns

Returns the sandbox scenario. Returns 404 not_found when the ID is not in the current manifest.

Authentication

AuthorizationBearer

API key passed as Authorization: Bearer <API_KEY>.

Path parameters

scenario_idstringRequired

Sandbox scenario ID returned by GET /v1/sandbox/scenarios.

Response

Successful Response

idstring

Stable scenario ID from the sandbox catalog.

titlestring

Human-readable scenario title.

descriptionstring

What the scenario proves.

manifestVersionstring

Scenario manifest version.

createobject

Production-shaped create inputs for this scenario.

ciSafeboolean

Whether the scenario is safe for CI smoke runs.

timeoutSecondsinteger

Recommended client timeout for the deterministic scenario run.

expectedObservationslist of objects

Public lifecycle observations clients should assert.

requiredEndpointslist of strings

Public endpoints exercised by this scenario.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error