Start a validated bulk import

POST

/api/imports/{id}/start

curl --request POST \
  --url https://api.getvespy.com/api/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/start \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

202

Default Response

Media typeapplication/json

object

import

required

object

bundleId

required

string format: uuid

nullable

completedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

errorMessage

required

string

nullable

fileName

required

string

>= 1 characters

id

required

string format: uuid

mapping

required

object

key

additional properties

string

organizationId

required

string format: uuid

providerResourceKind

required

string

nullable

requestedByUserId

required

string format: uuid

resourceType

required

string

Allowed values: property unit owner tenant lease vendor charge payment expense expense_payment

sourceFileId

required

string format: uuid

nullable

sourceNamespace

required

string

>= 1 characters <= 80 characters

stage

required

integer

nullable >= 1 <= 6

startedAt

required

string format: date-time

nullable

status

required

string

Allowed values: validating ready queued processing completed completed_with_errors failed

summary

required

object

created

required

integer

duplicatesMerged

required

integer

failedResources

required

integer

failedRows

required

integer

totalResources

required

integer

totalRows

required

integer

unchanged

required

integer

updated

required

integer

validRows

required

integer

Example

{
  "import": {
    "resourceType": "property",
    "status": "validating"
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

503

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}