WossiDiA-PowerGraph - API

Prints an overview of all API functions.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Returned document content type:

text/html

Returns the entire WossiDiA-PowerGraph catalog.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• Boolean types (optional, default: false)
  Include data types.
• String sup (optional, 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 (optional, 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 (optional, 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 (optional, default: true)
  Include inherited attributes.
• Boolean inheritedRoles (optional, default: true)
  Include inherited roles.

Returned document content type:

application/json

Returns all WossiDiA-PowerGraph datatypes.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Returned document content type:

application/json

Returns a specific datatype.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String dataType (required)
  Data type name.

Returned document content type:

application/json

Returns all WossiDiA-PowerGraph node types.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String sup (optional, 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 (optional, 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 (optional, default: true)
  Include inherited node attributes.

Returned document content type:

application/json

Returns the specified WossiDiA-PowerGraph node type.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String nodeType (required)
  Node type ID or name.

Request parameters:

• String sup (optional, 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 (optional, 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 (optional, default: true)
  Include inherited node attributes.

Returned document content type:

application/json

Returns all WossiDiA-PowerGraph edge types.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String sup (optional, 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 (optional, 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 (optional, 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 (optional, default: true)
  Include inherited edge attributes.
• Boolean inheritedRoles (optional, default: true)
  Include inherited roles.

Returned document content type:

application/json

Returns the specified WossiDiA-PowerGraph edge type.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String edgeType (required)
  Edge type ID or name.

Request parameters:

• String sup (optional, 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 (optional, 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 (optional, 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 (optional, default: true)
  Include inherited edge attributes.
• Boolean inheritedRoles (optional, default: true)
  Include inherited roles.

Returned document content type:

application/json

Obtains all nodes of the specified type.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Node type ID or name.

Returned document content type:

application/json

Obtains nodes of the specified type with the specified condition.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• 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 content type:

application/json

Obtains the node with the specified PowerGraph ID.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• Integer id (required)
  Node ID.

Request parameters:

• String format (optional, default: json)
  Node attribute output format: "json", "text".

Returned document content type:

application/json

Obtains the node with the specified type and internal ID.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Node type ID or name.
• Integer id (required)
  Internal node ID.

Request parameters:

• String format (optional, default: json)
  Node attribute output format: "json", "text".

Returned document content type:

application/json

Obtains the node with the specified WossiDiA signature.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String sig (required)
  Node signature.

Request parameters:

• String format (optional, default: json)
  Node attribute output format: "json", "text".

Returned document content type:

application/json

Obtains all edges of the specified type.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String type (required)
  Edge type ID or name.

Request parameters:

• Boolean edgeAttrs (optional, default: true)
  Include edge attributes.
• Boolean edgeLinks (optional, default: true)
  Include edge links.
• Boolean linkAttrs (optional, default: true)
  Include link attributes.
• Boolean nodeAttrs (optional, default: false)
  Include linked nodes' attributes.
• Boolean nodeSigs (optional, default: false)
  Include linked nodes' signatures.
• Boolean nodeNats (optional, default: false)
  Include linked nodes' text representations.
• String format (optional, default: json)
  Node attribute input format: "json", "text".

Returned document content type:

application/json

Obtains edges of the specified type with the specified condition.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• 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 content type:

application/json

Obtains the edge with the specified ID.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• Integer id (required)
  Edge ID.

Returned document content type:

application/json

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

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• Integer pnid (required)
  Pivot node ID.
• String path (required)
  Graph-building path expression.

Request parameters:

• Boolean nodeAttrs (optional, default: true)
  Include node attributes.
• Boolean edgeAttrs (optional, default: true)
  Include edge attributes.
• Boolean linkAttrs (optional, default: true)
  Include link attributes.
• Boolean graphStats (optional, default: false)
  Include graph statistics.
• Boolean fullEdges (optional, default: true)
  Include all nodes in the edges, even those not affected by the edges.

Returned document content type:

application/json

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

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String expr (required)
  Search expression, separated by space.

Request parameters:

• String word (optional)
  Filter: Keywords, separated by space.
• String place (optional)
  Filter: Place names, separated by space.
• String person (optional)
  Filter: Person names, separated by space.
• String gender (optional)
  Filter: Genders specified, 'm', 'f', any spaces.
• Integer yearMin (optional)
  Filter: Earliest year.
• Integer yearMax (optional)
  Filter: Latest year.
• Boolean inclNoYear (optional, default: true)
  Filter: Include stories with no year specified (boolean).
• Boolean data (optional, default: false)
  Return index data along with story IDs (boolean).
• Integer limit (optional)
  Result set limit (1+).

Returned document content type:

application/json

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

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• Integer id (required)
  ID or type-internal ID of story (int).

Returned document content type:

application/json

Performs a full-text search on the fieldname attributes of all fn_record nodes and returns the IDs of the fn_denotation nodes, associated via egdetype fn_record_denotation and/or fn_record_denotation_preferred.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String expr (required)
  Search terms.
• Boolean preferred (optional, default: true)
  Search preferred denotations instead of general denotations.
• Boolean caseSensitive (optional, default: false)
  Case sensitive search.
• Integer minLength (optional, default: 2)
  Minimum length of individual search terms (1+).
• Integer limit (optional, default: 10)
  Maximum search results count, 0 = unlimited.

Returned document content type:

application/json

MWB article node access with WBN-specific enhancements, returning JSON data for the article specified.

Method:

• GET
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Path variables:

• String dict (required)
  Use either "MeckWB" for volumes 1-7 or "MeckWBN" for volume 8.
• String id (required)
  WBN ID.

Returned document content type:

application/json

Requests an authentication token, which is used for PowerGraph update operations.

Method:

• POST
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String role (required)
  Role ID to be authenticated.
• String pass (required)
  Password for role.

Returned document content type:

application/json

Returned document description:

Authentication token for PowerGraph update operations, which is valid for 20 seconds after request or its most recent successful use.

Creates a node of the specified type in WossiDiA-PowerGraph.

This operation is only available to authenticated users, which have the update permission on the respective nodetype.
There are two methods of authentication:

• Username and password, using the parameters user and pass
• Authentication token, using the parameter auth

Method:

• POST
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String user (optional)
  Username for simple password-based authentication.
• String pass (optional)
  Password for simple password-based authentication.
• String auth (optional)
  Authentication token, see /auth for details.
• String format (optional, default: json)
  Node attribute input format: "json", "text".
• String json (required)
  JSON specification of node.

  Pattern:

  {
     "type": <type>,
     "attrs": {
        "<aid>": <val>,
        ...
     }
  }

  ...with:

  <type> ... Nodetype ID or name, e.g.: 11 or "am_person"
  <aid>  ... Node attribute composite ID, e.g.: 11.2
  <val>  ... JSON representation of node attribute value
  

Returned document content type:

application/json

Updates a node's attribute value.

This operation is only available to authenticated users, which have the update permission on the respective nodetype.
There are two methods of authentication:

• Username and password, using the parameters user and pass
• Authentication token, using the parameter auth

Method:

• POST
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String user (optional)
  Username for simple password-based authentication.
• String pass (optional)
  Password for simple password-based authentication.
• String auth (optional)
  Authentication token, see /auth for details.
• Integer id (required)
  Node ID.
• String attr (required)
  Attribute ID or name.
• String value (required)
  Attribute value as JSON.

Returned document content type:

application/json

Deletes a node.

This operation is only available to authenticated users, which have the update permission on the respective nodetype.
There are two methods of authentication:

• Username and password, using the parameters user and pass
• Authentication token, using the parameter auth

Method:

• POST
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String user (optional)
  Username for simple password-based authentication.
• String pass (optional)
  Password for simple password-based authentication.
• String auth (optional)
  Authentication token, see /auth for details.
• Integer id (required)
  Node ID.

Returned document content type:

application/json

Creates an edge.

This operation is only available to authenticated users, which have the update permission on the respective nodetype.
There are two methods of authentication:

• Username and password, using the parameters user and pass
• Authentication token, using the parameter auth

Method:

• POST
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String user (optional)
  Username for simple password-based authentication.
• String pass (optional)
  Password for simple password-based authentication.
• String auth (optional)
  Authentication token, see /auth for details.
• String json (required)
  JSON specification of edge.

  Pattern:

  {
     "type": <type>,
     "attrs": {
        "<eid>": <val>,
        ...
     },
     "links": [
        {
           "role": <rid>,
           "node": <nid>,
           "attrs": {
              "<lid>": <val>,
              ...
           }
        },
        ...
     ],
  }

  ...with:

  <type> ... Edge type ID or name, e.g.: 1019 or "am_person"
  <eid>  ... Edge attribute composite ID, e.g.: 2.4
  <lid>  ... Link attribute composite ID, e.g.: 7.1.2
  <val>  ... JSON representation of attribute value
  <rid>  ... Composite role ID, e.g.: 1019.3
  <nid>  ... Linked node ID, e.g. 100001042
  

Returned document content type:

application/json

Story audio transcript upload.

This operation is only available to authenticated users, which have the update permission on the respective nodetype.
There are two methods of authentication:

• Username and password, using the parameters user and pass
• Authentication token, using the parameter auth

Method:

• POST
  Request parameters must be sent via POST body, using content/MIME type: application/x-www-form-urlencoded.

Request parameters:

• String user (optional)
  Username for simple password-based authentication.
• String pass (optional)
  Password for simple password-based authentication.
• String auth (optional)
  Authentication token, see /auth for details.
• Integer storyId (required)
  Story ID.
• String langCode (required)
  Audio language: 'deu', 'nds', 'eng', etc.
• String audioData (required)
  Audio data (Base64).

Returned document content type:

application/json