ClaimResult

CNAB Claim Result representing the outcome of an action

Application DependenciesCloud NativeIntegrationResearchSpecificationsWorkload Specifications

Properties

Name Type Description
id string The result ID (ULID)
claimId string The associated claim ID
status object
message string The last message from the invocation image or runtime
created string The date created (ISO-8601)
outputs object Map of outputs generated by the operation
custom object Reserved for custom extensions
View JSON Schema on GitHub

JSON Schema

application-research-claimresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClaimResult",
  "title": "ClaimResult",
  "type": "object",
  "description": "CNAB Claim Result representing the outcome of an action",
  "required": [
    "id",
    "claimId",
    "status",
    "created"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The result ID (ULID)"
    },
    "claimId": {
      "type": "string",
      "description": "The associated claim ID"
    },
    "status": {
      "$ref": "#/components/schemas/ClaimResultStatus"
    },
    "message": {
      "type": "string",
      "description": "The last message from the invocation image or runtime"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "The date created (ISO-8601)"
    },
    "outputs": {
      "type": "object",
      "description": "Map of outputs generated by the operation",
      "additionalProperties": {
        "$ref": "#/components/schemas/ClaimResultOutput"
      }
    },
    "custom": {
      "type": "object",
      "description": "Reserved for custom extensions",
      "additionalProperties": true
    }
  }
}