Web Service Method: Request Existing Project RDF Data Export Templates

Description

Request a list of existing templates in a project for exporting RDF data.

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

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

sortKey

String

false

Property templates will be sorted by.

Possible values are: label, action, format, last_used.

Default value: label

sortDirection

String

false

Sort direction. ASC Or DESC.

Default value: DESC

limit

int

false

Number of templates to query.

Default value: 10

offset

int

false

Offset of templates.

Default value: 0

Response

Content Type

application/json

Attribute

Type

Required

Comment

action

String

false

Action of template

available

boolean

false

Flag indicating if template is available to use or not. For example in case of remote store action, if remote store is not online or configured correctly template will not be available

compress

boolean

false

Flag indicating if export is compressed or not

createdDate

String

false

Created date of template

format

String

false

Format of template

graph

String

false

IRI of remote store graph

label

String

false

Label of template

lastUsed

String

false

Last used date of template

modules

Array of String

false

Selected modules of template

prettyPrint

boolean

false

Flag indicating if export pretty prints the data or not

properties

Array of String

false

Excluded properties of template

uri

String

false

IRI of template

user

String

false

IRI of user that created the template

Note

You can use templates in the result list with this call: Web Service Method: Export Project Data Based on Template

Example

{
  "prettyPrint" : true,
  "compress" : false,
  "available" : false,
  "format" : "some format",
  "label" : "some label",
  "uri" : "https://semantic-web.com/api/uri#20957",
  "graph" : "some graph",
  "modules" : [ "some modules" ],
  "lastUsed" : "some lastUsed",
  "createdDate" : "some createdDate",
  "action" : "some action",
  "user" : "some user",
  "properties" : [ "https://semantic-web.com/api/properties#9670" ]
}