Linked Data API (v1)

Linked Data service API

reindex

reindex

Start the process of reindexing of resources in the database

query Parameters
full
boolean

Reindex all records if true, otherwise only not indexed

Responses

Response samples

Content type
application/json
"examples/validationErrorResponse.sample"

resource

createResource

Create a Resource

Request Body schema: application/json
id
integer <int64>

ID of the resource

InstanceField (object) or WorkField (object) (resourceRequestField)

Resource request. Contains either an Instance or a Work request.

One of
object (InstanceRequest)

Instance request DTO

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "resource": {
    }
}

Response samples

Content type
application/json
{
  • "resource": {
    }
}

getResourceById

Get a resource by id

path Parameters
id
required
integer <int64>

Linked Data resource id

Responses

Response samples

Content type
application/json
{
  • "resource": {
    }
}

updateResource

Update a resource by id

path Parameters
id
required
integer <int64>

Linked Data resource id

Request Body schema: application/json
id
integer <int64>

ID of the resource

InstanceField (object) or WorkField (object) (resourceRequestField)

Resource request. Contains either an Instance or a Work request.

One of
object (InstanceRequest)

Instance request DTO

Responses

Request samples

Content type
application/json
"example/resourceRequest.sample"

Response samples

Content type
application/json
{
  • "resource": {
    }
}

deleteResource

Delete a resource by id

path Parameters
id
required
integer <int64>

Linked Data resource id

Responses

Response samples

Content type
application/json
"example/unknownError.sample"

getResourceMarcViewById

Get a marc view of resource by id

path Parameters
id
required
integer <int64>

Linked Data resource id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "recordType": "string",
  • "parsedRecord": {
    }
}

exportInstanceToRdf

Export Instance resource to RDF by id

path Parameters
id
required
integer <int64>

Linked Data resource id

Responses

Response samples

Content type
application/json
"string"

getResourceIdByResourceInventoryId

Get id of a resource by its inventory id

path Parameters
inventoryId
required
string

Inventory ID (999 $i) of the MARC record in SRS

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

checkMarcBibImportableToGraph

Check if marc bibliographic record can be imported into linked data graph.

path Parameters
inventoryId
required
string

Inventory ID (999 $i) of the MARC record in SRS

Responses

Response samples

Content type
application/json
"example/unknownError.sample"

getResourcePreviewByInventoryId

Get the preview of a resource

path Parameters
inventoryId
required
string

Inventory ID (999 $i) of the MARC record in SRS

Responses

Response samples

Content type
application/json
{
  • "resource": {
    }
}

importMarcRecord

Create a Resource derived from MARC record

path Parameters
inventoryId
required
string

Inventory ID (999 $i) of the MARC record in SRS

query Parameters
profileId
integer <int16>

ID of the profile

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

profile

getProfileById

Get a profile by profileId

path Parameters
profileId
required
integer <int16>

ID of the profile

Responses

Response samples

Content type
application/json
"example/unknownError.sample"

getProfileMetadataByResourceType

Get profiles metadata for a resource type

query Parameters
resourceType
required
string

The type of resource for which metadata are requested

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getPreferredProfileByResourceType

Get the preferred profile for a resource type for the current user

query Parameters
resourceType
string

The type of resource for which preferred profile is requested. If not specified, profiles for all resource types will be returned

Responses

Response samples

Content type
application/json
[
  • {
    }
]

setPreferredProfile

Create or update the preferred profile for a resource type for the current user

Request Body schema: application/json
id
required
integer <int16>

ID of the profile

resourceType
required
string

Type of the resource to which the profile applies

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "resourceType": "string"
}

Response samples

Content type
application/json
"examples/validationErrorResponse.sample"

deletePreferredProfile

Delete preferred profile for current user

query Parameters
resourceType
required
string

The type of resource for which preferred profile has to be deleted.

Responses

Response samples

Content type
application/json
"examples/validationErrorResponse.sample"

graph

getResourceGraphById

Get a resource graph by id

path Parameters
id
required
integer <int64>

Linked Data resource id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "types": [
    ],
  • "doc": { },
  • "label": "string",
  • "outgoingEdges": {
    },
  • "incomingEdges": {
    },
  • "indexDate": "string"
}

authority

authority-assignment-check

Checks if authority can be assigned to work

Request Body schema: application/json
rawMarc
required
string

Raw MARC json

target
required
string
Enum: "CREATOR_OF_WORK" "SUBJECT_OF_WORK"

Target type

Responses

Request samples

Content type
application/json
{
  • "rawMarc": "string",
  • "target": "CREATOR_OF_WORK"
}

Response samples

Content type
application/json
{
  • "validAssignment": true,
  • "invalidAssignmentReason": "UNSUPPORTED_MARC"
}

import

import-file

Imports an uploaded JSON file containing at least one resource

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

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "log": "string"
}