Create Data Ref

POST

/api/canvas/{deal_id}/data-refs

curl --request POST \
  --url https://example.com/api/canvas/example/data-refs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceType": "example", "sourceLabel": "example", "sourceId": "example", "location": "example", "cellRef": "example", "sheetName": "example", "pageNumber": 1, "extractedValue": "example", "displayValue": "example", "confidence": 1, "createdBy": "example" }'

Create a new data reference. Returns the created ref with its generated refId.

Authorizations

• HTTPBearer

Parameters

Path Parameters

deal_id

required

Deal Id

string

Request Body ^required

Media type application/json

CreateDataRefRequest

Request body for creating a new data reference.

object

sourceType

required

Sourcetype

string

sourceLabel

required

Sourcelabel

string

sourceId

Any of:

string

string

null

null

location

Any of:

string

string

null

null

cellRef

Any of:

string

string

null

null

sheetName

Any of:

string

string

null

null

pageNumber

Any of:

integer

integer

null

null

extractedValue

Any of:

string

string

null

null

displayValue

Any of:

string

string

null

null

confidence

Any of:

number

number

null

null

createdBy

Any of:

string

string

null

null

Example ^generated

{
  "sourceType": "example",
  "sourceLabel": "example",
  "sourceId": "example",
  "location": "example",
  "cellRef": "example",
  "sheetName": "example",
  "pageNumber": 1,
  "extractedValue": "example",
  "displayValue": "example",
  "confidence": 1,
  "createdBy": "example"
}

Responses

200

Successful Response

Media type application/json

Response Create Data Ref Api Canvas Deal Id Data Refs Post

object

key

additional properties

any

Example ^generated

{}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}