Api referenceWorkspaces

Create Workspace Invariant Proposal

Reference for Create Workspace Invariant Proposal in the Veriom v1 API, including request, response, and authentication details.

POST/v1/workspaces/{workspace_id}/structural/invariant-proposals

Create Workspace Invariant Proposal. Returns a typed response and a request ID for operational support.

Authorization

veriom_session<token>

Opaque HttpOnly customer session. Mutations also require X-CSRF-Token.

In: cookie

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/structural/invariant-proposals" \  -H "Content-Type: application/json" \  -d '{    "definition": {      "base_severity": "critical",      "fixtures": {        "false_positive": [          "string"        ],        "true_positive": [          "string"        ]      },      "id": "string",      "layer": "code",      "pattern_class": "string",      "predicate": {        "kind": "node_attributes",        "node_kind": "string",        "reason": "string"      },      "remediation": {        "target_state": "string",        "tier": "R1",        "verification": "string"      },      "requires_evidence": [        "code"      ],      "statement": "string",      "title": "string",      "version": "string",      "vrm_id": "string"    },    "false_positive_fixtures": [      {        "description": "string",        "edges": [          {            "confidence": 0,            "evidence_ids": [              "973ab5a6-b373-447d-ab9d-bdb660b35afc"            ],            "evidence_sources": [              {                "confidence": 0,                "evidence_ids": [                  "973ab5a6-b373-447d-ab9d-bdb660b35afc"                ],                "ledger": "code",                "source_key": "string"              }            ],            "relationship": "string",            "source": "string",            "target": "string"          }        ],        "expected": [          "string"        ],        "nodes": [          {            "key": "string",            "kind": "string"          }        ],        "observed_ledgers": [          "code"        ]      }    ],    "rationale": "stringstringstringst",    "true_positive_fixtures": [      {        "description": "string",        "edges": [          {            "confidence": 0,            "evidence_ids": [              "973ab5a6-b373-447d-ab9d-bdb660b35afc"            ],            "evidence_sources": [              {                "confidence": 0,                "evidence_ids": [                  "973ab5a6-b373-447d-ab9d-bdb660b35afc"                ],                "ledger": "code",                "source_key": "string"              }            ],            "relationship": "string",            "source": "string",            "target": "string"          }        ],        "expected": [          "string"        ],        "nodes": [          {            "key": "string",            "kind": "string"          }        ],        "observed_ledgers": [          "code"        ]      }    ]  }'
{
  "created_at": "2019-08-24T14:15:22Z",
  "definition": {},
  "definition_hash": "string",
  "fixture_result": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "observed_precision": "string",
  "promoted_at": "2019-08-24T14:15:22Z",
  "proposed_by": "4950251e-cd25-4a79-b482-8e67fe2adc20",
  "rationale": "string",
  "review_notes": "string",
  "reviewed_at": "2019-08-24T14:15:22Z",
  "reviewed_by": "92ab4dbc-1b27-40ce-b24b-7dde8f4709be",
  "reviewed_sample_size": 0,
  "source": "string",
  "state": "string",
  "target_precision": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "hint": "Correct the fields identified in detail using the operation's request schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "hint": "Correct the fields identified in detail using the operation's request schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "hint": "Correct the fields identified in detail using the operation's request schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "hint": "Correct the fields identified in detail using the operation's request schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "hint": "Correct the fields identified in detail using the operation's request schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "hint": "Correct the fields identified in detail using the operation's request schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "hint": "Correct the fields identified in detail using the operation's request schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}

Was this guide useful?

Your response stays in this browser unless you open a GitHub issue.
View source

List Workspace Invariant Proposals

Previous Page

Transition Workspace Invariant Proposal

Next Page