API docs by Redocly

Linked Data Import API (v1)

Linked Data Import API

upload

uploadFile

Uploads a local file into tenant-specific folder in configured S3 bucket

Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

import, start

startImport

Starts the process of Linked Data Import and returns ID of Import Job Instance

query Parameters
fileName
required
string

The name of a file to be imported from S3. Should be located in Tenant's folder

contentType
string

Content type of the file to be imported (e.g., application/ld+json, text/turtle). JSON by default.

defaultWorkType
string (defaultWorkType)
Enum: "MONOGRAPH" "SERIAL"

Default Work extra type - MONOGRAPH or SERIAL

Responses

import, job

getJobInfo

Returns information about Import Job by ID

path Parameters
jobExecutionId
required
integer <int64>

The ID of the Import Job Execution

Responses

Response samples

Content type
application/json
{
  • "startDate": "string",
  • "endDate": "string",
  • "startedBy": "string",
  • "status": "string",
  • "fileName": "string",
  • "latestStep": "string",
  • "linesRead": 0,
  • "linesMapped": 0,
  • "linesFailedMapping": 0,
  • "linesCreated": 0,
  • "linesUpdated": 0,
  • "linesFailedSaving": 0,
  • "savingComplete": true
}

getFailedLines

Downloads CSV file with failed RDF lines for the specified job

path Parameters
jobExecutionId
required
integer <int64>

The ID of the Import Job Execution

Responses

stopJob

Stops running Import Job by execution ID

path Parameters
jobExecutionId
required
integer <int64>

The ID of the Import Job Execution

Responses