Skip to main content

Web Service Method: Export a Corpus as a Zip File

Abstract

Web Service Method: Export a Corpus as a Zip File

Description

Exports data from a corpus in RDF format. Returns a ZIP file.

URL: /PoolParty/api/corpusmanagement/{project}/export

Content-Type

application/x-www-form-urlencoded

Supported Methods

GET, POST

HTTP Parameters

Parameter

Description

Type

Required

corpusId

Corpus IDs for which documents have to be retrieved.

String

true

format

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

String

false

exportModules

A list of export modules defining the corpus graphs to be exported.

Allowed values are:

  • Documents

  • ConceptOccurrences

  • FreeTerms

  • CandidateTerms

  • ConceptCooccurrences

Array of Strings

false

Returns

Content-Type: application/json

Status: 200 - OK