Web Service Method: Create Project RDF Data Export Template

Description

Create a template for exporting RDF data.

URL: /PoolParty/api/projects/{project}/template

Request

Supported Methods

POST

Content Type

application/json

Path Variables

Variable

Comment

{project}

The UUID or the URI supplement (textual identifier) of the project to be used.

Request Body

Attribute

Type

Required

Comment

action

String

true

Export destination. Possible values are: IRI of configured remote store in SMC, urn:download, urn:server

compress

boolean

false

Compressed the exported data file

format

String

true

The returned RDF format - possible values are: TriG, TriX, N3, Turtle, N-Triples, RDF/XML, BinaryRDF, N-Quads, JSON-LD, RDF/JSON

graph

String

false

IRI of graph where to export data. Only used when action is remote store

label

String

true

Label of export configuration

modules

Array of String

true

A list of project modules to be exported - possible values are:

  • concepts - includes concept schemes, concepts and collections

  • workflow - workflow status for all concepts

  • history - all history events

  • suggestedConcepts - all suggested concepts

  • void - the project VoiD graph

  • adms - the project ADMS graph

  • candidateConcepts - all candidate concepts

  • lists - used SPARQL list

  • deprecatedConcepts - all deleted concept

  • categories - categories

  • skosnotes - all skosnotes

  • linkedData - exports all the linked data

  • users - exports the local user data

  • schemes - exports schemes and ontologies associated with this project

  • corpora - exports corpora for this project

  • blacklistedTerms - blacklisted terms for project thesaurus

prettyPrint

boolean

false

Pretty prints the exported data

properties

Array of String

false

List of properties to exclude in export

Note

You can use templates created with this call for use with this call: Web Service Method: Export Project Data Based on Template

Example

{
  "prettyPrint" : false,
  "compress" : true,
  "format" : "some format",
  "action" : "some action",
  "label" : "some label",
  "graph" : "some graph",
  "modules" : [ "some modules", "some modules" ],
  "properties" : [ "https://semantic-web.com/api/properties#2317" ]
}

Response

Content Type

text/plain

Status: 200 - Ok