Development and QA

Available Web Services

EDG exposes CRUD operations through:

  1. GraphQL queries, including mutations.

  1. SPARQL endpoint which can be called via a REST API

  2. Templated RESTful Web Services for common operations. These services are typically implemented as:

  1. SPIN Templates – defined in .spin. files

  2. SPARQLMotion scripts – defined in .sms. files

  3. SWP Services defined in .ui. files

TopBraid EDG offers a number of pre-built RESTful services. Additional templated web services can be developed by customers, as needed, using the provided IDE, TopBraid Composer.

Authentication applied to EDG will also apply to the web service call.

See also

Please see EDG Installation and Authentication for more information.

TopBraid includes a facility for auto-generating API documentation. This means that any API that has been developed and deployed is automatically fully documented when marked as public. This includes pre-built TopQuadrant provided APIs as well as any customer developed APIs.

Selecting the Available Web Services link displays a page that lists web services available on this server. Selecting the checkbox next to any of these names displays documentation below the list about how to call that web service.

See below “Available Services List” for all currently available services.

TopBraid EDG Available Services List

TopBraid EDG Available Services List

TopBraid EDG AutoClassifier Web Services

TopBraid EDG AutoClassifier Web Services

For templated services, the following values can either be supplied in the HTTP request’s Accept header or as the value of the _format argument:

Response type

Format name

Arguments accepted

application/sparql-results+xml

SPARQL XML Results

xml

application/sparql-results+json

SPARQL JSON Results

json

application/sparql-results+json-simple

Simple JSON Format

json-simple

text/csv

Comma separated values

csv

text/tab-separated-values

Tab separated values

tsv

application/rdf+xml

RDF/XML

application/rdf+xml

text/turtle

Turtle

text/turtle

If you do not explicitly specify the response type, defaults will be used. The default serialization of SELECT result sets is JSON, following the SPARQL protocol. When you call a service from a web browser’s address bar, the mime type will typically be requested as something that includes the string “xml”, and in this case it will produce SPARQL XML Results. CONSTRUCT queries are returned in Turtle format by default.

The value of the _base argument can be a full graph URI or a short graph name. To define short graph names, go to the Server Administration -> Server Configuration Parameters page. In the section named “URI Parameters” define an instance of “Short graph names”.

To call a saved SPARQL query outside the EDG application, navigate to the Export tab -> Export using Saved SPARQL Query and copy the Service URL.

Available Web Services list

Example generated documentation from EDG.

TopBraid EDG Generated Example Documentation

Startup Sequence

This page lists the order and result of component activation during system startup. Useful for debugging.

URL Routes

Routes provide shorter or alternate URLs for deployed pages or services. New routes can be defined by setting the ui:uriTemplate property of an SWP ui:Service. This is considered an experimental feature and not recommended for production systems. Routes become active after a workspace refresh.

Query TopBraid Platform API using GraphQL

This page brings up the GraphiQL tool for TopBraid EDG.

GraphiQL is a graphical interactive in-browser GraphQL IDE which features syntax highlighting, type ahead and documentation. The GraphiQL IDE from Server Administration is scoped to the EDG platform. You can use this for example, to query for a list of collection types or permissions for collections.

Create snapshot of EDG

Creates a snapshot of the environment of EDG for testing purposes.

The snapshot consists of collections in the workspace plus history. You can save this then use the “Restore snapshot” feature to have a replicated environment, useful for testing upgrades or customizations.

Restore snapshot of EDG

A snapshot of EDG consists of collections in the workspace plus history. You can save this by using “create snapshot of edg” then use the “Restore snapshot” to have a replicated environment, useful for testing upgrades or customizations.

Warning

This will replace all data stored in your EDG Repositories folder! Only use this feature if no process is currently executing and no other users are logged in.

Run all DASH Test Cases

This feature is used to execut DASH test cases from .test. files and test case asset collections