WossiDiA-PowerGraph - REST-API


Version 0.3.07 (2023-01-28 12:41)


Returns Path Description Path Parameters Request Parameters
text/html / Prints an overview of the API functions.
application/json /catalog Returns the entire WossiDiA-PowerGraph catalog. types
sup
inf
exp
inheritedAttrs
inheritedRoles
application/json /catalog/datatypes Returns all WossiDiA-PowerGraph data types.
application/json /catalog/datatype/{dataType} Returns a specific data type. dataType
application/json /catalog/nodetypes Returns all WossiDiA-PowerGraph node types. sup
inf
inheritedAttrs
application/json /catalog/nodetype/{nodeType} Returns the specified WossiDiA-PowerGraph node type. nodeType sup
inf
inheritedAttrs
application/json /catalog/edgetypes Returns all WossiDiA-PowerGraph edge types. sup
inf
exp
inheritedAttrs
inheritedRoles
application/json /catalog/edgetype/{edgeType} Returns the specified WossiDiA-PowerGraph edge type. edgeType sup
inf
exp
inheritedAttrs
inheritedRoles
application/json /nodes/{type} Obtains all nodes of the specified type. type
application/json /nodes/{type}/{cond} Obtains nodes of the specified type with the specified condition. type
cond
application/json /node/{id} Obtains the node with the specified PowerGraph ID. id
application/json /node/{type}/{id} Obtains the node with the specified type and internal ID. type
id
application/json /edges/{type} Obtains all edges of the specified type. type
application/json /edges/{type}/{cond} Obtains edges of the specified type with the specified condition. type
cond
application/json /edge/{id} Obtains the edge with the specified ID. id
application/json /graph/{pnid}/{path} Obtains a graph, starting from a single pivot node, expanding using a path expression. pnid
path
nodeAttrs
edgeAttrs
linkAttrs
graphStats
fullEdges
application/json /isebel/index/{expr} ISEBEL index access for story faceted search requests, returning IDs (and index data) for stories matching the search criteria and facets specified. expr word
place
person
gender
yearMin
yearMax
inclNoYear
data
limit
application/xml /isebel/story/{id} ISEBEL record document access for story faceted search results, returning XML data for the story specified. id
application/json /audio/upload Story audio transcript upload. storyId
langCode
audioData

Prints an overview of the API functions.

Returned document type:
text/html

Returns the entire WossiDiA-PowerGraph catalog.

Request parameters:
  • boolean types (not required, default: false )
    Include data types.
  • String sup (not required, default: id )
    Node/edge type expansion on the superior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • String inf (not required, default: id )
    Node/edge type expansion on the inferior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • String exp (not required, default: id )
    Role node types expansion.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • boolean inheritedAttrs (not required, default: true )
    Include inherited attributes.
  • boolean inheritedRoles (not required, default: true )
    Include inherited roles.
Returned document type:
application/json

Returns all WossiDiA-PowerGraph data types.

Returned document type:
application/json

/catalog/datatype/{dataType}

Returns a specific data type.

Path parameters:
  • String dataType (required)
    Data type name.
Returned document type:
application/json

Returns all WossiDiA-PowerGraph node types.

Request parameters:
  • String sup (not required, default: id )
    Node type expansion on the superior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • String inf (not required, default: id )
    Node type expansion on the inferior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • boolean inheritedAttrs (not required, default: true )
    Include inherited node attributes.
Returned document type:
application/json

/catalog/nodetype/{nodeType}

Returns the specified WossiDiA-PowerGraph node type.

Path parameters:
  • String nodeType (required)
    Node type ID or name.
Request parameters:
  • String sup (not required, default: id )
    Node type expansion on the superior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • String inf (not required, default: id )
    Node type expansion on the inferior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • boolean inheritedAttrs (not required, default: true )
    Include inherited node attributes.
Returned document type:
application/json

Returns all WossiDiA-PowerGraph edge types.

Request parameters:
  • String sup (not required, default: id )
    Edge type expansion on the superior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • String inf (not required, default: id )
    Edge type expansion on the inferior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • String exp (not required, default: id )
    Role node types expansion.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • boolean inheritedAttrs (not required, default: true )
    Include inherited edge attributes.
  • boolean inheritedRoles (not required, default: true )
    Include inherited roles.
Returned document type:
application/json

/catalog/edgetype/{edgeType}

Returns the specified WossiDiA-PowerGraph edge type.

Path parameters:
  • String edgeType (required)
    Edge type ID or name.
Request parameters:
  • String sup (not required, default: id )
    Edge type expansion on the superior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • String inf (not required, default: id )
    Edge type expansion on the inferior axis.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • String exp (not required, default: id )
    Role node types expansion.
    ID Include ID(s) and name(s) of referenced types only (default).
    FULL Include full information for referenced types.
    TREE Include full information for the whole tree of referenced types.
  • boolean inheritedAttrs (not required, default: true )
    Include inherited edge attributes.
  • boolean inheritedRoles (not required, default: true )
    Include inherited roles.
Returned document type:
application/json

/nodes/{type}

Obtains all nodes of the specified type.

Path parameters:
  • String type (required)
    Node type ID or name.
Returned document type:
application/json

/nodes/{type}/{cond}

Obtains nodes of the specified type with the specified condition.

Path parameters:
  • String type (required)
    Node type ID or name.
  • String cond (required)
    Selection condition for nodes, based on their attributes, IDs, and properties; for syntax see {@link Condition}.
Returned document type:
application/json

/node/{id}

Obtains the node with the specified PowerGraph ID.

Path parameters:
  • String id (required)
    Node ID.
Returned document type:
application/json

/node/{type}/{id}

Obtains the node with the specified type and internal ID.

Path parameters:
  • String type (required)
    Node type ID or name.
  • String id (required)
    Internal node ID.
Returned document type:
application/json

/edges/{type}

Obtains all edges of the specified type.

Path parameters:
  • String type (required)
    Edge type ID or name.
Returned document type:
application/json

/edges/{type}/{cond}

Obtains edges of the specified type with the specified condition.

Path parameters:
  • String type (required)
    Edge type ID or name.
  • String cond (required)
    Selection condition for edges, based on their attributes, IDs, and properties; for syntax see {@link Condition}.
Returned document type:
application/json

/edge/{id}

Obtains the edge with the specified ID.

Path parameters:
  • String id (required)
    Edge ID.
Returned document type:
application/json

/graph/{pnid}/{path}

Obtains a graph, starting from a single pivot node, expanding using a path expression.

Path parameters:
  • String pnid (required)
    Pivot node ID.
  • String path (required)
    Graph-building path expression.
Request parameters:
  • String nodeAttrs (not required, default: true )
    Include node attributes.
  • String edgeAttrs (not required, default: true )
    Include edge attributes.
  • String linkAttrs (not required, default: true )
    Include link attributes.
  • String graphStats (not required, default: false )
    Include graph statistics.
  • String fullEdges (not required, default: true )
    Include all nodes in the edges, even those not affected by the edges.
Returned document type:
application/json

/isebel/index/{expr}

ISEBEL index access for story faceted search requests, returning IDs (and index data) for stories matching the search criteria and facets specified.

Path parameters:
  • String expr (required)
    Search expression, separated by space.
Request parameters:
  • String word (not required)
    Filter: Keywords, separated by space.
  • String place (not required)
    Filter: Place names, separated by space.
  • String person (not required)
    Filter: Person names, separated by space.
  • String gender (not required)
    Filter: Genders specified, 'm', 'f', any spaces.
  • String yearMin (not required)
    Filter: Earliest year.
  • String yearMax (not required)
    Filter: Latest year.
  • String inclNoYear (not required, default: true )
    Filter: Include stories with no year specified (boolean).
  • String data (not required, default: false )
    Return index data along with story IDs (boolean).
  • String limit (not required)
    Result set limit.
Returned document type:
application/json

/isebel/story/{id}

ISEBEL record document access for story faceted search results, returning XML data for the story specified.

Path parameters:
  • String id (required)
    ID or type-internal ID of story (int).
Returned document type:
application/xml

Story audio transcript upload.

Request parameters:
  • String storyId (required)
    Story ID (int).
  • String langCode (required)
    Audio language: 'deu', 'nds', 'eng', etc.
  • String audioData (required)
    Audio data (Base64).
Returned document type:
application/json