Pre-release — content may change.

Jobs and imports

Create an import job

POST
/import_jobs

Creates a bulk import job. Attaching a source_document relationship queues the import (or, for V2 imports, validates the file structure); the job then runs asynchronously. Poll the returned resource for status.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/import_jobs" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "import_jobs",      "attributes": {}    }  }'
{  "data": {    "type": "import_jobs",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "attributes": {      "name": "string",      "type": "string",      "state": "string",      "result": "string",      "imported_rows": 0,      "failed_rows": 0,      "dry_run": true,      "queued_at": "2019-08-24T14:15:22Z",      "processing_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "deleted_at": "2019-08-24T14:15:22Z",      "row_count": 0,      "populating_row_count": 0,      "populated_row_count": 0,      "save_mode": "string",      "valid_header_row": true,      "header_row_errors": [        {}      ],      "source_document_size": 0,      "transformed_row_count": 0,      "failed_transformed_row_count": 0,      "successful_transformed_row_count": 0,      "completed_row_count": 0,      "successful_completed_row_count": 0,      "failed_completed_row_count": 0,      "import_options": {},      "navigated_dry_run_intro": true,      "navigated_processing_run_intro": true,      "ui_title_translation_key": "string"    },    "relationships": {      "author": {        "data": {          "type": "people",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"        }      },      "json_schema": {        "data": {          "type": "json_schemas",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"        }      },      "documents": {        "data": [          {            "type": "documents",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          }        ]      }    },    "links": {      "self": "/import_jobs/7247ad7d-9275-454b-9e3a-0570e403739e",      "data_transformation_results_download": {        "href": "https://files.wicketcloud.com/import_jobs/7247ad7d-9275-454b-9e3a-0570e403739e/transformation_results.csv"      },      "results_download": {        "href": "https://files.wicketcloud.com/import_jobs/7247ad7d-9275-454b-9e3a-0570e403739e/results.csv"      },      "template_download": {        "href": "https://files.wicketcloud.com/import_jobs/7247ad7d-9275-454b-9e3a-0570e403739e/template.csv"      }    }  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}