The finance developer workbenchSearch the reference Development · 0.1.4 · unpublished

artifact / wire operation

Read an analysis artifact

totalfinance.artifact.read

Validate a Gate B analysis artifact (its envelope, its recomputed inputs hash, and its content-hash identity) and return its identity, type, producer, provenance warnings, table names, and a bounded preview of the stored result — the one read door for any artifact over the wire. Migrations are not registered over the wire; a stored older version is refused with the versions named.

Pack / profilesartifact / backtesting, full, portfolio, scenarios
Default discoveryOpt-in
Required capabilitiesNone
Effects / authorizationnone / none
Cost / cancellationsmall / Do not assume inline interruption
Handle-eligible inputsartifact
Idempotencynot-applicable
Input schema
{
  "type": "object",
  "properties": {
    "artifact": {
      "type": "object",
      "properties": {
        "kind": {
          "const": "totalfinance.analysis-artifact",
          "type": "string"
        },
        "schemaVersion": {
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "artifactType": {
          "type": "string"
        },
        "producedBy": {
          "type": "object",
          "properties": {
            "operation": {
              "type": "string"
            },
            "libraryVersion": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": [
            "operation"
          ]
        },
        "conventionsVersion": {
          "type": "string"
        },
        "inputs": {
          "type": "object",
          "properties": {
            "inputsHash": {
              "type": "string"
            },
            "snapshotHash": {
              "type": "string"
            },
            "parameters": {}
          },
          "additionalProperties": false,
          "required": [
            "inputsHash"
          ]
        },
        "createdFrom": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "result": {
          "type": "object",
          "additionalProperties": {}
        },
        "tables": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "provenance": {
          "type": "object",
          "properties": {
            "provider": {
              "type": "string"
            },
            "dataset": {
              "type": "string"
            },
            "asOf": {
              "type": "number"
            },
            "receivedAt": {
              "type": "number"
            },
            "sourceVersion": {
              "type": "string"
            },
            "requestId": {
              "type": "string"
            },
            "warnings": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": {}
              }
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false,
      "required": [
        "kind",
        "schemaVersion",
        "id",
        "artifactType",
        "producedBy",
        "conventionsVersion",
        "inputs",
        "result"
      ],
      "description": "A Gate B analysis artifact (totalfinance.analysis-artifact); hashes are re-verified by the read door"
    }
  },
  "additionalProperties": false,
  "required": [
    "artifact"
  ]
}
Output schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "artifactType": {
      "type": "string"
    },
    "schemaVersion": {
      "type": "integer"
    },
    "producedBy": {
      "type": "object"
    },
    "conventionsVersion": {
      "type": "string"
    },
    "inputs": {
      "type": "object"
    },
    "createdFrom": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tables": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "preview": {
      "type": "object",
      "description": "Top-level keys; scalars inline, containers by size"
    },
    "migrationsApplied": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "required": [
    "id",
    "artifactType",
    "schemaVersion",
    "producedBy",
    "conventionsVersion",
    "inputs",
    "createdFrom",
    "tables",
    "warnings",
    "preview",
    "migrationsApplied"
  ]
}

All operations · Setup, handles, jobs & permissions