io_mapping

Download schema

add_memory_decision

POST

/api/v2/io_mapping/add_memory_decision

Body: {mappingId, topic, decision, rationale?}.

add_memory_decision › Request Body

Request schema for POST /api/v2/io_mapping/add_memory_decision. Body: ``{mappingId, topic, decision, rationale?}``.

request-io_mapping_add_memory_decision

decision

string · required

mappingId

string · required

The mapping id.

topic

string · required

rationale

string

add_memory_decision › Responses

200

Response schema for POST /api/v2/io_mapping/add_memory_decision

response-io_mapping_add_memory_decision

success

boolean · required

Whether the request succeeded

data

object

Body: {mappingId, topic, decision, rationale?}.

POST/api/v2/io_mapping/add_memory_decision

curl --request POST \
  --url /api/v2/io_mapping/add_memory_decision \
  --header 'Content-Type: application/json' \
  --data '
{
  "decision": "decision",
  "mappingId": "mappingId",
  "topic": "topic",
  "rationale": "rationale"
}
'

Example Request Body

{
  "decision": "decision",
  "mappingId": "mappingId",
  "topic": "topic",
  "rationale": "rationale"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

add_memory_followup

POST

/api/v2/io_mapping/add_memory_followup

Body: {mappingId, topic, status}.

add_memory_followup › Request Body

Request schema for POST /api/v2/io_mapping/add_memory_followup. Body: ``{mappingId, topic, status}``.

request-io_mapping_add_memory_followup

mappingId

string · required

The mapping id.

status

string · required

topic

string · required

add_memory_followup › Responses

200

Response schema for POST /api/v2/io_mapping/add_memory_followup

response-io_mapping_add_memory_followup

success

boolean · required

Whether the request succeeded

data

object

Body: {mappingId, topic, status}.

POST/api/v2/io_mapping/add_memory_followup

curl --request POST \
  --url /api/v2/io_mapping/add_memory_followup \
  --header 'Content-Type: application/json' \
  --data '
{
  "mappingId": "mappingId",
  "status": "status",
  "topic": "topic"
}
'

Example Request Body

{
  "mappingId": "mappingId",
  "status": "status",
  "topic": "topic"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

add_memory_ruled_out

POST

/api/v2/io_mapping/add_memory_ruled_out

Body: {mappingId, approach, reason}.

add_memory_ruled_out › Request Body

Request schema for POST /api/v2/io_mapping/add_memory_ruled_out. Body: ``{mappingId, approach, reason}``.

request-io_mapping_add_memory_ruled_out

approach

string · required

mappingId

string · required

The mapping id.

reason

string · required

add_memory_ruled_out › Responses

200

Response schema for POST /api/v2/io_mapping/add_memory_ruled_out

response-io_mapping_add_memory_ruled_out

success

boolean · required

Whether the request succeeded

data

object

Body: {mappingId, approach, reason}.

POST/api/v2/io_mapping/add_memory_ruled_out

curl --request POST \
  --url /api/v2/io_mapping/add_memory_ruled_out \
  --header 'Content-Type: application/json' \
  --data '
{
  "approach": "approach",
  "mappingId": "mappingId",
  "reason": "reason"
}
'

Example Request Body

{
  "approach": "approach",
  "mappingId": "mappingId",
  "reason": "reason"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

add_note

POST

/api/v2/io_mapping/add_note

Anchor a note to a place in the mapping. To ASK somebody, prefer ask_insurance_expert / ask_technical_expert -- they say who reads the answer.

add_note › Request Body

Request schema for POST /api/v2/io_mapping/add_note. Anchor a note to a place in the mapping. To ASK somebody, prefer

request-io_mapping_add_note

slug

string · required

The mapping slug.

body

string

The note body.

anchorKind

string

anchorRef

string

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

authorKind

string

replyTo

string

kind

string

The record kind to filter by.

audience

string

add_note › Responses

200

Response schema for POST /api/v2/io_mapping/add_note

response-io_mapping_add_note

success

boolean · required

Whether the request succeeded

data

object

Anchor a note to a place in the mapping. To ASK somebody, prefer

POST/api/v2/io_mapping/add_note

curl --request POST \
  --url /api/v2/io_mapping/add_note \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "body": "body",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "authorKind": "authorKind",
  "replyTo": "replyTo",
  "kind": "kind",
  "audience": "audience"
}
'

Example Request Body

{
  "slug": "slug",
  "body": "body",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "authorKind": "authorKind",
  "replyTo": "replyTo",
  "kind": "kind",
  "audience": "audience"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

ask_insurance_expert

POST

/api/v2/io_mapping/ask_insurance_expert

Ask a product lead or underwriter a question about how the CARRIER'S PRODUCT works -- in the carrier's words, anchored to the slot it is about. They have never heard of a resolver cell. Not for endpoints, schemas or credentials.

ask_insurance_expert › Request Body

Request schema for POST /api/v2/io_mapping/ask_insurance_expert. Ask a product lead or underwriter a question about how the CARRIER'S PRODUCT

request-io_mapping_ask_insurance_expert

slug

string

The mapping slug.

question

string

anchorKind

string

anchorRef

string

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

authorKind

string

ask_insurance_expert › Responses

200

Response schema for POST /api/v2/io_mapping/ask_insurance_expert

response-io_mapping_ask_insurance_expert

success

boolean · required

Whether the request succeeded

data

object

Ask a product lead or underwriter a question about how the CARRIER'S PRODUCT

POST/api/v2/io_mapping/ask_insurance_expert

curl --request POST \
  --url /api/v2/io_mapping/ask_insurance_expert \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "question": "question",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "authorKind": "authorKind"
}
'

Example Request Body

{
  "slug": "slug",
  "question": "question",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "authorKind": "authorKind"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

ask_technical_expert

POST

/api/v2/io_mapping/ask_technical_expert

Ask an engineer a question about the SYSTEM -- the endpoint, the schema, the input document, credentials, the environment. Not for product questions like what a roof code means.

ask_technical_expert › Request Body

Request schema for POST /api/v2/io_mapping/ask_technical_expert. Ask an engineer a question about the SYSTEM -- the endpoint, the schema, the

request-io_mapping_ask_technical_expert

slug

string

The mapping slug.

question

string

anchorKind

string

anchorRef

string

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

authorKind

string

ask_technical_expert › Responses

200

Response schema for POST /api/v2/io_mapping/ask_technical_expert

response-io_mapping_ask_technical_expert

success

boolean · required

Whether the request succeeded

data

object

Ask an engineer a question about the SYSTEM -- the endpoint, the schema, the

POST/api/v2/io_mapping/ask_technical_expert

curl --request POST \
  --url /api/v2/io_mapping/ask_technical_expert \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "question": "question",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "authorKind": "authorKind"
}
'

Example Request Body

{
  "slug": "slug",
  "question": "question",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "authorKind": "authorKind"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

assess_variant_fit

POST

/api/v2/io_mapping/assess_variant_fit

Should this policy type be a variant of this mapping, or its own mapping?

assess_variant_fit › Request Body

Request schema for POST /api/v2/io_mapping/assess_variant_fit. Should this policy type be a variant of this mapping, or its own mapping?

request-io_mapping_assess_variant_fit

slug

string · required

The mapping slug.

policyType

string · required

The policy type name, e.g. HO-3.

state

string · required

Two-letter state abbreviation.

effectiveDate

string

The effective date the policy type resolves on.

assess_variant_fit › Responses

200

Response schema for POST /api/v2/io_mapping/assess_variant_fit

response-io_mapping_assess_variant_fit

success

boolean · required

Whether the request succeeded

data

object

Should this policy type be a variant of this mapping, or its own mapping?

POST/api/v2/io_mapping/assess_variant_fit

curl --request POST \
  --url /api/v2/io_mapping/assess_variant_fit \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "policyType": "policyType",
  "state": "state",
  "effectiveDate": "effectiveDate"
}
'

Example Request Body

{
  "slug": "slug",
  "policyType": "policyType",
  "state": "state",
  "effectiveDate": "effectiveDate"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

call_wrapped_api

POST

/api/v2/io_mapping/call_wrapped_api

Render this mapping's request and CALL the endpoint it wraps, for real...

call_wrapped_api › Request Body

Request schema for POST /api/v2/io_mapping/call_wrapped_api. Render this mapping's request and CALL the endpoint it wraps, for real.

request-io_mapping_call_wrapped_api

slug

string · required

The mapping slug.

fixtureId

string

A fixture id; defaults to the mapping's default fixture.

confirm

boolean

Required on a production site, and only with agreement given in this turn.

store

boolean

intent

string

One sentence stating what this call creates and why.

call_wrapped_api › Responses

200

Response schema for POST /api/v2/io_mapping/call_wrapped_api

response-io_mapping_call_wrapped_api

success

boolean · required

Whether the request succeeded

data

object

Render this mapping's request and CALL the endpoint it wraps, for real.

POST/api/v2/io_mapping/call_wrapped_api

curl --request POST \
  --url /api/v2/io_mapping/call_wrapped_api \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "fixtureId": "fixtureId",
  "confirm": true,
  "store": true,
  "intent": "intent"
}
'

Example Request Body

{
  "slug": "slug",
  "fixtureId": "fixtureId",
  "confirm": true,
  "store": true,
  "intent": "intent"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

capture_reconcile_snapshot

POST

/api/v2/io_mapping/capture_reconcile_snapshot

Pin the live definition's domains onto the spec as the authoring snapshot...

capture_reconcile_snapshot › Request Body

Request schema for POST /api/v2/io_mapping/capture_reconcile_snapshot. Pin the live definition's domains onto the spec as the authoring snapshot

request-io_mapping_capture_reconcile_snapshot

slug

string · required

The mapping slug.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

effectiveDate

string

The effective date the policy type resolves on.

capturedAt

string

capture_reconcile_snapshot › Responses

200

Response schema for POST /api/v2/io_mapping/capture_reconcile_snapshot

response-io_mapping_capture_reconcile_snapshot

success

boolean · required

Whether the request succeeded

data

object

Pin the live definition's domains onto the spec as the authoring snapshot

POST/api/v2/io_mapping/capture_reconcile_snapshot

curl --request POST \
  --url /api/v2/io_mapping/capture_reconcile_snapshot \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "policyType": "policyType",
  "state": "state",
  "effectiveDate": "effectiveDate",
  "capturedAt": "capturedAt"
}
'

Example Request Body

{
  "slug": "slug",
  "policyType": "policyType",
  "state": "state",
  "effectiveDate": "effectiveDate",
  "capturedAt": "capturedAt"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

clear_agent_memory

POST

/api/v2/io_mapping/clear_agent_memory

Wipe the agent_memory column.

clear_agent_memory › Request Body

Request schema for POST /api/v2/io_mapping/clear_agent_memory. Wipe the agent_memory column.

request-io_mapping_clear_agent_memory

mappingId

string

The mapping id.

mapping_id

string

clear_agent_memory › Responses

200

Response schema for POST /api/v2/io_mapping/clear_agent_memory

response-io_mapping_clear_agent_memory

success

boolean · required

Whether the request succeeded

data

object

Wipe the agent_memory column.

POST/api/v2/io_mapping/clear_agent_memory

curl --request POST \
  --url /api/v2/io_mapping/clear_agent_memory \
  --header 'Content-Type: application/json' \
  --data '
{
  "mappingId": "mappingId",
  "mapping_id": "mapping_id"
}
'

Example Request Body

{
  "mappingId": "mappingId",
  "mapping_id": "mapping_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

compile_analytics_preview

POST

/api/v2/io_mapping/compile_analytics_preview

Compile a WORKING spec's ANALYTICS section for live preview.

compile_analytics_preview › Request Body

Request schema for POST /api/v2/io_mapping/compile_analytics_preview. Compile a WORKING spec's ANALYTICS section for live preview.

request-io_mapping_compile_analytics_preview

slug

string

The mapping slug.

spec

object

compile_analytics_preview › Responses

200

Response schema for POST /api/v2/io_mapping/compile_analytics_preview

response-io_mapping_compile_analytics_preview

success

boolean · required

Whether the request succeeded

data

object

Compile a WORKING spec's ANALYTICS section for live preview.

POST/api/v2/io_mapping/compile_analytics_preview

curl --request POST \
  --url /api/v2/io_mapping/compile_analytics_preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "spec": {}
}
'

Example Request Body

{
  "slug": "slug",
  "spec": {}
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

compile_resolver_preview

POST

/api/v2/io_mapping/compile_resolver_preview

Compile a WORKING (unsaved) spec to its Jinja template for live preview — persists...

compile_resolver_preview › Request Body

Request schema for POST /api/v2/io_mapping/compile_resolver_preview. Compile a WORKING (unsaved) spec to its Jinja template for live preview —

request-io_mapping_compile_resolver_preview

slug

string · required

The mapping slug.

spec

object

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

compile_resolver_preview › Responses

200

Response schema for POST /api/v2/io_mapping/compile_resolver_preview

response-io_mapping_compile_resolver_preview

success

boolean · required

Whether the request succeeded

data

object

Compile a WORKING (unsaved) spec to its Jinja template for live preview —

POST/api/v2/io_mapping/compile_resolver_preview

curl --request POST \
  --url /api/v2/io_mapping/compile_resolver_preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "spec": {},
  "variant": "variant",
  "policyType": "policyType",
  "state": "state"
}
'

Example Request Body

{
  "slug": "slug",
  "spec": {},
  "variant": "variant",
  "policyType": "policyType",
  "state": "state"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

compile_response_preview

POST

/api/v2/io_mapping/compile_response_preview

Compile a WORKING spec's RESPONSE section (spec['response']) for live preview.

compile_response_preview › Request Body

Request schema for POST /api/v2/io_mapping/compile_response_preview. Compile a WORKING spec's RESPONSE section (``spec['response']``) for live preview.

request-io_mapping_compile_response_preview

slug

string

The mapping slug.

spec

object

compile_response_preview › Responses

200

Response schema for POST /api/v2/io_mapping/compile_response_preview

response-io_mapping_compile_response_preview

success

boolean · required

Whether the request succeeded

data

object

Compile a WORKING spec's RESPONSE section (spec['response']) for live preview.

POST/api/v2/io_mapping/compile_response_preview

curl --request POST \
  --url /api/v2/io_mapping/compile_response_preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "spec": {}
}
'

Example Request Body

{
  "slug": "slug",
  "spec": {}
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

copilot

POST

/api/v2/io_mapping/copilot

SSE streaming endpoint (mirrors reports.py:send_prompt).

copilot › Request Body

Request schema for POST /api/v2/io_mapping/copilot. SSE streaming endpoint (mirrors ``reports.py:send_prompt``).

request-io_mapping_copilot

mappingId

string · required

The mapping id.

prompt

string · required

fixtureId

string

A fixture id; defaults to the mapping's default fixture.

sessionId

string

selection

object

activeTemplateSide

string

turnIntent

string

requestTemplate

string

responseTemplate

string

requestFixture

string

responseFixture

string

copilot › Responses

200

Response schema for POST /api/v2/io_mapping/copilot

response-io_mapping_copilot

success

boolean · required

Whether the request succeeded

data

object

SSE streaming endpoint (mirrors reports.py:send_prompt).

POST/api/v2/io_mapping/copilot

curl --request POST \
  --url /api/v2/io_mapping/copilot \
  --header 'Content-Type: application/json' \
  --data '
{
  "mappingId": "mappingId",
  "fixtureId": "fixtureId",
  "prompt": "prompt",
  "sessionId": "sessionId",
  "selection": {},
  "activeTemplateSide": "activeTemplateSide",
  "turnIntent": "turnIntent",
  "requestTemplate": "requestTemplate",
  "responseTemplate": "responseTemplate",
  "requestFixture": "requestFixture",
  "responseFixture": "responseFixture"
}
'

Example Request Body

{
  "mappingId": "mappingId",
  "fixtureId": "fixtureId",
  "prompt": "prompt",
  "sessionId": "sessionId",
  "selection": {},
  "activeTemplateSide": "activeTemplateSide",
  "turnIntent": "turnIntent",
  "requestTemplate": "requestTemplate",
  "responseTemplate": "responseTemplate",
  "requestFixture": "requestFixture",
  "responseFixture": "responseFixture"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

create_fixture

POST

/api/v2/io_mapping/create_fixture

create_fixture

create_fixture › Request Body

Request schema for POST /api/v2/io_mapping/create_fixture. IO mapping endpoint create_fixture.

request-io_mapping_create_fixture

slug

string · required

The mapping slug.

name

string · required

Display name.

contentType

string · required

content

string · required

The document body.

apiResponseContent

string

isDefault

boolean

create_fixture › Responses

200

Response schema for POST /api/v2/io_mapping/create_fixture

response-io_mapping_create_fixture

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint create_fixture.

POST/api/v2/io_mapping/create_fixture

curl --request POST \
  --url /api/v2/io_mapping/create_fixture \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "name": "name",
  "contentType": "contentType",
  "content": "content",
  "apiResponseContent": "apiResponseContent",
  "isDefault": true
}
'

Example Request Body

{
  "slug": "slug",
  "name": "name",
  "contentType": "contentType",
  "content": "content",
  "apiResponseContent": "apiResponseContent",
  "isDefault": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

create_mapping

POST

/api/v2/io_mapping/create_mapping

create_mapping

create_mapping › Request Body

Request schema for POST /api/v2/io_mapping/create_mapping. IO mapping endpoint create_mapping.

request-io_mapping_create_mapping

slug

string · required

The mapping slug.

name

string · required

Display name.

kind

string · required

The record kind to filter by.

inputFormat

string · required

outputFormat

string · required

description

string

Free-text description.

apiCall

string

inputSchema

string

inputSchemaId

string

analyticsSchemaId

string

draftTemplate

string

responseDraftTemplate

string

create_mapping › Responses

200

Response schema for POST /api/v2/io_mapping/create_mapping

response-io_mapping_create_mapping

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint create_mapping.

POST/api/v2/io_mapping/create_mapping

curl --request POST \
  --url /api/v2/io_mapping/create_mapping \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "name": "name",
  "kind": "kind",
  "inputFormat": "inputFormat",
  "outputFormat": "outputFormat",
  "description": "description",
  "apiCall": "apiCall",
  "inputSchema": "inputSchema",
  "inputSchemaId": "inputSchemaId",
  "analyticsSchemaId": "analyticsSchemaId",
  "draftTemplate": "draftTemplate",
  "responseDraftTemplate": "responseDraftTemplate"
}
'

Example Request Body

{
  "slug": "slug",
  "name": "name",
  "kind": "kind",
  "inputFormat": "inputFormat",
  "outputFormat": "outputFormat",
  "description": "description",
  "apiCall": "apiCall",
  "inputSchema": "inputSchema",
  "inputSchemaId": "inputSchemaId",
  "analyticsSchemaId": "analyticsSchemaId",
  "draftTemplate": "draftTemplate",
  "responseDraftTemplate": "responseDraftTemplate"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

delete_fixture

POST

/api/v2/io_mapping/delete_fixture

delete_fixture

delete_fixture › Request Body

Request schema for POST /api/v2/io_mapping/delete_fixture. IO mapping endpoint delete_fixture.

request-io_mapping_delete_fixture

fixtureId

string · required

A fixture id; defaults to the mapping's default fixture.

delete_fixture › Responses

200

Response schema for POST /api/v2/io_mapping/delete_fixture

response-io_mapping_delete_fixture

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint delete_fixture.

POST/api/v2/io_mapping/delete_fixture

curl --request POST \
  --url /api/v2/io_mapping/delete_fixture \
  --header 'Content-Type: application/json' \
  --data '
{
  "fixtureId": "fixtureId"
}
'

Example Request Body

{
  "fixtureId": "fixtureId"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

delete_mapping

POST

/api/v2/io_mapping/delete_mapping

delete_mapping

delete_mapping › Request Body

Request schema for POST /api/v2/io_mapping/delete_mapping. IO mapping endpoint delete_mapping.

request-io_mapping_delete_mapping

slug

string · required

The mapping slug.

delete_mapping › Responses

200

Response schema for POST /api/v2/io_mapping/delete_mapping

response-io_mapping_delete_mapping

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint delete_mapping.

POST/api/v2/io_mapping/delete_mapping

curl --request POST \
  --url /api/v2/io_mapping/delete_mapping \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

delete_schema

POST

/api/v2/io_mapping/delete_schema

Delete a BYOS schema library row.

delete_schema › Request Body

Request schema for POST /api/v2/io_mapping/delete_schema. Delete a BYOS schema library row.

request-io_mapping_delete_schema

force

boolean

Proceed even when the target is still referenced.

id

string

The schema-library row id.

specId

string

A schema-library spec id. spec_id is accepted as well.

spec_id

string

A schema-library spec id. specId is accepted as well.

delete_schema › Responses

200

Response schema for POST /api/v2/io_mapping/delete_schema

response-io_mapping_delete_schema

success

boolean · required

Whether the request succeeded

data

object

Delete a BYOS schema library row.

POST/api/v2/io_mapping/delete_schema

curl --request POST \
  --url /api/v2/io_mapping/delete_schema \
  --header 'Content-Type: application/json' \
  --data '
{
  "force": true,
  "id": "id",
  "specId": "specId",
  "spec_id": "spec_id"
}
'

Example Request Body

{
  "force": true,
  "id": "id",
  "specId": "specId",
  "spec_id": "spec_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

discard_draft_note

POST

/api/v2/io_mapping/discard_draft_note

Drop one unsent note.

discard_draft_note › Request Body

Request schema for POST /api/v2/io_mapping/discard_draft_note. Drop one unsent note.

request-io_mapping_discard_draft_note

noteId

string · required

An existing note id.

discard_draft_note › Responses

200

Response schema for POST /api/v2/io_mapping/discard_draft_note

response-io_mapping_discard_draft_note

success

boolean · required

Whether the request succeeded

data

object

Drop one unsent note.

POST/api/v2/io_mapping/discard_draft_note

curl --request POST \
  --url /api/v2/io_mapping/discard_draft_note \
  --header 'Content-Type: application/json' \
  --data '
{
  "noteId": "noteId"
}
'

Example Request Body

{
  "noteId": "noteId"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

dismiss_memory_decision

POST

/api/v2/io_mapping/dismiss_memory_decision

Body: {mappingId, topic}.

dismiss_memory_decision › Request Body

Request schema for POST /api/v2/io_mapping/dismiss_memory_decision. Body: ``{mappingId, topic}``.

request-io_mapping_dismiss_memory_decision

mappingId

string · required

The mapping id.

topic

string · required

dismiss_memory_decision › Responses

200

Response schema for POST /api/v2/io_mapping/dismiss_memory_decision

response-io_mapping_dismiss_memory_decision

success

boolean · required

Whether the request succeeded

data

object

Body: {mappingId, topic}.

POST/api/v2/io_mapping/dismiss_memory_decision

curl --request POST \
  --url /api/v2/io_mapping/dismiss_memory_decision \
  --header 'Content-Type: application/json' \
  --data '
{
  "mappingId": "mappingId",
  "topic": "topic"
}
'

Example Request Body

{
  "mappingId": "mappingId",
  "topic": "topic"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

dismiss_memory_ruled_out

POST

/api/v2/io_mapping/dismiss_memory_ruled_out

Body: {mappingId, approach}.

dismiss_memory_ruled_out › Request Body

Request schema for POST /api/v2/io_mapping/dismiss_memory_ruled_out. Body: ``{mappingId, approach}``.

request-io_mapping_dismiss_memory_ruled_out

approach

string · required

mappingId

string · required

The mapping id.

dismiss_memory_ruled_out › Responses

200

Response schema for POST /api/v2/io_mapping/dismiss_memory_ruled_out

response-io_mapping_dismiss_memory_ruled_out

success

boolean · required

Whether the request succeeded

data

object

Body: {mappingId, approach}.

POST/api/v2/io_mapping/dismiss_memory_ruled_out

curl --request POST \
  --url /api/v2/io_mapping/dismiss_memory_ruled_out \
  --header 'Content-Type: application/json' \
  --data '
{
  "approach": "approach",
  "mappingId": "mappingId"
}
'

Example Request Body

{
  "approach": "approach",
  "mappingId": "mappingId"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

export_mapping

POST

/api/v2/io_mapping/export_mapping

Return the portable JSON blob for slug at the given version.

export_mapping › Request Body

Request schema for POST /api/v2/io_mapping/export_mapping. Return the portable JSON blob for ``slug`` at the given version.

request-io_mapping_export_mapping

slug

string · required

The mapping slug.

versionId

string

A stamped version id; defaults to the active version.

includeInputSchema

boolean

export_mapping › Responses

200

Response schema for POST /api/v2/io_mapping/export_mapping

response-io_mapping_export_mapping

success

boolean · required

Whether the request succeeded

data

object

Return the portable JSON blob for slug at the given version.

POST/api/v2/io_mapping/export_mapping

curl --request POST \
  --url /api/v2/io_mapping/export_mapping \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "versionId": "versionId",
  "includeInputSchema": true
}
'

Example Request Body

{
  "slug": "slug",
  "versionId": "versionId",
  "includeInputSchema": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

find_live_copilot_job

POST

/api/v2/io_mapping/find_live_copilot_job

The job already working on this mapping, if there is one.

find_live_copilot_job › Request Body

Request schema for POST /api/v2/io_mapping/find_live_copilot_job. The job already working on this mapping, if there is one.

request-io_mapping_find_live_copilot_job

slug

string · required

The mapping slug.

find_live_copilot_job › Responses

200

Response schema for POST /api/v2/io_mapping/find_live_copilot_job

response-io_mapping_find_live_copilot_job

success

boolean · required

Whether the request succeeded

data

object

The job already working on this mapping, if there is one.

POST/api/v2/io_mapping/find_live_copilot_job

curl --request POST \
  --url /api/v2/io_mapping/find_live_copilot_job \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

find_policy_type

POST

/api/v2/io_mapping/find_policy_type

As-of resolve (name, state, effectiveDate[, lineName]) to a minimal PT summary.

find_policy_type › Request Body

Request schema for POST /api/v2/io_mapping/find_policy_type. As-of resolve ``(name, state, effectiveDate[, lineName])`` to a minimal PT summary.

request-io_mapping_find_policy_type

effectiveDate

string

The effective date the policy type resolves on.

effective_date

string

lineName

string

line_name

string

name

string

Display name.

state

string

Two-letter state abbreviation.

find_policy_type › Responses

200

Response schema for POST /api/v2/io_mapping/find_policy_type

response-io_mapping_find_policy_type

success

boolean · required

Whether the request succeeded

data

object

As-of resolve (name, state, effectiveDate[, lineName]) to a minimal PT summary.

POST/api/v2/io_mapping/find_policy_type

curl --request POST \
  --url /api/v2/io_mapping/find_policy_type \
  --header 'Content-Type: application/json' \
  --data '
{
  "effectiveDate": "effectiveDate",
  "effective_date": "effective_date",
  "lineName": "lineName",
  "line_name": "line_name",
  "name": "name",
  "state": "state"
}
'

Example Request Body

{
  "effectiveDate": "effectiveDate",
  "effective_date": "effective_date",
  "lineName": "lineName",
  "line_name": "line_name",
  "name": "name",
  "state": "state"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

generate_sample

POST

/api/v2/io_mapping/generate_sample

Generate a valid, complete sample instance from a schema.

generate_sample › Request Body

Request schema for POST /api/v2/io_mapping/generate_sample. Generate a valid, complete sample instance from a schema.

request-io_mapping_generate_sample

effectiveDate

string

The effective date the policy type resolves on.

effective_date

string

name

string

Display name.

schema

string

state

string

Two-letter state abbreviation.

validate

string

generate_sample › Responses

200

Response schema for POST /api/v2/io_mapping/generate_sample

response-io_mapping_generate_sample

success

boolean · required

Whether the request succeeded

data

object

Generate a valid, complete sample instance from a schema.

POST/api/v2/io_mapping/generate_sample

curl --request POST \
  --url /api/v2/io_mapping/generate_sample \
  --header 'Content-Type: application/json' \
  --data '
{
  "effectiveDate": "effectiveDate",
  "effective_date": "effective_date",
  "name": "name",
  "schema": "schema",
  "state": "state",
  "validate": "validate"
}
'

Example Request Body

{
  "effectiveDate": "effectiveDate",
  "effective_date": "effective_date",
  "name": "name",
  "schema": "schema",
  "state": "state",
  "validate": "validate"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_analytics_slots

POST

/api/v2/io_mapping/get_analytics_slots

The slot grid for the ANALYTICS direction: the mapping's analytics schema flattened...

get_analytics_slots › Request Body

Request schema for POST /api/v2/io_mapping/get_analytics_slots. The slot grid for the ANALYTICS direction: the mapping's analytics schema

request-io_mapping_get_analytics_slots

slug

string · required

The mapping slug.

spec

object

get_analytics_slots › Responses

200

Response schema for POST /api/v2/io_mapping/get_analytics_slots

response-io_mapping_get_analytics_slots

success

boolean · required

Whether the request succeeded

data

object

The slot grid for the ANALYTICS direction: the mapping's analytics schema

POST/api/v2/io_mapping/get_analytics_slots

curl --request POST \
  --url /api/v2/io_mapping/get_analytics_slots \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "spec": {}
}
'

Example Request Body

{
  "slug": "slug",
  "spec": {}
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_copilot_job

POST

/api/v2/io_mapping/get_copilot_job

A running job's status, next to what the review still owes.

get_copilot_job › Request Body

Request schema for POST /api/v2/io_mapping/get_copilot_job. A running job's status, next to what the review still owes.

request-io_mapping_get_copilot_job

jobId

string · required

slug

string

The mapping slug.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

get_copilot_job › Responses

200

Response schema for POST /api/v2/io_mapping/get_copilot_job

response-io_mapping_get_copilot_job

success

boolean · required

Whether the request succeeded

data

object

A running job's status, next to what the review still owes.

POST/api/v2/io_mapping/get_copilot_job

curl --request POST \
  --url /api/v2/io_mapping/get_copilot_job \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobId": "jobId",
  "slug": "slug",
  "variant": "variant"
}
'

Example Request Body

{
  "jobId": "jobId",
  "slug": "slug",
  "variant": "variant"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_endpoint_slots

POST

/api/v2/io_mapping/get_endpoint_slots

The endpoint's own schema flattened into the slot grid: one section per top-level...

get_endpoint_slots › Request Body

Request schema for POST /api/v2/io_mapping/get_endpoint_slots. The endpoint's own schema flattened into the slot grid: one section per top-level

request-io_mapping_get_endpoint_slots

slug

string · required

The mapping slug.

direction

string

Which side of the mapping to act on: request, response or analytics.

get_endpoint_slots › Responses

200

Response schema for POST /api/v2/io_mapping/get_endpoint_slots

response-io_mapping_get_endpoint_slots

success

boolean · required

Whether the request succeeded

data

object

The endpoint's own schema flattened into the slot grid: one section per top-level

POST/api/v2/io_mapping/get_endpoint_slots

curl --request POST \
  --url /api/v2/io_mapping/get_endpoint_slots \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "direction": "direction"
}
'

Example Request Body

{
  "slug": "slug",
  "direction": "direction"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_mapping

POST

/api/v2/io_mapping/get_mapping

get_mapping

get_mapping › Request Body

Request schema for POST /api/v2/io_mapping/get_mapping. IO mapping endpoint get_mapping.

request-io_mapping_get_mapping

slug

string · required

The mapping slug.

get_mapping › Responses

200

Response schema for POST /api/v2/io_mapping/get_mapping

response-io_mapping_get_mapping

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint get_mapping.

POST/api/v2/io_mapping/get_mapping

curl --request POST \
  --url /api/v2/io_mapping/get_mapping \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_policy_type_definition

POST

/api/v2/io_mapping/get_policy_type_definition

Walkable PT definition (mapping scope: sub_lines + items + item_questions +...

get_policy_type_definition › Request Body

Request schema for POST /api/v2/io_mapping/get_policy_type_definition. Walkable PT definition (mapping scope: sub_lines + items + item_questions +

request-io_mapping_get_policy_type_definition

effectiveDate

string

The effective date the policy type resolves on.

effective_date

string

jmespathQuery

string

jmespath_query

string

lineName

string

line_name

string

name

string

Display name.

state

string

Two-letter state abbreviation.

get_policy_type_definition › Responses

200

Response schema for POST /api/v2/io_mapping/get_policy_type_definition

response-io_mapping_get_policy_type_definition

success

boolean · required

Whether the request succeeded

data

object

Walkable PT definition (mapping scope: sub_lines + items + item_questions +

POST/api/v2/io_mapping/get_policy_type_definition

curl --request POST \
  --url /api/v2/io_mapping/get_policy_type_definition \
  --header 'Content-Type: application/json' \
  --data '
{
  "effectiveDate": "effectiveDate",
  "effective_date": "effective_date",
  "jmespathQuery": "jmespathQuery",
  "jmespath_query": "jmespath_query",
  "lineName": "lineName",
  "line_name": "line_name",
  "name": "name",
  "state": "state"
}
'

Example Request Body

{
  "effectiveDate": "effectiveDate",
  "effective_date": "effective_date",
  "jmespathQuery": "jmespathQuery",
  "jmespath_query": "jmespath_query",
  "lineName": "lineName",
  "line_name": "line_name",
  "name": "name",
  "state": "state"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_policy_type_schema

POST

/api/v2/io_mapping/get_policy_type_schema

Synthesize the extended JSON Schema (the RH mapping target) for a resolved policy...

get_policy_type_schema › Request Body

Request schema for POST /api/v2/io_mapping/get_policy_type_schema. Synthesize the extended JSON Schema (the RH mapping target) for a resolved policy

request-io_mapping_get_policy_type_schema

effectiveDate

string

The effective date the policy type resolves on.

effective_date

string

name

string

Display name.

state

string

Two-letter state abbreviation.

get_policy_type_schema › Responses

200

Response schema for POST /api/v2/io_mapping/get_policy_type_schema

response-io_mapping_get_policy_type_schema

success

boolean · required

Whether the request succeeded

data

object

Synthesize the extended JSON Schema (the RH mapping target) for a resolved policy

POST/api/v2/io_mapping/get_policy_type_schema

curl --request POST \
  --url /api/v2/io_mapping/get_policy_type_schema \
  --header 'Content-Type: application/json' \
  --data '
{
  "effectiveDate": "effectiveDate",
  "effective_date": "effective_date",
  "name": "name",
  "state": "state"
}
'

Example Request Body

{
  "effectiveDate": "effectiveDate",
  "effective_date": "effective_date",
  "name": "name",
  "state": "state"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_resolver_constructs

POST

/api/v2/io_mapping/get_resolver_constructs

Everything a mapping DECLARES for its slots to share — each of it a cell: derived :...

get_resolver_constructs › Request Body

Request schema for POST /api/v2/io_mapping/get_resolver_constructs. Everything a mapping DECLARES for its slots to share — each of it a cell: derived

request-io_mapping_get_resolver_constructs

slug

string · required

The mapping slug.

get_resolver_constructs › Responses

200

Response schema for POST /api/v2/io_mapping/get_resolver_constructs

response-io_mapping_get_resolver_constructs

success

boolean · required

Whether the request succeeded

data

object

Everything a mapping DECLARES for its slots to share — each of it a cell: derived

POST/api/v2/io_mapping/get_resolver_constructs

curl --request POST \
  --url /api/v2/io_mapping/get_resolver_constructs \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_resolver_paths

POST

/api/v2/io_mapping/get_resolver_paths

The mapping's named path aliases ({name: absolute-path}) — the path analogue of...

get_resolver_paths › Request Body

Request schema for POST /api/v2/io_mapping/get_resolver_paths. The mapping's named path aliases ({name: absolute-path}) — the path analogue of

request-io_mapping_get_resolver_paths

slug

string · required

The mapping slug.

get_resolver_paths › Responses

200

Response schema for POST /api/v2/io_mapping/get_resolver_paths

response-io_mapping_get_resolver_paths

success

boolean · required

Whether the request succeeded

data

object

The mapping's named path aliases ({name: absolute-path}) — the path analogue of

POST/api/v2/io_mapping/get_resolver_paths

curl --request POST \
  --url /api/v2/io_mapping/get_resolver_paths \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_resolver_spec

POST

/api/v2/io_mapping/get_resolver_spec

The mapping's full resolver spec — the seed for the client's working copy.

get_resolver_spec › Request Body

Request schema for POST /api/v2/io_mapping/get_resolver_spec. The mapping's full resolver spec — the seed for the client's working copy.

request-io_mapping_get_resolver_spec

slug

string · required

The mapping slug.

get_resolver_spec › Responses

200

Response schema for POST /api/v2/io_mapping/get_resolver_spec

response-io_mapping_get_resolver_spec

success

boolean · required

Whether the request succeeded

data

object

The mapping's full resolver spec — the seed for the client's working copy.

POST/api/v2/io_mapping/get_resolver_spec

curl --request POST \
  --url /api/v2/io_mapping/get_resolver_spec \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_review

POST

/api/v2/io_mapping/get_review

The mapping stated in the carrier's language -- one row per slot.

Code
Settled threads are hidden unless ``includeResolved`` asks for them.

get_review › Request Body

Request schema for POST /api/v2/io_mapping/get_review. The mapping stated in the carrier's language -- one row per slot.

request-io_mapping_get_review

slug

string · required

The mapping slug.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

versionId

string

A stamped version id; defaults to the active version.

fixtureId

string

A fixture id; defaults to the mapping's default fixture.

includeResolved

boolean

get_review › Responses

200

Response schema for POST /api/v2/io_mapping/get_review

response-io_mapping_get_review

success

boolean · required

Whether the request succeeded

data

object

The mapping stated in the carrier's language -- one row per slot.

POST/api/v2/io_mapping/get_review

curl --request POST \
  --url /api/v2/io_mapping/get_review \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "policyType": "policyType",
  "state": "state",
  "versionId": "versionId",
  "fixtureId": "fixtureId",
  "includeResolved": true
}
'

Example Request Body

{
  "slug": "slug",
  "policyType": "policyType",
  "state": "state",
  "versionId": "versionId",
  "fixtureId": "fixtureId",
  "includeResolved": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_schema

POST

/api/v2/io_mapping/get_schema

One schema library row WITH content.

get_schema › Request Body

Request schema for POST /api/v2/io_mapping/get_schema. One schema library row WITH content.

request-io_mapping_get_schema

id

string

The schema-library row id.

specId

string

A schema-library spec id. spec_id is accepted as well.

spec_id

string

A schema-library spec id. specId is accepted as well.

get_schema › Responses

200

Response schema for POST /api/v2/io_mapping/get_schema

response-io_mapping_get_schema

success

boolean · required

Whether the request succeeded

data

object

One schema library row WITH content.

POST/api/v2/io_mapping/get_schema

curl --request POST \
  --url /api/v2/io_mapping/get_schema \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "specId": "specId",
  "spec_id": "spec_id"
}
'

Example Request Body

{
  "id": "id",
  "specId": "specId",
  "spec_id": "spec_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_schema_index

POST

/api/v2/io_mapping/get_schema_index

Parsed ACORD schema index (codes, code lists, elements, aggregates) for schema_id.

get_schema_index › Request Body

Request schema for POST /api/v2/io_mapping/get_schema_index. Parsed ACORD schema index (codes, code lists, elements, aggregates) for ``schema_id``.

request-io_mapping_get_schema_index

id

string

schema_id

string

get_schema_index › Responses

200

Response schema for POST /api/v2/io_mapping/get_schema_index

response-io_mapping_get_schema_index

success

boolean · required

Whether the request succeeded

data

object

Parsed ACORD schema index (codes, code lists, elements, aggregates) for schema_id.

POST/api/v2/io_mapping/get_schema_index

curl --request POST \
  --url /api/v2/io_mapping/get_schema_index \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "schema_id": "schema_id"
}
'

Example Request Body

{
  "id": "id",
  "schema_id": "schema_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_slotfill_context

POST

/api/v2/io_mapping/get_slotfill_context

Data for the schema-bound slotFill table editor: source.codes — the LEFT key...

get_slotfill_context › Request Body

Request schema for POST /api/v2/io_mapping/get_slotfill_context. Data for the schema-bound slotFill table editor: source.codes — the LEFT key

request-io_mapping_get_slotfill_context

slug

string · required

The mapping slug.

name

string

Display name.

effectiveDate

string

The effective date the policy type resolves on.

get_slotfill_context › Responses

200

Response schema for POST /api/v2/io_mapping/get_slotfill_context

response-io_mapping_get_slotfill_context

success

boolean · required

Whether the request succeeded

data

object

Data for the schema-bound slotFill table editor: source.codes — the LEFT key

POST/api/v2/io_mapping/get_slotfill_context

curl --request POST \
  --url /api/v2/io_mapping/get_slotfill_context \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "name": "name",
  "effectiveDate": "effectiveDate"
}
'

Example Request Body

{
  "slug": "slug",
  "name": "name",
  "effectiveDate": "effectiveDate"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_source_paths

POST

/api/v2/io_mapping/get_source_paths

Flatten the inbound document to candidate SOURCE paths + sample values in one call —...

get_source_paths › Request Body

Request schema for POST /api/v2/io_mapping/get_source_paths. Flatten the inbound document to candidate SOURCE paths + sample values in one

request-io_mapping_get_source_paths

slug

string · required

The mapping slug.

fixtureId

string

A fixture id; defaults to the mapping's default fixture.

get_source_paths › Responses

200

Response schema for POST /api/v2/io_mapping/get_source_paths

response-io_mapping_get_source_paths

success

boolean · required

Whether the request succeeded

data

object

Flatten the inbound document to candidate SOURCE paths + sample values in one

POST/api/v2/io_mapping/get_source_paths

curl --request POST \
  --url /api/v2/io_mapping/get_source_paths \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "fixtureId": "fixtureId"
}
'

Example Request Body

{
  "slug": "slug",
  "fixtureId": "fixtureId"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_spec_overview

POST

/api/v2/io_mapping/get_spec_overview

Top-level snapshot of one spec.

get_spec_overview › Request Body

Request schema for POST /api/v2/io_mapping/get_spec_overview. Top-level snapshot of one spec.

request-io_mapping_get_spec_overview

specId

string

A schema-library spec id. spec_id is accepted as well.

spec_id

string

A schema-library spec id. specId is accepted as well.

get_spec_overview › Responses

200

Response schema for POST /api/v2/io_mapping/get_spec_overview

response-io_mapping_get_spec_overview

success

boolean · required

Whether the request succeeded

data

object

Top-level snapshot of one spec.

POST/api/v2/io_mapping/get_spec_overview

curl --request POST \
  --url /api/v2/io_mapping/get_spec_overview \
  --header 'Content-Type: application/json' \
  --data '
{
  "specId": "specId",
  "spec_id": "spec_id"
}
'

Example Request Body

{
  "specId": "specId",
  "spec_id": "spec_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

get_variant_slots

POST

/api/v2/io_mapping/get_variant_slots

The Resolver Stack FORM contract for one (policyType, state) variant: the...

get_variant_slots › Request Body

Request schema for POST /api/v2/io_mapping/get_variant_slots. The Resolver Stack FORM contract for one (policyType, state) variant: the

request-io_mapping_get_variant_slots

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

effectiveDate

string

The effective date the policy type resolves on.

slug

string

The mapping slug.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

fixtureId

string

A fixture id; defaults to the mapping's default fixture.

includeSuggestions

boolean

includeTemplate

boolean

spec

object

get_variant_slots › Responses

200

Response schema for POST /api/v2/io_mapping/get_variant_slots

response-io_mapping_get_variant_slots

success

boolean · required

Whether the request succeeded

data

object

The Resolver Stack FORM contract for one (policyType, state) variant: the

POST/api/v2/io_mapping/get_variant_slots

curl --request POST \
  --url /api/v2/io_mapping/get_variant_slots \
  --header 'Content-Type: application/json' \
  --data '
{
  "policyType": "policyType",
  "state": "state",
  "effectiveDate": "effectiveDate",
  "slug": "slug",
  "variant": "variant",
  "fixtureId": "fixtureId",
  "includeSuggestions": true,
  "includeTemplate": true,
  "spec": {}
}
'

Example Request Body

{
  "policyType": "policyType",
  "state": "state",
  "effectiveDate": "effectiveDate",
  "slug": "slug",
  "variant": "variant",
  "fixtureId": "fixtureId",
  "includeSuggestions": true,
  "includeTemplate": true,
  "spec": {}
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

import_mapping

POST

/api/v2/io_mapping/import_mapping

Create a new mapping from an export blob.

import_mapping › Request Body

Request schema for POST /api/v2/io_mapping/import_mapping. Create a new mapping from an export blob.

request-io_mapping_import_mapping

payload

object

The exported mapping document to import.

slugOverride

string

import_mapping › Responses

200

Response schema for POST /api/v2/io_mapping/import_mapping

response-io_mapping_import_mapping

success

boolean · required

Whether the request succeeded

data

object

Create a new mapping from an export blob.

POST/api/v2/io_mapping/import_mapping

curl --request POST \
  --url /api/v2/io_mapping/import_mapping \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {},
  "slugOverride": "slugOverride"
}
'

Example Request Body

{
  "payload": {},
  "slugOverride": "slugOverride"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

infer_schema_from_workbook

POST

/api/v2/io_mapping/infer_schema_from_workbook

Propose a JSON Schema from an uploaded workbook. Writes nothing -- confirm by calling upload_schema with the result.

infer_schema_from_workbook › Request Body

Request schema for POST /api/v2/io_mapping/infer_schema_from_workbook. Propose a JSON Schema from an uploaded workbook. Writes nothing -- confirm by

request-io_mapping_infer_schema_from_workbook

content

string · required

The document body.

filename

string

name

string

Display name.

infer_schema_from_workbook › Responses

200

Response schema for POST /api/v2/io_mapping/infer_schema_from_workbook

response-io_mapping_infer_schema_from_workbook

success

boolean · required

Whether the request succeeded

data

object

Propose a JSON Schema from an uploaded workbook. Writes nothing -- confirm by

POST/api/v2/io_mapping/infer_schema_from_workbook

curl --request POST \
  --url /api/v2/io_mapping/infer_schema_from_workbook \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "content",
  "filename": "filename",
  "name": "name"
}
'

Example Request Body

{
  "content": "content",
  "filename": "filename",
  "name": "name"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

introspect_fixture

POST

/api/v2/io_mapping/introspect_fixture

Tag tree for document.<...> autocomplete.

introspect_fixture › Request Body

Request schema for POST /api/v2/io_mapping/introspect_fixture. Tag tree for ``document.<...>`` autocomplete.

request-io_mapping_introspect_fixture

fixtureId

string

A fixture id; defaults to the mapping's default fixture.

content

string

The document body.

contentType

string

introspect_fixture › Responses

200

Response schema for POST /api/v2/io_mapping/introspect_fixture

response-io_mapping_introspect_fixture

success

boolean · required

Whether the request succeeded

data

object

Tag tree for document.<...> autocomplete.

POST/api/v2/io_mapping/introspect_fixture

curl --request POST \
  --url /api/v2/io_mapping/introspect_fixture \
  --header 'Content-Type: application/json' \
  --data '
{
  "fixtureId": "fixtureId",
  "content": "content",
  "contentType": "contentType"
}
'

Example Request Body

{
  "fixtureId": "fixtureId",
  "content": "content",
  "contentType": "contentType"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_bruno_examples

POST

/api/v2/io_mapping/list_bruno_examples

Bruno-collection examples {name, collection, method, url, body}, optionally...

list_bruno_examples › Request Body

Request schema for POST /api/v2/io_mapping/list_bruno_examples. Bruno-collection examples ``{name, collection, method, url, body}``, optionally

request-io_mapping_list_bruno_examples

apiCall

string

list_bruno_examples › Responses

200

Response schema for POST /api/v2/io_mapping/list_bruno_examples

response-io_mapping_list_bruno_examples

success

boolean · required

Whether the request succeeded

data

object

Bruno-collection examples {name, collection, method, url, body}, optionally

POST/api/v2/io_mapping/list_bruno_examples

curl --request POST \
  --url /api/v2/io_mapping/list_bruno_examples \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiCall": "apiCall"
}
'

Example Request Body

{
  "apiCall": "apiCall"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_endpoints

POST

/api/v2/io_mapping/list_endpoints

Dotted api paths the apiCall pill suggests.

list_endpoints › Request Body

Request schema for POST /api/v2/io_mapping/list_endpoints. Dotted api paths the apiCall pill suggests.

request-io_mapping_list_endpoints

refresh

string

list_endpoints › Responses

200

Response schema for POST /api/v2/io_mapping/list_endpoints

response-io_mapping_list_endpoints

success

boolean · required

Whether the request succeeded

data

object

Dotted api paths the apiCall pill suggests.

POST/api/v2/io_mapping/list_endpoints

curl --request POST \
  --url /api/v2/io_mapping/list_endpoints \
  --header 'Content-Type: application/json' \
  --data '
{
  "refresh": "refresh"
}
'

Example Request Body

{
  "refresh": "refresh"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_fixture_coordinates

POST

/api/v2/io_mapping/list_fixture_coordinates

Every fixture on the mapping, with the COORDINATE its request resolves to.

list_fixture_coordinates › Request Body

Request schema for POST /api/v2/io_mapping/list_fixture_coordinates. Every fixture on the mapping, with the COORDINATE its request resolves to.

request-io_mapping_list_fixture_coordinates

slug

string · required

The mapping slug.

spec

object

list_fixture_coordinates › Responses

200

Response schema for POST /api/v2/io_mapping/list_fixture_coordinates

response-io_mapping_list_fixture_coordinates

success

boolean · required

Whether the request succeeded

data

object

Every fixture on the mapping, with the COORDINATE its request resolves to.

POST/api/v2/io_mapping/list_fixture_coordinates

curl --request POST \
  --url /api/v2/io_mapping/list_fixture_coordinates \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "spec": {}
}
'

Example Request Body

{
  "slug": "slug",
  "spec": {}
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_fixtures

POST

/api/v2/io_mapping/list_fixtures

Return every fixture on the mapping, with content.

list_fixtures › Request Body

Request schema for POST /api/v2/io_mapping/list_fixtures. Return every fixture on the mapping, **with content**.

request-io_mapping_list_fixtures

slug

string · required

The mapping slug.

list_fixtures › Responses

200

Response schema for POST /api/v2/io_mapping/list_fixtures

response-io_mapping_list_fixtures

success

boolean · required

Whether the request succeeded

data

object

Return every fixture on the mapping, with content.

POST/api/v2/io_mapping/list_fixtures

curl --request POST \
  --url /api/v2/io_mapping/list_fixtures \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_mappings

POST

/api/v2/io_mapping/list_mappings

list_mappings

list_mappings › Request Body

Request schema for POST /api/v2/io_mapping/list_mappings. IO mapping endpoint list_mappings.

request-io_mapping_list_mappings

kind

string

The record kind to filter by.

list_mappings › Responses

200

Response schema for POST /api/v2/io_mapping/list_mappings

response-io_mapping_list_mappings

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint list_mappings.

POST/api/v2/io_mapping/list_mappings

curl --request POST \
  --url /api/v2/io_mapping/list_mappings \
  --header 'Content-Type: application/json' \
  --data '{
  "kind": "kind"
}'

Example Request Body

{
  "kind": "kind"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_notes

POST

/api/v2/io_mapping/list_notes

Note threads on a mapping.

list_notes › Request Body

Request schema for POST /api/v2/io_mapping/list_notes. Note threads on a mapping.

request-io_mapping_list_notes

slug

string · required

The mapping slug.

status

string

anchorKind

boolean

anchorRef

string

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

list_notes › Responses

200

Response schema for POST /api/v2/io_mapping/list_notes

response-io_mapping_list_notes

success

boolean · required

Whether the request succeeded

data

object

Note threads on a mapping.

POST/api/v2/io_mapping/list_notes

curl --request POST \
  --url /api/v2/io_mapping/list_notes \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "status": "status",
  "anchorKind": true,
  "anchorRef": "anchorRef",
  "variant": "variant"
}
'

Example Request Body

{
  "slug": "slug",
  "status": "status",
  "anchorKind": true,
  "anchorRef": "anchorRef",
  "variant": "variant"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_policy_types

POST

/api/v2/io_mapping/list_policy_types

Every PolicyType row for the carrier -- used by the copilot's discovery flow before...

list_policy_types › Request Body

Request schema for POST /api/v2/io_mapping/list_policy_types. Every PolicyType row for the carrier -- used by the copilot's discovery flow

request-io_mapping_list_policy_types

list_policy_types › Responses

200

Response schema for POST /api/v2/io_mapping/list_policy_types

response-io_mapping_list_policy_types

success

boolean · required

Whether the request succeeded

data

object

Every PolicyType row for the carrier -- used by the copilot's discovery flow

POST/api/v2/io_mapping/list_policy_types

curl --request POST \
  --url /api/v2/io_mapping/list_policy_types \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_schemas

POST

/api/v2/io_mapping/list_schemas

Schema library for the manager UI.

list_schemas › Request Body

Request schema for POST /api/v2/io_mapping/list_schemas. Schema library for the manager UI.

request-io_mapping_list_schemas

role

string

list_schemas › Responses

200

Response schema for POST /api/v2/io_mapping/list_schemas

response-io_mapping_list_schemas

success

boolean · required

Whether the request succeeded

data

object

Schema library for the manager UI.

POST/api/v2/io_mapping/list_schemas

curl --request POST \
  --url /api/v2/io_mapping/list_schemas \
  --header 'Content-Type: application/json' \
  --data '{
  "role": "role"
}'

Example Request Body

{
  "role": "role"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_spec_indexes

POST

/api/v2/io_mapping/list_spec_indexes

Named query targets in a spec (code lists, aggregates, enums, ...).

list_spec_indexes › Request Body

Request schema for POST /api/v2/io_mapping/list_spec_indexes. Named query targets in a spec (code lists, aggregates, enums, ...).

request-io_mapping_list_spec_indexes

kind

boolean

The record kind to filter by.

specId

string

A schema-library spec id. spec_id is accepted as well.

spec_id

string

A schema-library spec id. specId is accepted as well.

list_spec_indexes › Responses

200

Response schema for POST /api/v2/io_mapping/list_spec_indexes

response-io_mapping_list_spec_indexes

success

boolean · required

Whether the request succeeded

data

object

Named query targets in a spec (code lists, aggregates, enums, ...).

POST/api/v2/io_mapping/list_spec_indexes

curl --request POST \
  --url /api/v2/io_mapping/list_spec_indexes \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": true,
  "specId": "specId",
  "spec_id": "spec_id"
}
'

Example Request Body

{
  "kind": true,
  "specId": "specId",
  "spec_id": "spec_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_specs

POST

/api/v2/io_mapping/list_specs

Every spec the registry knows, sorted (source, spec_id).

list_specs › Request Body

Request schema for POST /api/v2/io_mapping/list_specs. Every spec the registry knows, sorted ``(source, spec_id)``.

request-io_mapping_list_specs

list_specs › Responses

200

Response schema for POST /api/v2/io_mapping/list_specs

response-io_mapping_list_specs

success

boolean · required

Whether the request succeeded

data

object

Every spec the registry knows, sorted (source, spec_id).

POST/api/v2/io_mapping/list_specs

curl --request POST \
  --url /api/v2/io_mapping/list_specs \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

list_versions

POST

/api/v2/io_mapping/list_versions

list_versions

list_versions › Request Body

Request schema for POST /api/v2/io_mapping/list_versions. IO mapping endpoint list_versions.

request-io_mapping_list_versions

slug

string · required

The mapping slug.

list_versions › Responses

200

Response schema for POST /api/v2/io_mapping/list_versions

response-io_mapping_list_versions

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint list_versions.

POST/api/v2/io_mapping/list_versions

curl --request POST \
  --url /api/v2/io_mapping/list_versions \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

load_revision_quote

POST

/api/v2/io_mapping/load_revision_quote

Reconstruct an existing revision as a create_quote_extended quote_info for...

load_revision_quote › Request Body

Request schema for POST /api/v2/io_mapping/load_revision_quote. Reconstruct an existing revision as a ``create_quote_extended`` ``quote_info``

request-io_mapping_load_revision_quote

policyId

string

revisionId

string

load_revision_quote › Responses

200

Response schema for POST /api/v2/io_mapping/load_revision_quote

response-io_mapping_load_revision_quote

success

boolean · required

Whether the request succeeded

data

object

Reconstruct an existing revision as a create_quote_extended quote_info

POST/api/v2/io_mapping/load_revision_quote

curl --request POST \
  --url /api/v2/io_mapping/load_revision_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "policyId": "policyId",
  "revisionId": "revisionId"
}
'

Example Request Body

{
  "policyId": "policyId",
  "revisionId": "revisionId"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

lookup_spec_enum

POST

/api/v2/io_mapping/lookup_spec_enum

Members of a named code list / enum within a spec.

lookup_spec_enum › Request Body

Request schema for POST /api/v2/io_mapping/lookup_spec_enum. Members of a named code list / enum within a spec.

request-io_mapping_lookup_spec_enum

code

string

limit

integer

Maximum rows to return.

listName

string

listNames

string[]

Names of the code lists to read.

list_name

string

list_names

string[]

Names of the code lists to read.

query

string

specId

string

A schema-library spec id. spec_id is accepted as well.

spec_id

string

A schema-library spec id. specId is accepted as well.

lookup_spec_enum › Responses

200

Response schema for POST /api/v2/io_mapping/lookup_spec_enum

response-io_mapping_lookup_spec_enum

success

boolean · required

Whether the request succeeded

data

object

Members of a named code list / enum within a spec.

POST/api/v2/io_mapping/lookup_spec_enum

curl --request POST \
  --url /api/v2/io_mapping/lookup_spec_enum \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "code",
  "limit": 0,
  "listName": "listName",
  "listNames": [
    "string"
  ],
  "list_name": "list_name",
  "list_names": [
    "string"
  ],
  "query": "query",
  "specId": "specId",
  "spec_id": "spec_id"
}
'

Example Request Body

{
  "code": "code",
  "limit": 0,
  "listName": "listName",
  "listNames": [
    "string"
  ],
  "list_name": "list_name",
  "list_names": [
    "string"
  ],
  "query": "query",
  "specId": "specId",
  "spec_id": "spec_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

lookup_spec_path

POST

/api/v2/io_mapping/lookup_spec_path

Resolve a path within a spec (ACORD: dotted element/aggregate; JSONSchema: dotted...

lookup_spec_path › Request Body

Request schema for POST /api/v2/io_mapping/lookup_spec_path. Resolve a path within a spec (ACORD: dotted element/aggregate; JSONSchema: dotted

request-io_mapping_lookup_spec_path

path

string

specId

string

A schema-library spec id. spec_id is accepted as well.

spec_id

string

A schema-library spec id. specId is accepted as well.

lookup_spec_path › Responses

200

Response schema for POST /api/v2/io_mapping/lookup_spec_path

response-io_mapping_lookup_spec_path

success

boolean · required

Whether the request succeeded

data

object

Resolve a path within a spec (ACORD: dotted element/aggregate; JSONSchema: dotted

POST/api/v2/io_mapping/lookup_spec_path

curl --request POST \
  --url /api/v2/io_mapping/lookup_spec_path \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "path",
  "specId": "specId",
  "spec_id": "spec_id"
}
'

Example Request Body

{
  "path": "path",
  "specId": "specId",
  "spec_id": "spec_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

note_follow_up

POST

/api/v2/io_mapping/note_follow_up

Record a JOB for later -- not a question, so nobody owes a reply and it does not hold up the review. "Call create_quote_extended once UAT credentials are confirmed" is a follow-up, not a question.

note_follow_up › Request Body

Request schema for POST /api/v2/io_mapping/note_follow_up. Record a JOB for later -- not a question, so nobody owes a reply and it does

request-io_mapping_note_follow_up

slug

string · required

The mapping slug.

body

string

The note body.

audience

string

anchorKind

string

anchorRef

string

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

authorKind

string

note_follow_up › Responses

200

Response schema for POST /api/v2/io_mapping/note_follow_up

response-io_mapping_note_follow_up

success

boolean · required

Whether the request succeeded

data

object

Record a JOB for later -- not a question, so nobody owes a reply and it does

POST/api/v2/io_mapping/note_follow_up

curl --request POST \
  --url /api/v2/io_mapping/note_follow_up \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "body": "body",
  "audience": "audience",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "authorKind": "authorKind"
}
'

Example Request Body

{
  "slug": "slug",
  "body": "body",
  "audience": "audience",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "authorKind": "authorKind"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

promote_slot_to_base

POST

/api/v2/io_mapping/promote_slot_to_base

Factor a slot's per-variant override UP into the shared base catalog: the overlay...

promote_slot_to_base › Request Body

Request schema for POST /api/v2/io_mapping/promote_slot_to_base. Factor a slot's per-variant override UP into the shared base catalog: the overlay

request-io_mapping_promote_slot_to_base

slug

string · required

The mapping slug.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

item

string

field

string

kind

string

The record kind to filter by.

recompile

boolean

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

promote_slot_to_base › Responses

200

Response schema for POST /api/v2/io_mapping/promote_slot_to_base

response-io_mapping_promote_slot_to_base

success

boolean · required

Whether the request succeeded

data

object

Factor a slot's per-variant override UP into the shared base catalog: the overlay

POST/api/v2/io_mapping/promote_slot_to_base

curl --request POST \
  --url /api/v2/io_mapping/promote_slot_to_base \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "variant": "variant",
  "item": "item",
  "field": "field",
  "kind": "kind",
  "recompile": true,
  "policyType": "policyType",
  "state": "state"
}
'

Example Request Body

{
  "slug": "slug",
  "variant": "variant",
  "item": "item",
  "field": "field",
  "kind": "kind",
  "recompile": true,
  "policyType": "policyType",
  "state": "state"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

reconcile_mapping

POST

/api/v2/io_mapping/reconcile_mapping

Reconcile a mapping against the LIVE policy-type definition for one variant.

reconcile_mapping › Request Body

Request schema for POST /api/v2/io_mapping/reconcile_mapping. Reconcile a mapping against the LIVE policy-type definition for one variant.

request-io_mapping_reconcile_mapping

slug

string · required

The mapping slug.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

effectiveDate

string

The effective date the policy type resolves on.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

reconcile_mapping › Responses

200

Response schema for POST /api/v2/io_mapping/reconcile_mapping

response-io_mapping_reconcile_mapping

success

boolean · required

Whether the request succeeded

data

object

Reconcile a mapping against the LIVE policy-type definition for one variant.

POST/api/v2/io_mapping/reconcile_mapping

curl --request POST \
  --url /api/v2/io_mapping/reconcile_mapping \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "policyType": "policyType",
  "state": "state",
  "effectiveDate": "effectiveDate",
  "variant": "variant"
}
'

Example Request Body

{
  "slug": "slug",
  "policyType": "policyType",
  "state": "state",
  "effectiveDate": "effectiveDate",
  "variant": "variant"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

rename_mapping_slug

POST

/api/v2/io_mapping/rename_mapping_slug

Rename an existing mapping's slug.

rename_mapping_slug › Request Body

Request schema for POST /api/v2/io_mapping/rename_mapping_slug. Rename an existing mapping's slug.

request-io_mapping_rename_mapping_slug

slug

string · required

The mapping slug.

newSlug

string · required

rename_mapping_slug › Responses

200

Response schema for POST /api/v2/io_mapping/rename_mapping_slug

response-io_mapping_rename_mapping_slug

success

boolean · required

Whether the request succeeded

data

object

Rename an existing mapping's slug.

POST/api/v2/io_mapping/rename_mapping_slug

curl --request POST \
  --url /api/v2/io_mapping/rename_mapping_slug \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "newSlug": "newSlug"
}
'

Example Request Body

{
  "slug": "slug",
  "newSlug": "newSlug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

render

POST

/api/v2/io_mapping/render

Live preview -- render an in-flight (mapping, fixture, template) triple.

render › Request Body

Request schema for POST /api/v2/io_mapping/render. Live preview -- render an in-flight (mapping, fixture, template) triple.

request-io_mapping_render

policyTypeEffectiveDate

string

policyTypeState

string

slug

string

The mapping slug.

mappingId

string

The mapping id.

fixtureId

string

A fixture id; defaults to the mapping's default fixture.

templateOverride

string

fixtureContentOverride

string

fixtureContentType

string

apiResponseOverride

string

templateSha256

string

SHA-256 (hex) of the client's copy, sent in place of templateOverride. The stored copy is rendered only when its digest matches; otherwise the response is resend.

fixtureContentSha256

string

SHA-256 (hex) of the client's copy, sent in place of fixtureContentOverride. The stored copy is rendered only when its digest matches; otherwise the response is resend.

apiResponseSha256

string

SHA-256 (hex) of the client's copy, sent in place of apiResponseOverride. The stored copy is rendered only when its digest matches; otherwise the response is resend.

direction

string

Which side of the mapping to act on: request, response or analytics.

outputFormat

string

render › Responses

200

Response schema for POST /api/v2/io_mapping/render

response-io_mapping_render

success

boolean · required

Whether the request succeeded

data

object

Live preview -- render an in-flight (mapping, fixture, template) triple. When a digest in the request does not match the stored copy, nothing is rendered and data is {"resend": [...]}, naming the override fields to send in full.

POST/api/v2/io_mapping/render

curl --request POST \
  --url /api/v2/io_mapping/render \
  --header 'Content-Type: application/json' \
  --data '
{
  "policyTypeEffectiveDate": "policyTypeEffectiveDate",
  "policyTypeState": "policyTypeState",
  "slug": "slug",
  "mappingId": "mappingId",
  "fixtureId": "fixtureId",
  "templateOverride": "templateOverride",
  "fixtureContentOverride": "fixtureContentOverride",
  "fixtureContentType": "fixtureContentType",
  "apiResponseOverride": "apiResponseOverride",
  "templateSha256": "templateSha256",
  "fixtureContentSha256": "fixtureContentSha256",
  "apiResponseSha256": "apiResponseSha256",
  "direction": "direction",
  "outputFormat": "outputFormat"
}
'

Example Request Body

{
  "policyTypeEffectiveDate": "policyTypeEffectiveDate",
  "policyTypeState": "policyTypeState",
  "slug": "slug",
  "mappingId": "mappingId",
  "fixtureId": "fixtureId",
  "templateOverride": "templateOverride",
  "fixtureContentOverride": "fixtureContentOverride",
  "fixtureContentType": "fixtureContentType",
  "apiResponseOverride": "apiResponseOverride",
  "templateSha256": "templateSha256",
  "fixtureContentSha256": "fixtureContentSha256",
  "apiResponseSha256": "apiResponseSha256",
  "direction": "direction",
  "outputFormat": "outputFormat"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

reply_to_note

POST

/api/v2/io_mapping/reply_to_note

Answer one review note, with an outcome.

reply_to_note › Request Body

Request schema for POST /api/v2/io_mapping/reply_to_note. Answer one review note, with an outcome.

request-io_mapping_reply_to_note

slug

string · required

The mapping slug.

noteId

string · required

An existing note id.

body

string

The note body.

outcome

string

reply_to_note › Responses

200

Response schema for POST /api/v2/io_mapping/reply_to_note

response-io_mapping_reply_to_note

success

boolean · required

Whether the request succeeded

data

object

Answer one review note, with an outcome.

POST/api/v2/io_mapping/reply_to_note

curl --request POST \
  --url /api/v2/io_mapping/reply_to_note \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "noteId": "noteId",
  "body": "body",
  "outcome": "outcome"
}
'

Example Request Body

{
  "slug": "slug",
  "noteId": "noteId",
  "body": "body",
  "outcome": "outcome"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

resolve_memory_followup

POST

/api/v2/io_mapping/resolve_memory_followup

Body: {mappingId, topic}.

resolve_memory_followup › Request Body

Request schema for POST /api/v2/io_mapping/resolve_memory_followup. Body: ``{mappingId, topic}``.

request-io_mapping_resolve_memory_followup

mappingId

string · required

The mapping id.

topic

string · required

resolve_memory_followup › Responses

200

Response schema for POST /api/v2/io_mapping/resolve_memory_followup

response-io_mapping_resolve_memory_followup

success

boolean · required

Whether the request succeeded

data

object

Body: {mappingId, topic}.

POST/api/v2/io_mapping/resolve_memory_followup

curl --request POST \
  --url /api/v2/io_mapping/resolve_memory_followup \
  --header 'Content-Type: application/json' \
  --data '
{
  "mappingId": "mappingId",
  "topic": "topic"
}
'

Example Request Body

{
  "mappingId": "mappingId",
  "topic": "topic"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

resolve_note

POST

/api/v2/io_mapping/resolve_note

Close a note thread, or reopen it.

resolve_note › Request Body

Request schema for POST /api/v2/io_mapping/resolve_note. Close a note thread, or reopen it.

request-io_mapping_resolve_note

noteId

string · required

An existing note id.

resolved

boolean

resolve_note › Responses

200

Response schema for POST /api/v2/io_mapping/resolve_note

response-io_mapping_resolve_note

success

boolean · required

Whether the request succeeded

data

object

Close a note thread, or reopen it.

POST/api/v2/io_mapping/resolve_note

curl --request POST \
  --url /api/v2/io_mapping/resolve_note \
  --header 'Content-Type: application/json' \
  --data '
{
  "noteId": "noteId",
  "resolved": true
}
'

Example Request Body

{
  "noteId": "noteId",
  "resolved": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

review_inbox

POST

/api/v2/io_mapping/review_inbox

Review notes still waiting on a reply.

review_inbox › Request Body

Request schema for POST /api/v2/io_mapping/review_inbox. Review notes still waiting on a reply.

request-io_mapping_review_inbox

slug

string · required

The mapping slug.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

review_inbox › Responses

200

Response schema for POST /api/v2/io_mapping/review_inbox

response-io_mapping_review_inbox

success

boolean · required

Whether the request succeeded

data

object

Review notes still waiting on a reply.

POST/api/v2/io_mapping/review_inbox

curl --request POST \
  --url /api/v2/io_mapping/review_inbox \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "variant": "variant"
}
'

Example Request Body

{
  "slug": "slug",
  "variant": "variant"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

review_index

POST

/api/v2/io_mapping/review_index

The mapping's products and what each still owes -- the review's front door, for arriving without a product named.

review_index › Request Body

Request schema for POST /api/v2/io_mapping/review_index. The mapping's products and what each still owes -- the review's front door, for

request-io_mapping_review_index

slug

string · required

The mapping slug.

review_index › Responses

200

Response schema for POST /api/v2/io_mapping/review_index

response-io_mapping_review_index

success

boolean · required

Whether the request succeeded

data

object

The mapping's products and what each still owes -- the review's front door, for

POST/api/v2/io_mapping/review_index

curl --request POST \
  --url /api/v2/io_mapping/review_index \
  --header 'Content-Type: application/json' \
  --data '{
  "slug": "slug"
}'

Example Request Body

{
  "slug": "slug"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

save_draft_note

POST

/api/v2/io_mapping/save_draft_note

Store a reviewer's unsent answer so a reload does not discard it. Invisible to the copilot until the review is submitted.

save_draft_note › Request Body

Request schema for POST /api/v2/io_mapping/save_draft_note. Store a reviewer's unsent answer so a reload does not discard it. Invisible to

request-io_mapping_save_draft_note

slug

string · required

The mapping slug.

body

string

The note body.

anchorKind

string

anchorRef

string

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

replyTo

string

kind

string

The record kind to filter by.

audience

string

noteId

string

An existing note id.

outcome

string

save_draft_note › Responses

200

Response schema for POST /api/v2/io_mapping/save_draft_note

response-io_mapping_save_draft_note

success

boolean · required

Whether the request succeeded

data

object

Store a reviewer's unsent answer so a reload does not discard it. Invisible to

POST/api/v2/io_mapping/save_draft_note

curl --request POST \
  --url /api/v2/io_mapping/save_draft_note \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "body": "body",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "replyTo": "replyTo",
  "kind": "kind",
  "audience": "audience",
  "noteId": "noteId",
  "outcome": "outcome"
}
'

Example Request Body

{
  "slug": "slug",
  "body": "body",
  "anchorKind": "anchorKind",
  "anchorRef": "anchorRef",
  "variant": "variant",
  "replyTo": "replyTo",
  "kind": "kind",
  "audience": "audience",
  "noteId": "noteId",
  "outcome": "outcome"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

save_resolver_spec

POST

/api/v2/io_mapping/save_resolver_spec

Persist the client's working resolver spec — Save Mapping.

save_resolver_spec › Request Body

Request schema for POST /api/v2/io_mapping/save_resolver_spec. Persist the client's working resolver spec — Save Mapping.

request-io_mapping_save_resolver_spec

slug

string · required

The mapping slug.

spec

object

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

baseFingerprint

string

save_resolver_spec › Responses

200

Response schema for POST /api/v2/io_mapping/save_resolver_spec

response-io_mapping_save_resolver_spec

success

boolean · required

Whether the request succeeded

data

object

Persist the client's working resolver spec — Save Mapping.

POST/api/v2/io_mapping/save_resolver_spec

curl --request POST \
  --url /api/v2/io_mapping/save_resolver_spec \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "spec": {},
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "baseFingerprint": "baseFingerprint"
}
'

Example Request Body

{
  "slug": "slug",
  "spec": {},
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "baseFingerprint": "baseFingerprint"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

search_policies

POST

/api/v2/io_mapping/search_policies

Typeahead search for policies of a given policy type, to load a sample revision into...

search_policies › Request Body

Request schema for POST /api/v2/io_mapping/search_policies. Typeahead search for policies of a given policy type, to load a sample revision

request-io_mapping_search_policies

limit

integer

Maximum rows to return.

policyTypeId

string

query

string

search_policies › Responses

200

Response schema for POST /api/v2/io_mapping/search_policies

response-io_mapping_search_policies

success

boolean · required

Whether the request succeeded

data

object

Typeahead search for policies of a given policy type, to load a sample revision

POST/api/v2/io_mapping/search_policies

curl --request POST \
  --url /api/v2/io_mapping/search_policies \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 0,
  "policyTypeId": "policyTypeId",
  "query": "query"
}
'

Example Request Body

{
  "limit": 0,
  "policyTypeId": "policyTypeId",
  "query": "query"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

search_spec

POST

/api/v2/io_mapping/search_spec

Fuzzy search across a spec's named entities.

search_spec › Request Body

Request schema for POST /api/v2/io_mapping/search_spec. Fuzzy search across a spec's named entities.

request-io_mapping_search_spec

limit

integer

Maximum rows to return.

query

string

specId

string

A schema-library spec id. spec_id is accepted as well.

spec_id

string

A schema-library spec id. specId is accepted as well.

search_spec › Responses

200

Response schema for POST /api/v2/io_mapping/search_spec

response-io_mapping_search_spec

success

boolean · required

Whether the request succeeded

data

object

Fuzzy search across a spec's named entities.

POST/api/v2/io_mapping/search_spec

curl --request POST \
  --url /api/v2/io_mapping/search_spec \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 0,
  "query": "query",
  "specId": "specId",
  "spec_id": "spec_id"
}
'

Example Request Body

{
  "limit": 0,
  "query": "query",
  "specId": "specId",
  "spec_id": "spec_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_active_version

POST

/api/v2/io_mapping/set_active_version

set_active_version

set_active_version › Request Body

Request schema for POST /api/v2/io_mapping/set_active_version. IO mapping endpoint set_active_version.

request-io_mapping_set_active_version

slug

string · required

The mapping slug.

versionId

string · required

A stamped version id; defaults to the active version.

set_active_version › Responses

200

Response schema for POST /api/v2/io_mapping/set_active_version

response-io_mapping_set_active_version

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint set_active_version.

POST/api/v2/io_mapping/set_active_version

curl --request POST \
  --url /api/v2/io_mapping/set_active_version \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "versionId": "versionId"
}
'

Example Request Body

{
  "slug": "slug",
  "versionId": "versionId"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_analytics_resolvers

POST

/api/v2/io_mapping/set_analytics_resolvers

BATCH-write ANALYTICS cells -- the dimensions to derive from an inbound submission,...

set_analytics_resolvers › Request Body

Request schema for POST /api/v2/io_mapping/set_analytics_resolvers. BATCH-write ANALYTICS cells -- the dimensions to derive from an inbound

request-io_mapping_set_analytics_resolvers

slug

string · required

The mapping slug.

object[]

Resolver cells to author in this call.

set_analytics_resolvers › Responses

200

Response schema for POST /api/v2/io_mapping/set_analytics_resolvers

response-io_mapping_set_analytics_resolvers

success

boolean · required

Whether the request succeeded

data

object

BATCH-write ANALYTICS cells -- the dimensions to derive from an inbound

POST/api/v2/io_mapping/set_analytics_resolvers

curl --request POST \
  --url /api/v2/io_mapping/set_analytics_resolvers \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "cells": [
    {}
  ]
}
'

Example Request Body

{
  "slug": "slug",
  "cells": [
    {}
  ]
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_declarations

POST

/api/v2/io_mapping/set_declarations

Declare aliases, shared logic and the variant key in ONE transaction, applied in...

set_declarations › Request Body

Request schema for POST /api/v2/io_mapping/set_declarations. Declare aliases, shared logic and the variant key in ONE transaction.

request-io_mapping_set_declarations

slug

string · required

The mapping slug.

aliases

string

derived

string

channels

string

variantKey

string

replace

boolean

recompile

boolean

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

preview

string

set_declarations › Responses

200

Response schema for POST /api/v2/io_mapping/set_declarations

response-io_mapping_set_declarations

success

boolean · required

Whether the request succeeded

data

object

Declare aliases, shared logic and the variant key in ONE transaction.

POST/api/v2/io_mapping/set_declarations

curl --request POST \
  --url /api/v2/io_mapping/set_declarations \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "aliases": "aliases",
  "derived": "derived",
  "channels": "channels",
  "variantKey": "variantKey",
  "replace": true,
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "preview": "preview"
}
'

Example Request Body

{
  "slug": "slug",
  "aliases": "aliases",
  "derived": "derived",
  "channels": "channels",
  "variantKey": "variantKey",
  "replace": true,
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "preview": "preview"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_endpoint_slot_source

POST

/api/v2/io_mapping/set_endpoint_slot_source

Write (or clear, with cell=None) the resolver cell for one slot of a...

set_endpoint_slot_source › Request Body

Request schema for POST /api/v2/io_mapping/set_endpoint_slot_source. Write (or clear, with ``cell=None``) a ROOT resolver cell, addressed by its

request-io_mapping_set_endpoint_slot_source

slug

string · required

The mapping slug.

path

string

cell

object

direction

string

Which side of the mapping to act on: request, response or analytics.

recompile

boolean

set_endpoint_slot_source › Responses

200

Response schema for POST /api/v2/io_mapping/set_endpoint_slot_source

response-io_mapping_set_endpoint_slot_source

success

boolean · required

Whether the request succeeded

data

object

Write (or clear, with cell=None) a ROOT resolver cell, addressed by its

POST/api/v2/io_mapping/set_endpoint_slot_source

curl --request POST \
  --url /api/v2/io_mapping/set_endpoint_slot_source \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "path": "path",
  "cell": {},
  "direction": "direction",
  "recompile": true
}
'

Example Request Body

{
  "slug": "slug",
  "path": "path",
  "cell": {},
  "direction": "direction",
  "recompile": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_item_repeat

POST

/api/v2/io_mapping/set_item_repeat

Make an item emit ONE INSTANCE PER SOURCE ELEMENT, or stop it doing so.

set_item_repeat › Request Body

Request schema for POST /api/v2/io_mapping/set_item_repeat. Make an item emit ONE INSTANCE PER SOURCE ELEMENT, or stop it doing so.

request-io_mapping_set_item_repeat

slug

string · required

The mapping slug.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

item

string

over

string

scope

string · enum

Which layer the write lands on.

Enum values:

base

overlay

distinctBy

string

keepEmpty

string

recompile

boolean

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

set_item_repeat › Responses

200

Response schema for POST /api/v2/io_mapping/set_item_repeat

response-io_mapping_set_item_repeat

success

boolean · required

Whether the request succeeded

data

object

Make an item emit ONE INSTANCE PER SOURCE ELEMENT, or stop it doing so.

POST/api/v2/io_mapping/set_item_repeat

curl --request POST \
  --url /api/v2/io_mapping/set_item_repeat \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "variant": "variant",
  "item": "item",
  "over": "over",
  "scope": "base",
  "distinctBy": "distinctBy",
  "keepEmpty": "keepEmpty",
  "recompile": true,
  "policyType": "policyType",
  "state": "state"
}
'

Example Request Body

{
  "slug": "slug",
  "variant": "variant",
  "item": "item",
  "over": "over",
  "scope": "base",
  "distinctBy": "distinctBy",
  "keepEmpty": "keepEmpty",
  "recompile": true,
  "policyType": "policyType",
  "state": "state"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_lookup_table

POST

/api/v2/io_mapping/set_lookup_table

Create or replace a shared lookup table's map (code→value) and/or default —...

set_lookup_table › Request Body

Request schema for POST /api/v2/io_mapping/set_lookup_table. Create or replace a shared lookup table's ``map`` (code→value) and/or ``default``

request-io_mapping_set_lookup_table

slug

string · required

The mapping slug.

table

string

map

string

default

string

recompile

boolean

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

sourcePath

string

targetItem

string

targetField

string

object[]

Lookup tables to define in this call.

forVariant

string

preview

string

mode

string

standalone

string

set_lookup_table › Responses

200

Response schema for POST /api/v2/io_mapping/set_lookup_table

response-io_mapping_set_lookup_table

success

boolean · required

Whether the request succeeded

data

object

Create or replace a shared lookup table's map (code→value) and/or default

POST/api/v2/io_mapping/set_lookup_table

curl --request POST \
  --url /api/v2/io_mapping/set_lookup_table \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "table": "table",
  "map": "map",
  "default": "default",
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "sourcePath": "sourcePath",
  "targetItem": "targetItem",
  "targetField": "targetField",
  "tables": [
    {}
  ],
  "forVariant": "forVariant",
  "preview": "preview",
  "mode": "mode",
  "standalone": "standalone"
}
'

Example Request Body

{
  "slug": "slug",
  "table": "table",
  "map": "map",
  "default": "default",
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "sourcePath": "sourcePath",
  "targetItem": "targetItem",
  "targetField": "targetField",
  "tables": [
    {}
  ],
  "forVariant": "forVariant",
  "preview": "preview",
  "mode": "mode",
  "standalone": "standalone"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_resolver_construct

POST

/api/v2/io_mapping/set_resolver_construct

Replace one construct section (derived/channels/variantKey) and...

set_resolver_construct › Request Body

Request schema for POST /api/v2/io_mapping/set_resolver_construct. Replace one construct section (``derived``/``channels``/``variantKey``) and

request-io_mapping_set_resolver_construct

slug

string · required

The mapping slug.

section

string

value

string

recompile

boolean

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

merge

boolean

preview

string

set_resolver_construct › Responses

200

Response schema for POST /api/v2/io_mapping/set_resolver_construct

response-io_mapping_set_resolver_construct

success

boolean · required

Whether the request succeeded

data

object

Replace one construct section (derived/channels/variantKey) and

POST/api/v2/io_mapping/set_resolver_construct

curl --request POST \
  --url /api/v2/io_mapping/set_resolver_construct \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "section": "section",
  "value": "value",
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "merge": true,
  "preview": "preview"
}
'

Example Request Body

{
  "slug": "slug",
  "section": "section",
  "value": "value",
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "merge": true,
  "preview": "preview"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_resolver_path

POST

/api/v2/io_mapping/set_resolver_path

Create / rename / update named path aliases, ONE OR MANY.

set_resolver_path › Request Body

Request schema for POST /api/v2/io_mapping/set_resolver_path. Create / rename / update named path aliases, ONE OR MANY.

request-io_mapping_set_resolver_path

slug

string · required

The mapping slug.

name

string

Display name.

path

string

object

Path aliases to write, as {name: path}.

recompile

boolean

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

preview

string

set_resolver_path › Responses

200

Response schema for POST /api/v2/io_mapping/set_resolver_path

response-io_mapping_set_resolver_path

success

boolean · required

Whether the request succeeded

data

object

Create / rename / update named path aliases, ONE OR MANY.

POST/api/v2/io_mapping/set_resolver_path

curl --request POST \
  --url /api/v2/io_mapping/set_resolver_path \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "name": "name",
  "path": "path",
  "paths": {
    "key": "string"
  },
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "preview": "preview"
}
'

Example Request Body

{
  "slug": "slug",
  "name": "name",
  "path": "path",
  "paths": {
    "key": "string"
  },
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "preview": "preview"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_resolver_table

POST

/api/v2/io_mapping/set_resolver_table

Create / replace / delete one entry in the reference-table library...

set_resolver_table › Request Body

Request schema for POST /api/v2/io_mapping/set_resolver_table. Create / replace / delete one entry in the reference-table library

request-io_mapping_set_resolver_table

slug

string · required

The mapping slug.

name

string

Display name.

table

string

delete

boolean

recompile

boolean

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

preview

string

set_resolver_table › Responses

200

Response schema for POST /api/v2/io_mapping/set_resolver_table

response-io_mapping_set_resolver_table

success

boolean · required

Whether the request succeeded

data

object

Create / replace / delete one entry in the reference-table library

POST/api/v2/io_mapping/set_resolver_table

curl --request POST \
  --url /api/v2/io_mapping/set_resolver_table \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "name": "name",
  "table": "table",
  "delete": true,
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "preview": "preview"
}
'

Example Request Body

{
  "slug": "slug",
  "name": "name",
  "table": "table",
  "delete": true,
  "recompile": true,
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "preview": "preview"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_resolvers

POST

/api/v2/io_mapping/set_resolvers

BATCH-write resolver cells -- the copilot's core authoring primitive (the shift away...

set_resolvers › Request Body

Request schema for POST /api/v2/io_mapping/set_resolvers. BATCH-write resolver cells -- the copilot's core authoring primitive (the shift

request-io_mapping_set_resolvers

slug

string · required

The mapping slug.

object[]

Resolver cells to author in this call.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

preview

string

unsourced

object

Slots this document cannot fill, keyed by target with the reason.

object[]

Lookup tables to define in this call.

declarations

object

Tables, variables and variant wiring to declare.

set_resolvers › Responses

200

Response schema for POST /api/v2/io_mapping/set_resolvers

response-io_mapping_set_resolvers

success

boolean · required

Whether the request succeeded

data

object

BATCH-write resolver cells -- the copilot's core authoring primitive (the shift

POST/api/v2/io_mapping/set_resolvers

curl --request POST \
  --url /api/v2/io_mapping/set_resolvers \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "cells": [
    {}
  ],
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "preview": "preview",
  "unsourced": {},
  "tables": [
    {}
  ],
  "declarations": {}
}
'

Example Request Body

{
  "slug": "slug",
  "cells": [
    {}
  ],
  "variant": "variant",
  "policyType": "policyType",
  "state": "state",
  "preview": "preview",
  "unsourced": {},
  "tables": [
    {}
  ],
  "declarations": {}
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_response_resolvers

POST

/api/v2/io_mapping/set_response_resolvers

BATCH-write RESPONSE cells -- the FIELDS dialect, for a response the mapping...

set_response_resolvers › Request Body

Request schema for POST /api/v2/io_mapping/set_response_resolvers. BATCH-write RESPONSE cells -- the FIELDS dialect, for a response the mapping

request-io_mapping_set_response_resolvers

slug

string · required

The mapping slug.

object[]

Resolver cells to author in this call.

replace_dialect

boolean

set_response_resolvers › Responses

200

Response schema for POST /api/v2/io_mapping/set_response_resolvers

response-io_mapping_set_response_resolvers

success

boolean · required

Whether the request succeeded

data

object

BATCH-write RESPONSE cells -- the FIELDS dialect, for a response the mapping

POST/api/v2/io_mapping/set_response_resolvers

curl --request POST \
  --url /api/v2/io_mapping/set_response_resolvers \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "cells": [
    {}
  ],
  "replace_dialect": true
}
'

Example Request Body

{
  "slug": "slug",
  "cells": [
    {}
  ],
  "replace_dialect": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_response_rewrite

POST

/api/v2/io_mapping/set_response_rewrite

Write the RESPONSE REWRITE list -- the dialect for a response that ECHOES the...

set_response_rewrite › Request Body

Request schema for POST /api/v2/io_mapping/set_response_rewrite. Write the RESPONSE REWRITE list -- the dialect for a response that ECHOES the

request-io_mapping_set_response_rewrite

slug

string · required

The mapping slug.

edits

string

replace_dialect

boolean

set_response_rewrite › Responses

200

Response schema for POST /api/v2/io_mapping/set_response_rewrite

response-io_mapping_set_response_rewrite

success

boolean · required

Whether the request succeeded

data

object

Write the RESPONSE REWRITE list -- the dialect for a response that ECHOES the

POST/api/v2/io_mapping/set_response_rewrite

curl --request POST \
  --url /api/v2/io_mapping/set_response_rewrite \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "edits": "edits",
  "replace_dialect": true
}
'

Example Request Body

{
  "slug": "slug",
  "edits": "edits",
  "replace_dialect": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

set_slot_source

POST

/api/v2/io_mapping/set_slot_source

Write (or clear) a resolver cell for one slot of a LAYERED mapping -- the Resolver...

set_slot_source › Request Body

Request schema for POST /api/v2/io_mapping/set_slot_source. Write (or clear) a resolver cell for one slot of a LAYERED mapping -- the

request-io_mapping_set_slot_source

slug

string · required

The mapping slug.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

item

string

field

string

kind

string

The record kind to filter by.

cell

object

scope

string · enum

Which layer the write lands on.

Enum values:

base

overlay

recompile

boolean

policyType

string

The policy type name, e.g. HO-3.

state

string

Two-letter state abbreviation.

set_slot_source › Responses

200

Response schema for POST /api/v2/io_mapping/set_slot_source

response-io_mapping_set_slot_source

success

boolean · required

Whether the request succeeded

data

object

Write (or clear) a resolver cell for one slot of a LAYERED mapping -- the

POST/api/v2/io_mapping/set_slot_source

curl --request POST \
  --url /api/v2/io_mapping/set_slot_source \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "variant": "variant",
  "item": "item",
  "field": "field",
  "kind": "kind",
  "cell": {},
  "scope": "base",
  "recompile": true,
  "policyType": "policyType",
  "state": "state"
}
'

Example Request Body

{
  "slug": "slug",
  "variant": "variant",
  "item": "item",
  "field": "field",
  "kind": "kind",
  "cell": {},
  "scope": "base",
  "recompile": true,
  "policyType": "policyType",
  "state": "state"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

stamp_version

POST

/api/v2/io_mapping/stamp_version

stamp_version

stamp_version › Request Body

Request schema for POST /api/v2/io_mapping/stamp_version. IO mapping endpoint stamp_version.

request-io_mapping_stamp_version

slug

string · required

The mapping slug.

semverTag

string · required

notes

string

setActive

boolean

stamp_version › Responses

200

Response schema for POST /api/v2/io_mapping/stamp_version

response-io_mapping_stamp_version

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint stamp_version.

POST/api/v2/io_mapping/stamp_version

curl --request POST \
  --url /api/v2/io_mapping/stamp_version \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "semverTag": "semverTag",
  "notes": "notes",
  "setActive": true
}
'

Example Request Body

{
  "slug": "slug",
  "semverTag": "semverTag",
  "notes": "notes",
  "setActive": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

start_copilot_job

POST

/api/v2/io_mapping/start_copilot_job

Hand a submitted review to the copilot as a background job.

start_copilot_job › Request Body

Request schema for POST /api/v2/io_mapping/start_copilot_job. Hand a submitted review to the copilot as a background job.

request-io_mapping_start_copilot_job

slug

string · required

The mapping slug.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

prompt

string

fixtureId

string

A fixture id; defaults to the mapping's default fixture.

start_copilot_job › Responses

200

Response schema for POST /api/v2/io_mapping/start_copilot_job

response-io_mapping_start_copilot_job

success

boolean · required

Whether the request succeeded

data

object

Hand a submitted review to the copilot as a background job.

POST/api/v2/io_mapping/start_copilot_job

curl --request POST \
  --url /api/v2/io_mapping/start_copilot_job \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "variant": "variant",
  "prompt": "prompt",
  "fixtureId": "fixtureId"
}
'

Example Request Body

{
  "slug": "slug",
  "variant": "variant",
  "prompt": "prompt",
  "fixtureId": "fixtureId"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

stop_copilot_job

POST

/api/v2/io_mapping/stop_copilot_job

Stop a running copilot job.

stop_copilot_job › Request Body

Request schema for POST /api/v2/io_mapping/stop_copilot_job. Stop a running copilot job.

request-io_mapping_stop_copilot_job

jobId

string · required

stop_copilot_job › Responses

200

Response schema for POST /api/v2/io_mapping/stop_copilot_job

response-io_mapping_stop_copilot_job

success

boolean · required

Whether the request succeeded

data

object

Stop a running copilot job.

POST/api/v2/io_mapping/stop_copilot_job

curl --request POST \
  --url /api/v2/io_mapping/stop_copilot_job \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobId": "jobId"
}
'

Example Request Body

{
  "jobId": "jobId"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

submit_review

POST

/api/v2/io_mapping/submit_review

Send this reviewer's drafts as a batch the copilot is expected to answer.

submit_review › Request Body

Request schema for POST /api/v2/io_mapping/submit_review. Send this reviewer's drafts as a batch the copilot is expected to answer.

request-io_mapping_submit_review

slug

string · required

The mapping slug.

variant

string

The product variant, e.g. an HO-6 overlay. Omit for the base layer.

submit_review › Responses

200

Response schema for POST /api/v2/io_mapping/submit_review

response-io_mapping_submit_review

success

boolean · required

Whether the request succeeded

data

object

Send this reviewer's drafts as a batch the copilot is expected to answer.

POST/api/v2/io_mapping/submit_review

curl --request POST \
  --url /api/v2/io_mapping/submit_review \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "variant": "variant"
}
'

Example Request Body

{
  "slug": "slug",
  "variant": "variant"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

update_fixture

POST

/api/v2/io_mapping/update_fixture

update_fixture

update_fixture › Request Body

Request schema for POST /api/v2/io_mapping/update_fixture. IO mapping endpoint update_fixture.

request-io_mapping_update_fixture

fixtureId

string · required

A fixture id; defaults to the mapping's default fixture.

name

string

Display name.

contentType

string

content

string

The document body.

apiResponseContent

string

isDefault

boolean

update_fixture › Responses

200

Response schema for POST /api/v2/io_mapping/update_fixture

response-io_mapping_update_fixture

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint update_fixture.

POST/api/v2/io_mapping/update_fixture

curl --request POST \
  --url /api/v2/io_mapping/update_fixture \
  --header 'Content-Type: application/json' \
  --data '
{
  "fixtureId": "fixtureId",
  "name": "name",
  "contentType": "contentType",
  "content": "content",
  "apiResponseContent": "apiResponseContent",
  "isDefault": true
}
'

Example Request Body

{
  "fixtureId": "fixtureId",
  "name": "name",
  "contentType": "contentType",
  "content": "content",
  "apiResponseContent": "apiResponseContent",
  "isDefault": true
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

update_mapping_metadata

POST

/api/v2/io_mapping/update_mapping_metadata

update_mapping_metadata

update_mapping_metadata › Request Body

Request schema for POST /api/v2/io_mapping/update_mapping_metadata. IO mapping endpoint update_mapping_metadata.

request-io_mapping_update_mapping_metadata

slug

string · required

The mapping slug.

name

string

Display name.

description

string

Free-text description.

kind

string

The record kind to filter by.

inputFormat

string

outputFormat

string

apiCall

string

inputSchema

string

inputSchemaId

string

analyticsSchemaId

string

analyticsEnabled

boolean

analyticsTemplate

string

redactionRules

object

update_mapping_metadata › Responses

200

Response schema for POST /api/v2/io_mapping/update_mapping_metadata

response-io_mapping_update_mapping_metadata

success

boolean · required

Whether the request succeeded

data

object

IO mapping endpoint update_mapping_metadata.

POST/api/v2/io_mapping/update_mapping_metadata

curl --request POST \
  --url /api/v2/io_mapping/update_mapping_metadata \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "slug",
  "name": "name",
  "description": "description",
  "kind": "kind",
  "inputFormat": "inputFormat",
  "outputFormat": "outputFormat",
  "apiCall": "apiCall",
  "inputSchema": "inputSchema",
  "inputSchemaId": "inputSchemaId",
  "analyticsSchemaId": "analyticsSchemaId",
  "analyticsEnabled": true,
  "analyticsTemplate": "analyticsTemplate",
  "redactionRules": {}
}
'

Example Request Body

{
  "slug": "slug",
  "name": "name",
  "description": "description",
  "kind": "kind",
  "inputFormat": "inputFormat",
  "outputFormat": "outputFormat",
  "apiCall": "apiCall",
  "inputSchema": "inputSchema",
  "inputSchemaId": "inputSchemaId",
  "analyticsSchemaId": "analyticsSchemaId",
  "analyticsEnabled": true,
  "analyticsTemplate": "analyticsTemplate",
  "redactionRules": {}
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

update_memory_summary

POST

/api/v2/io_mapping/update_memory_summary

Body: {mappingId, summary}.

update_memory_summary › Request Body

Request schema for POST /api/v2/io_mapping/update_memory_summary. Body: ``{mappingId, summary}``.

request-io_mapping_update_memory_summary

mappingId

string · required

The mapping id.

summary

string · required

mapping_id

string

update_memory_summary › Responses

200

Response schema for POST /api/v2/io_mapping/update_memory_summary

response-io_mapping_update_memory_summary

success

boolean · required

Whether the request succeeded

data

object

Body: {mappingId, summary}.

POST/api/v2/io_mapping/update_memory_summary

curl --request POST \
  --url /api/v2/io_mapping/update_memory_summary \
  --header 'Content-Type: application/json' \
  --data '
{
  "mappingId": "mappingId",
  "summary": "summary",
  "mapping_id": "mapping_id"
}
'

Example Request Body

{
  "mappingId": "mappingId",
  "summary": "summary",
  "mapping_id": "mapping_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

upload_schema

POST

/api/v2/io_mapping/upload_schema

Create or replace a BYOS schema library row after validating content.

upload_schema › Request Body

Request schema for POST /api/v2/io_mapping/upload_schema. Create or replace a BYOS schema library row after validating content.

request-io_mapping_upload_schema

content

string · required

The document body.

format

string · required

The content format, e.g. jsonschema.

name

string · required

Display name.

description

string

Free-text description.

specId

string

A schema-library spec id. spec_id is accepted as well.

spec_id

string

A schema-library spec id. specId is accepted as well.

upload_schema › Responses

200

Response schema for POST /api/v2/io_mapping/upload_schema

response-io_mapping_upload_schema

success

boolean · required

Whether the request succeeded

data

object

Create or replace a BYOS schema library row after validating content.

POST/api/v2/io_mapping/upload_schema

curl --request POST \
  --url /api/v2/io_mapping/upload_schema \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "content",
  "format": "format",
  "name": "name",
  "description": "description",
  "specId": "specId",
  "spec_id": "spec_id"
}
'

Example Request Body

{
  "content": "content",
  "format": "format",
  "name": "name",
  "description": "description",
  "specId": "specId",
  "spec_id": "spec_id"
}

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

application/json

integrations ivans_dbcs