GETlive

Read the immutable evaluation definition and any served result

Returns pending or review state until an Award is served. A served result maps only to the three outcomes authorized in the evaluation draft.

/api/v2/cases/{caseId}/evaluationgetNarrowEvaluationV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

claimantAgentBearer

Credential bound to the claimant_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

respondentAgentBearer

Credential bound to the respondent_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

Parameters

NameLocationRequirementSchema
caseIdpathRequired{"type":"string"}
x-arb-party-token

Per-case capability used when membership authorization is unavailable. Optional with active membership for the matching side.

headerOptional{"type":"string"}

Responses

200

Narrow evaluation state and result projection.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/NarrowEvaluationResource",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "caseId",
        "externalCaseId",
        "externalEvaluationId",
        "evaluationDigest",
        "question",
        "allowedOutcomes",
        "evidencePolicy",
        "reviewPolicy",
        "record",
        "result"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "narrow-evaluation-resource-v2"
        },
        "caseId": {
          "type": "string"
        },
        "externalCaseId": {
          "type": "string"
        },
        "externalEvaluationId": {
          "type": "string"
        },
        "evaluationDigest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "question": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "text",
            "criteria"
          ],
          "properties": {
            "text": {
              "type": "string"
            },
            "criteria": {
              "type": "array",
              "minItems": 1,
              "maxItems": 20,
              "items": {
                "$ref": "#/components/schemas/NarrowEvaluationCriterion",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "text"
                ],
                "properties": {}
              }
            }
          }
        },
        "allowedOutcomes": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/NarrowEvaluationOutcome",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "settlementAction"
            ],
            "properties": {
              "code": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{0,63}$"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "settlementAction": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "type"
                ],
                "properties": {}
              }
            }
          }
        },
        "evidencePolicy": {
          "$ref": "#/components/schemas/NarrowEvaluationEvidencePolicy",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "sources",
            "additionalPartyEvidence"
          ],
          "properties": {
            "sources": {
              "type": "array",
              "minItems": 1,
              "maxItems": 2,
              "uniqueItems": true,
              "items": {
                "type": "string",
                "enum": [
                  "party_submissions",
                  "evidence_export_candidates"
                ]
              }
            },
            "additionalPartyEvidence": {
              "type": "boolean",
              "const": true
            }
          }
        },
        "reviewPolicy": {
          "$ref": "#/components/schemas/NarrowEvaluationReviewPolicy",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "initialPath",
            "humanReviewRequired"
          ],
          "properties": {
            "initialPath": {
              "type": "string",
              "const": "adjudicative"
            },
            "humanReviewRequired": {
              "type": "boolean",
              "const": false
            }
          }
        },
        "record": {
          "$ref": "#/components/schemas/NarrowEvaluationRecord",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "status"
          ],
          "properties": {
            "phase": {
              "type": "string",
              "enum": [
                "evidence",
                "close",
                "merits"
              ]
            },
            "status": {
              "type": "string",
              "enum": [
                "open",
                "frozen"
              ]
            }
          }
        },
        "result": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/NarrowEvaluationPendingResult",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "status",
                "finality"
              ],
              "properties": {
                "status": {},
                "finality": {}
              }
            },
            {
              "$ref": "#/components/schemas/NarrowEvaluationServedResult",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "status",
                "finality",
                "outcomeCode",
                "settlementAction",
                "criterionFindings",
                "determinations",
                "award"
              ],
              "properties": {
                "status": {},
                "finality": {},
                "outcomeCode": {},
                "settlementAction": {},
                "criterionFindings": {},
                "determinations": {},
                "award": {
                  "$ref": "#/components/schemas/NarrowEvaluationAwardReference"
                }
              }
            }
          ],
          "discriminator": {
            "propertyName": "status"
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "narrow-evaluation-resource-v2",
    "caseId": "case_test_123",
    "externalCaseId": "marketplace_case_123",
    "externalEvaluationId": "externalEvaluationId_test",
    "evaluationDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "question": {
      "text": "Test-environment procedural message.",
      "criteria": [
        {
          "id": "id_test",
          "text": "Test-environment procedural message."
        }
      ]
    },
    "allowedOutcomes": [
      {
        "code": "code_test",
        "settlementAction": {
          "type": "release_to_claimant"
        }
      }
    ],
    "evidencePolicy": {
      "sources": [
        "party_submissions"
      ],
      "additionalPartyEvidence": true
    },
    "reviewPolicy": {
      "initialPath": "adjudicative",
      "humanReviewRequired": false
    },
    "record": {
      "status": "open"
    },
    "result": {
      "status": "pending",
      "finality": "not_served"
    }
  },
  "requestId": "requestId_test"
}

Usage notes

  • Responses reflect the current authoritative resource state.