FitLayout REST API

FitLayout API for artifact creation, storage and manipulation
More information: https://github.com/FitLayout/FitLayout/wiki
Contact Info: burgetr@fit.vut.cz
Version: 1.0.0
BasePath:/fitlayout-web

Access

  1. HTTP Bearer Authentication (JWT)

Methods

[ Jump to Models ]

Table of Contents

Admin

Artifact

Auth

Query

Repository

RepositoryOperator

RepositoryService

RunService

Service

Tags

Admin

Up 
post /api/repository
Creates a new repository. (createRepository)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RepositoryInfo RepositoryInfo (optional)
Body Parameter —

Return type

RepositoryInfo

Example data

Content-Type: application/json
{
  "owner" : "owner",
  "expires" : "2000-01-23",
  "accessedOn" : "2000-01-23",
  "description" : "description",
  "readOnly" : true,
  "id" : "id",
  "version" : "version",
  "createdOn" : "2000-01-23",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The new repository description RepositoryInfo
Up 
delete /api/repository/{repoId}
Deletes a repository identified by its ID. (deleteRepository)

Path parameters

repoId (required)
Path Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Repository deleted ResultValue

400

Invalid parametres ResultErrorMessage

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/repository/{repoId}
Gets information about a repository identified by its ID. (getRepositoryInfo)

Path parameters

repoId (required)
Path Parameter — default: null

Return type

RepositoryInfo

Example data

Content-Type: application/json
{
  "owner" : "owner",
  "expires" : "2000-01-23",
  "accessedOn" : "2000-01-23",
  "description" : "description",
  "readOnly" : true,
  "id" : "id",
  "version" : "version",
  "createdOn" : "2000-01-23",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Selected repository information RepositoryInfo

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/repository/all
Gets a list of all available repositories (admin only). (listAllRepositories)

Return type

array[RepositoryInfo]

Example data

Content-Type: application/json
{
  "owner" : "owner",
  "expires" : "2000-01-23",
  "accessedOn" : "2000-01-23",
  "description" : "description",
  "readOnly" : true,
  "id" : "id",
  "version" : "version",
  "createdOn" : "2000-01-23",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of repository information

403

Not authorized ResultErrorMessage
Up 
get /api/repository
Gets a list of available repositories for current user. (listRepositories)

Return type

array[RepositoryInfo]

Example data

Content-Type: application/json
{
  "owner" : "owner",
  "expires" : "2000-01-23",
  "accessedOn" : "2000-01-23",
  "description" : "description",
  "readOnly" : true,
  "id" : "id",
  "version" : "version",
  "createdOn" : "2000-01-23",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of repository information
Up 
get /api/repository/remind/{email}
Sends an e-mail reminder containing all repositories that have the given e-mail assigned (sendRepositoriesReminder)

Path parameters

email (required)
Path Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

E-mail sent (or nothing set if no repository is assigned to the given e-mail ResultValue
Up 
get /api/repository/status
Gets overall storage status. (status)

Return type

StorageStatus

Example data

Content-Type: application/json
{
  "createAvailable" : true,
  "repositories" : 0,
  "available" : 6,
  "singleMode" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Selected repository information StorageStatus
Up 
put /api/repository/{repoId}
Gets information about a repository identified by its ID. (updateRepositoryInfo)

Path parameters

repoId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

RepositoryInfo RepositoryInfo (optional)
Body Parameter —

Return type

RepositoryInfo

Example data

Content-Type: application/json
{
  "owner" : "owner",
  "expires" : "2000-01-23",
  "accessedOn" : "2000-01-23",
  "description" : "description",
  "readOnly" : true,
  "id" : "id",
  "version" : "version",
  "createdOn" : "2000-01-23",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The updated repository description RepositoryInfo

400

Invalid service parametres ResultErrorMessage

404

Repository with the given ID not found ResultErrorMessage

Artifact

Up 
delete /api/r/{repoId}/artifact/clear
Clears the repository - deletes all artifacts and metadata (clear)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Repository cleared ResultValue

404

Repository with the given ID not found ResultErrorMessage
Up 
post /api/r/{repoId}/artifact/create
Creates a new artifact by invoking a service. (createArtifact)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ServiceParams ServiceParams (optional)
Body Parameter —

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The IRI of the new artifact created ResultValue

400

Invalid service parametres ResultErrorMessage

404

Repository or service with the given ID not found ResultErrorMessage
Up 
delete /api/r/{repoId}/artifact/item/{iri}
Deletes an artifact identified by its IRI (deleteArtifact)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
iri (required)
Path Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Artifact deleted ResultValue

404

Repository or artifact with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/artifact/item/{iri}
Gets a complete artifact including its contents identified by its IRI (getArtifact)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
iri (required)
Path Parameter — default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200-JSONLD

The complete artifact RDF description serialized in JSON-LD

200-TURTLE

The complete artifact RDF description serialized in TURTLE

200-RDFXML

The complete artifact RDF description serialized in RDF/XML

200-NTRIPLES

The complete artifact RDF description serialized in N-TRIPLES

200-NQUADS

The complete artifact RDF description serialized in N-QUADS

200-XML

The complete artifact serialized in XML

200-HTML

The complete artifact serialized in HTML

200-PNG

The complete artifact in a PNG image

400

Invalid IRI provided ResultErrorMessage

404

Repository or service with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/artifact/info/{iri}
Retrieves information about an artifact identified by its IRI (artifact content not included). (getArtifactInfo)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
iri (required)
Path Parameter — default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200-JSONLD

The artifact RDF description serialized in JSON-LD

200-TURTLE

The artifact RDF description serialized in TURTLE

200-RDFXML

The artifact RDF description serialized in RDF/XML

200-NTRIPLES

The artifact RDF description serialized in N-TRIPLES

200-NQUADS

The artifact RDF description serialized in N-QUADS

400

Invalid IRI provided ResultErrorMessage

404

Repository or service with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/artifact
Retrieves information about all artifacts in the repository (artifact contents not included). (getArtifactsInfo)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Query parameters

page (optional)
Query Parameter — default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200-JSONLD

The artifacts RDF description serialized in JSON-LD

200-TURTLE

The artifacts RDF description serialized in TURTLE

200-RDFXML

The artifacts RDF description serialized in RDF/XML

200-NTRIPLES

The artifacts RDF description serialized in N-TRIPLES

200-NQUADS

The artifacts RDF description serialized in N-QUADS

400

Invalid service parametres ResultErrorMessage

404

Repository with the given ID not found or could not be serialized ResultErrorMessage
Up 
get /api/r/{repoId}/artifact/list
Gets a list of artifact IRIs. (listArtifacts)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Query parameters

page (optional)
Query Parameter — default: null

Return type

array[String]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of artifact IRIs

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/artifact/refresh/{iri}
Recomputes the computed artifact properties (refreshArtifact)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
iri (required)
Path Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Artifact recomputed ResultValue

404

Repository or artifact with the given ID not found ResultErrorMessage

Auth

Up 
get /api/auth/userInfo
Get current user information based on the credentials (Bearer JWT token) obtained (getUserInfo)

Return type

UserInfo

Example data

Content-Type: application/json
{
  "expires" : "2000-01-23",
  "roles" : [ "roles", "roles" ],
  "anonymous" : true,
  "guest" : true,
  "userId" : "userId",
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Current user information UserInfo

Query

Up 
post /api/r/{repoId}/query
Adds a saved a query (addQuery)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SavedQueryDTO SavedQueryDTO (optional)
Body Parameter —

Responses

200

Query saved
Up 
delete /api/r/{repoId}/query/{id}
Deletes a saved query (deleteQuery)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
id (required)
Path Parameter — default: null format: int64

Responses

200

Query deleted
Up 
get /api/r/{repoId}/query/{id}
Obtains a saved query (getQuery)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
id (required)
Path Parameter — default: null format: int64

Responses

200

A saved query
Up 
get /api/r/{repoId}/query
Obtains all the saved queries (list)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Responses

200

Saved query list

Repository

Up 
put /api/r/{repoId}/repository/namespaces/{prefix}
Adds a namespace definition for the given prefix (addNamespace)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
prefix (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (optional)
Body Parameter —

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Namespace added ResultValue

404

Repository with the given ID not found ResultErrorMessage
Up 
post /api/r/{repoId}/repository/add
Adds a new quadruple to the repository (addQuadruple)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

QuadrupleData QuadrupleData (optional)
Body Parameter —

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The quadruple added ResultValue

400

Invalid quadruple specification ResultErrorMessage

404

Repository with the given ID not found ResultErrorMessage
Up 
post /api/r/{repoId}/repository/addQuads
Adds a list of new quadruple to the repository (addQuadruples)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

QuadrupleData QuadrupleData (optional)
Body Parameter —

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The quadruples added ResultValue

400

Invalid quadruple specification ResultErrorMessage

404

Repository with the given ID not found ResultErrorMessage
Up 
post /api/r/{repoId}/repository/statements
Imports (adds) statements to the repository (addStatements)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body file (optional)
Body Parameter —

Query parameters

baseURI (optional)
Query Parameter — default: null
context (optional)
Query Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Statements added ResultValue

400

Invalid service parametres ResultErrorMessage

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/checkRepo
Checks the repository whether it exists and is properly initialized (checkRepo)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Repository check result ResultValue

404

Repository with the given ID not found ResultErrorMessage
Up 
delete /api/r/{repoId}/repository/namespaces
Removes all namespace declarations from the repository (clearNamespaces)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Namespaces removed ResultValue

404

Repository with the given ID not found ResultErrorMessage
Up 
delete /api/r/{repoId}/repository/namespaces/{prefix}
Removes a namespace definition for the given prefix (deleteNamespace)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
prefix (required)
Path Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Namespace deleted ResultValue

404

Repository or namespace with the given ID not found ResultErrorMessage
Up 
post /api/r/{repoId}/repository/deleteQuads
Removes a list of quadruples from the repository (deleteQuadruples)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

QuadrupleData QuadrupleData (optional)
Body Parameter —

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Quadruples removed ResultValue

400

Invalid quadruple specification ResultErrorMessage

404

Repository with the given ID not found ResultErrorMessage
Up 
delete /api/r/{repoId}/repository/statements
Deletes statements from the repository (deleteStatements)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Query parameters

context (optional)
Query Parameter — default: null
obj (optional)
Query Parameter — default: null
pred (optional)
Query Parameter — default: null
subj (optional)
Query Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Statements deleted ResultValue

400

Invalid service parametres ResultErrorMessage

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/describe/{iri}
Gets the RDF description for the given subject IRI (describeSubject)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
iri (required)
Path Parameter — default: null

Query parameters

limit (optional)
Query Parameter — default: 2048 format: int32

Return type

SubjectDescriptionResult

Example data

Content-Type: application/json
{
  "description" : {
    "key" : [ {
      "type" : "type",
      "value" : "value"
    }, {
      "type" : "type",
      "value" : "value"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Subject description SubjectDescriptionResult

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/forceInitRepo
Re-initializes an empty repository with the necessary RDF metadata (schemas) (forceInitRepo)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Repository initialized ResultValue

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/contexts
Gets a list of contexts that have been defined for the repository (getContexts)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

SelectQueryResult

Example data

Content-Type: application/json
{
  "head" : {
    "vars" : [ "vars", "vars" ]
  },
  "results" : {
    "bindings" : [ {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    }, {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Context query result SelectQueryResult

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/namespaces/{prefix}
Gets a namespace URI for the given prefix (getNamespace)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
prefix (required)
Path Parameter — default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Namespace URI

404

Repository or namespace with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/namespaces
Gets a list of namespace declarations that have been defined for the repository (getNamespaces)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

SelectQueryResult

Example data

Content-Type: application/json
{
  "head" : {
    "vars" : [ "vars", "vars" ]
  },
  "results" : {
    "bindings" : [ {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    }, {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Namespace query result SelectQueryResult

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/statements
Gets all RDF statements from the repository (getStatements)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Query parameters

context (optional)
Query Parameter — default: null
obj (optional)
Query Parameter — default: null
pred (optional)
Query Parameter — default: null
subj (optional)
Query Parameter — default: null

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200-JSONLD

RDF statements serialized in JSON-LD

200-TURTLE

RDF statements serialized in TURTLE

200-RDFXML

RDF statements serialized in RDF/XML

200-NTRIPLES

RDF statements serialized in N-Triples

200-NQUADS

RDF statements serialized in N-Quads

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/type/{iri}
Gets the assigned rdf:type IRI for the given subject IRI (getSubjectType)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
iri (required)
Path Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Type IRI or 'unknown' ResultValue

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/subject/{subjIri}/{propertyIri}
Gets the property value for the given subject and property IRIs (getSubjectValue)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
propertyIri (required)
Path Parameter — default: null
subjIri (required)
Path Parameter — default: null

Return type

ResultBinding

Example data

Content-Type: application/json
{
  "type" : "type",
  "value" : "value"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Select query result assigning (p)redicate and (v)alue ResultBinding

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/initRepo
Initializes an empty repository with the necessary RDF metadata (schemas) (initRepo)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Repository initialized ResultValue

404

Repository with the given ID not found ResultErrorMessage
Up 
post /api/r/{repoId}/repository/query
Executes any SPARQL query on the underlying RDF repository (query)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (optional)
Body Parameter —

Query parameters

distinct (optional)
Query Parameter — default: false
limit (optional)
Query Parameter — default: 2048 format: int64
offset (optional)
Query Parameter — default: 0 format: int64

Return type

SelectQueryResult

Example data

Content-Type: application/json
{
  "head" : {
    "vars" : [ "vars", "vars" ]
  },
  "results" : {
    "bindings" : [ {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    }, {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

SELECT query result (tuple query) SelectQueryResult

200-JSONLD

CONSTRUCT query result (graph query) serialized in JSON-LD

200-TURTLE

CONSTRUCT query result (graph query) serialized in TURTLE

200-RDFXML

CONSTRUCT query result (graph query) serialized in RDF/XML

200-NTRIPLES

CONSTRUCT query result (graph query) serialized in N-TRIPLES

200-NQUADS

CONSTRUCT query result (graph query) serialized in N-QUADS

200-JSON

ASK query result (boolean query) serialized in JSON

200-TEXT

ASK query result (boolean query) serialized in text

404

Repository with the given ID not found ResultErrorMessage

500

Query evaluation error ResultErrorMessage
Up 
get /api/r/{repoId}/repository/object/{iri}
Gets all triples for the given object IRI (queryObject)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
iri (required)
Path Parameter — default: null

Query parameters

limit (optional)
Query Parameter — default: 2048 format: int32

Return type

SelectQueryResult

Example data

Content-Type: application/json
{
  "head" : {
    "vars" : [ "vars", "vars" ]
  },
  "results" : {
    "bindings" : [ {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    }, {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Select query result assigning (v)alue and (p)redicate SelectQueryResult

404

Repository with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/repository/subject/{iri}
Gets all triples for the given subject IRI (querySubject)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null
iri (required)
Path Parameter — default: null

Query parameters

limit (optional)
Query Parameter — default: 2048 format: int32

Return type

SelectQueryResult

Example data

Content-Type: application/json
{
  "head" : {
    "vars" : [ "vars", "vars" ]
  },
  "results" : {
    "bindings" : [ {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    }, {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Select query result assigning (p)redicate and (v)alue SelectQueryResult

404

Repository with the given ID not found ResultErrorMessage
Up 
put /api/r/{repoId}/repository/statements
Replaces all statements in the repository (replaceStatements)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body file (optional)
Body Parameter —

Query parameters

baseURI (optional)
Query Parameter — default: null
context (optional)
Query Parameter — default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Statements replaced ResultValue

400

Invalid service parametres ResultErrorMessage

404

Repository with the given ID not found ResultErrorMessage
Up 
post /api/r/{repoId}/repository/selectQuery
Executes a SPARQL SELECT query on the underlying RDF repository (selectQuery)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (optional)
Body Parameter —

Query parameters

distinct (optional)
Query Parameter — default: false
limit (optional)
Query Parameter — default: 2048 format: int64
offset (optional)
Query Parameter — default: 0 format: int64

Return type

SelectQueryResult

Example data

Content-Type: application/json
{
  "head" : {
    "vars" : [ "vars", "vars" ]
  },
  "results" : {
    "bindings" : [ {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    }, {
      "key" : {
        "type" : "type",
        "value" : "value"
      }
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

SPARQL select query result (bindings) SelectQueryResult

404

Repository with the given ID not found ResultErrorMessage

500

Query evaluation error ResultErrorMessage
Up 
get /api/r/{repoId}/repository/touch
Updates the last access time of the given repository to current time (touch)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Repository touched ResultValue
Up 
post /api/r/{repoId}/repository/updateQuery
Executes a SPARQL UPDATE query on the underlying RDF repository (updateQuery)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (optional)
Body Parameter —

Return type

ResultValue

Example data

Content-Type: application/json
{
  "result" : "{}",
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Update performed ResultValue

404

Repository with the given ID not found ResultErrorMessage

500

Query evaluation error ResultErrorMessage

RepositoryOperator

Up 
get /api/r/{repoId}/operator
Gets a list of available area tree operator services for the repository. (repositoryListOperators)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

array[ParametrizedServiceDescr]

Example data

Content-Type: application/json
{
  "name" : "name",
  "produces" : "produces",
  "description" : "description",
  "id" : "id",
  "category" : "category",
  "params" : {
    "key" : {
      "name" : "name",
      "description" : "description",
      "type" : "type"
    }
  },
  "consumes" : "consumes"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of service descriptions

404

Repository with the given ID not found ResultErrorMessage

RepositoryService

Up 
get /api/r/{repoId}/service/config
Gets the default configuration of an artifact service. (getRepoServiceConfig)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Query parameters

id (optional)
Query Parameter — default: null

Return type

ServiceParams

Example data

Content-Type: application/json
{
  "parentIri" : "parentIri",
  "serviceId" : "serviceId",
  "params" : {
    "key" : ""
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service configuration ServiceParams

404

Repository or service with the given ID not found ResultErrorMessage
Up 
get /api/r/{repoId}/service
Gets a list of available artifact services for the repository. (repositoryGetServiceList)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

array[ArtifactServiceDescr]

Example data

Content-Type: application/json
{
  "name" : "name",
  "produces" : "produces",
  "description" : "description",
  "id" : "id",
  "category" : "category",
  "params" : {
    "key" : {
      "name" : "name",
      "description" : "description",
      "type" : "type"
    }
  },
  "consumes" : "consumes"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of service descriptions

404

Repository with the given ID not found ResultErrorMessage
Up 
post /api/r/{repoId}/service
Invokes a service and returns the resulting artifact (repositoryInvoke)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ServiceParams ServiceParams (optional)
Body Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The complete artifact data

404

Repository or service with the given ID not found ResultErrorMessage

RunService

Up 
post /api/r/{repoId}/run/renderJson
Creates a new Page artifact from a JSON page description (e.g. obtained from a puppeteer backend or a client browser extension). (renderJsonPage)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body file (optional)
Body Parameter —

Responses

200

OK

Service

Up 
get /api/service/config
Gets the default configuration of an artifact service. (getServiceConfig)

Query parameters

id (optional)
Query Parameter — default: null

Return type

ServiceParams

Example data

Content-Type: application/json
{
  "parentIri" : "parentIri",
  "serviceId" : "serviceId",
  "params" : {
    "key" : ""
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Service configuration ServiceParams
Up 
get /api/service
Gets a list of available artifact services. (getServiceList)

Return type

array[ArtifactServiceDescr]

Example data

Content-Type: application/json
{
  "name" : "name",
  "produces" : "produces",
  "description" : "description",
  "id" : "id",
  "category" : "category",
  "params" : {
    "key" : {
      "name" : "name",
      "description" : "description",
      "type" : "type"
    }
  },
  "consumes" : "consumes"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of service descriptions
Up 
post /api/service
Invokes a service and returns the resulting artifact (invoke)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ServiceParams ServiceParams (optional)
Body Parameter —

Responses

200

The complete artifact data
Up 
get /api/operator
Gets a list of available area tree operator services. (listOperators)

Return type

array[ParametrizedServiceDescr]

Example data

Content-Type: application/json
{
  "name" : "name",
  "produces" : "produces",
  "description" : "description",
  "id" : "id",
  "category" : "category",
  "params" : {
    "key" : {
      "name" : "name",
      "description" : "description",
      "type" : "type"
    }
  },
  "consumes" : "consumes"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of service descriptions
Up 
get /api/service/ping
Returns 'ok'. (ping)

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

Tags

Up 
get /api/r/{repoId}/tags
Reads a list of tags defined in the repository (getTags)

Path parameters

repoId (required)
Path Parameter — The ID of the artifact repository to use default: null

Return type

TagInfo

Example data

Content-Type: application/json
{
  "iri" : "iri",
  "name" : "name",
  "context" : "context",
  "type" : "type"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The list of tags TagInfo

404

Repository with the given ID not found ResultErrorMessage

Models

[ Jump to Methods ]

Table of Contents

  1. ArtifactServiceDescr -
  2. ParamBooleanDescr -
  3. ParamDescr -
  4. ParamFloatDescr -
  5. ParamIntDescr -
  6. ParamStringDescr -
  7. ParametrizedServiceDescr -
  8. QuadrupleData -
  9. RepositoryInfo -
  10. ResultBinding -
  11. ResultBody -
  12. ResultErrorMessage -
  13. ResultHeader -
  14. ResultValue -
  15. SavedQueryDTO -
  16. SelectQueryResult -
  17. ServiceParams -
  18. StorageStatus -
  19. SubjectDescriptionResult -
  20. TagInfo -
  21. UserInfo -

ArtifactServiceDescr - Up

id
String Service ID
name
String Service name
description
String Service description
category (optional)
String Service category used for grouping services
params (optional)
map[String, ParamDescr] Descriptions of accepted parameters
consumes (optional)
String
produces (optional)
String

ParamBooleanDescr - Up

name
String Name of the parameter
description (optional)
String Text description of the parameter
type
String Type of the parameter {bolean, int, float, string}

ParamDescr - Up

Service parameter description
name
String Name of the parameter
description (optional)
String Text description of the parameter
type
String Type of the parameter {bolean, int, float, string}

ParamFloatDescr - Up

name
String Name of the parameter
description (optional)
String Text description of the parameter
type
String Type of the parameter {bolean, int, float, string}
minValue (optional)
Float format: float
maxValue (optional)
Float format: float

ParamIntDescr - Up

name
String Name of the parameter
description (optional)
String Text description of the parameter
type
String Type of the parameter {bolean, int, float, string}
minValue (optional)
Integer format: int32
maxValue (optional)
Integer format: int32

ParamStringDescr - Up

name
String Name of the parameter
description (optional)
String Text description of the parameter
type
String Type of the parameter {bolean, int, float, string}
minLength (optional)
Integer format: int32
maxLength (optional)
Integer format: int32

ParametrizedServiceDescr - Up

Description of a parametrized service
id
String Service ID
name
String Service name
description
String Service description
consumes (optional)
String Type IRI of the input artifacts
produces
String Type IRI of the produced artifacts
category (optional)
String Service category used for grouping services
params (optional)
map[String, ParamDescr] Descriptions of accepted parameters

QuadrupleData - Up

RDF quadruple data
s (optional)
String
p (optional)
String
o (optional)
String
value (optional)
Object
artifact (optional)
String
ok (optional)
Boolean

RepositoryInfo - Up

Information about an artifact repository
id
String Repository ID
description (optional)
String Repository description
version (optional)
String Metadata schema version
email (optional)
String Creator's e-mail
owner
String Owner ID
createdOn (optional)
date Creation date format: date
accessedOn (optional)
date Last access date format: date
expires (optional)
date Expiration date format: date
readOnly (optional)
Boolean Read only flag

ResultBinding - Up

Assigned result value
type (optional)
String Value type {iri, literal}
value (optional)
String The value

ResultBody - Up

Query result body (bindings)
bindings (optional)
array[map[String, ResultBinding]]

ResultErrorMessage - Up

Error result of an operation
status (optional)
String
message (optional)
String

ResultHeader - Up

Query result header (column names)
vars (optional)
array[String]

ResultValue - Up

Result of an operation conaining an optional result value
status (optional)
String
result (optional)
Object

SavedQueryDTO - Up

id (optional)
Long format: int64
title (optional)
String
queryString (optional)
String

SelectQueryResult - Up

A result of a SPARQL SELECT query
head (optional)
ResultHeader
results (optional)
ResultBody

ServiceParams - Up

Service input parametres
serviceId
String ID of the service to invoke
parentIri (optional)
String IRI of the input artifact if required by the given service
params (optional)
map[String, oas_any_type_not_mapped] Service invocation parametres

StorageStatus - Up

Overall storage status
singleMode (optional)
Boolean
createAvailable (optional)
Boolean
repositories (optional)
Integer format: int32
available (optional)
Integer format: int32

SubjectDescriptionResult - Up

Represents the subject descripton as map of properties.
description (optional)
map[String, array[ResultBinding]]

TagInfo - Up

Tag information
iri (optional)
String
type (optional)
String
name (optional)
String
context (optional)
String

UserInfo - Up

Current user information
userId (optional)
String
email (optional)
String
anonymous (optional)
Boolean
guest (optional)
Boolean
expires (optional)
date format: date
roles (optional)
set[String]