Web Service Method: Export and Store Project Data in Remote Graph Database

Abstract

Description
Export data of a project in RDF format and store in remote graph database.

Note

This service is the equivalent to the PoolParty frontend functionality Export to External Graph Database.

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

Note

This service only works when a remote repository is configured in PoolParty.

Otherwise you will receive the following error message:

{
  "errorMessage": "No connector configured for remote repository - please consult the documentation on how to configure a connector",
  "status": 500
}

Request

Supported Methods
GET

Content-Type

application/json

Path Variables

Variable	Comment
`{project}`	The UUID or the URI supplement (textual identifier) of the project to be used.

HTTP Parameters

Parameter	Type	Required	Description
modules	Array of String	true	A list of the export modules for the data that should be exported - possible values: 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 More details also find here: PoolParty Project Modules
Note To learn more about the syntax to request a list of modules in a single request, please see: Using a List of Request Parameters
remoteServerID	String	false	The IRI (assigned by PoolParty to the remote store) of the remote store to export to. If no value is supplied and there is only one store configured for remote export than the system will export to it, otherwise the IRI has to be specified.

Parameter

Type

Required

Description

modules

Array of String

true

A list of the export modules for the data that should be exported - possible values:

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

More details also find here: PoolParty Project Modules

Note

To learn more about the syntax to request a list of modules in a single request, please see: Using a List of Request Parameters

remoteServerID

String

false

The IRI (assigned by PoolParty to the remote store) of the remote store to export to. If no value is supplied and there is only one store configured for remote export than the system will export to it, otherwise the IRI has to be specified.

Response

Array of graph names of exported data in json format. You can find the project data in these graphs in the remote repository.

Basic Pattern

http://<server-url>/PoolParty/api/projects/<project>/remoteExport?modules=<projectModule>

Examples

Example Request

https://darwin.poolparty.biz/PoolParty/api/projects/1DBCBA6C-483E-0001-EB61-1203ED201214/remoteExport?modules=concepts&modules=history

Example Response

 [
 "http://vocabulary.semantic-web.at/data-science/thesaurus/history",
 "http://vocabulary.semantic-web.at/data-science/thesaurus"
]

In this section: