Getting Started¶

First call to first result — the end-to-end happy path.

This chapter walks the whole lifecycle once, naming the real operations at each step. Each step links to its detailed chapter.

Prerequisites¶

• A provisioned client tenant (your own Google Cloud project boundary).
• Credentials for the governed API gateway (see Authentication & Gateway).
• Input artifacts: trades/portfolios (FpML or CDM), market snapshots, reference data, and a runtime configuration pack.

The Happy Path¶

sequenceDiagram
    participant C as Your system
    participant G as API Gateway
    participant P as Platform
    C->>G: createUploadedArtifact / createSubmission
    G->>P: validate + translate
    P-->>C: getCanonicalPack, getTranslationReport
    C->>P: createReadinessEvaluation
    C->>P: createApproval / decideApproval
    C->>P: createRunRequest
    P-->>C: operation handle
    C->>P: poll (phase1GetJobStatus)
    P-->>C: getBigQueryRows / createInsightCase

1. Stage and submit¶

Upload raw artifacts and open a governed submission.

POST /raas/api/v1/uploaded-artifacts        # createUploadedArtifact
POST /raas/api/v1/submissions               # createSubmission

See Intake APIs and Submission & Translation.

2. Inspect the translation¶

Confirm how your input resolved into canonical objects, and review any issues.

GET /raas/api/v1/submissions/{id}/translation-report   # getTranslationReport
GET /raas/api/v1/submissions/{id}/canonical-pack        # getCanonicalPack
GET /raas/api/v1/submissions/{id}/translation-issues    # getTranslationIssues

3. Check readiness with Config Doctor¶

Find out — before spending compute — whether the run is ready.

POST /raas/api/v1/config-doctor/cases                       # createConfigDoctorCase
POST /raas/api/v1/config-doctor/cases/{id}:validate         # validateConfigDoctorCase
POST /raas/api/v1/config-doctor/cases/{id}:plan-repair      # planConfigDoctorRepair

Gate outcomes: RUNNABLE, RUNNABLE_WITH_APPROVED_WARNINGS, BLOCKED_MISSING_INPUT, BLOCKED_CONFIG_INCONSISTENT. See Config Doctor.

4. Govern: readiness, approval, waivers¶

POST /raas/api/v1/readiness-evaluations     # createReadinessEvaluation
POST /raas/api/v1/approvals                 # createApproval
POST /raas/api/v1/approvals/{id}:decide     # decideApproval

See Governance.

5. Run¶

POST /raas/api/v1/run-requests              # createRunRequest

The call returns an operation handle; poll it to completion. See Execution & Runs and Errors & Long-Running Operations.

6. Consume results and explanation¶

GET  /raas/api/v1/bigquery-rows             # getBigQueryRows
POST /raas/api/v1/insight-cases             # createInsightCase
GET  /raas/api/v1/insight-cases/{id}        # getInsightCase

See Results, Evidence & Insight Cases.

What You Should Take Away¶

• The path is always submit → translate → check → approve → run → consume.
• Nothing material executes on an implicit decision — readiness and approval are explicit, recorded steps.
• Everything you read back is a governed fact with evidence behind it.