Import object data

Imports object records for the provided handle, optionally using upsert matching.

POST/api/unstable/objects/by-handle/{handle}/import

Imports object records for the provided handle, optionally using upsert matching.

Request Body

application/json

rows*array<>

Input rows to import.

Example

[
  {
    "name": "Airport Expansion",
    "status": "Qualified"
  }
]

upsert?boolean

Whether to update existing records when a match is found.

Exampletrue

referenceField?string

Field used to match existing records during upsert.

Example"externalId"

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/unstable/objects/by-handle/{handle}/import" \  -H "Content-Type: application/json" \  -d '{    "rows": [      {        "name": "Airport Expansion",        "status": "Qualified"      }    ]  }'

{
  "processed": 100,
  "created": 80,
  "updated": 20
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Import object data

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`