Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Version 5.0. APIs to query database content is available in version 5.0 and later.

Overview

API will return list of presentations as a summary in XML or complete presentations as XML. The APIs can be accessed by the following URLs.

Code Block
<!-- APIs for Server and Web are the same for accessing information -->
http://<server>/AssertServer/api/v1/<language>/<site>/<operation>/<parameter>
http://<server>/AssertWeb/api/v1/<language>/<site>/<operation>/<parameter>
Info

The language code is used to read texts from the database, only one translation is selected for a name. When selecting a document file the language is used to select what file to retorn to caller.

Operations

The following operations exist.

Operation

Parameter

Target

Comment

CatalogueList

Identity | LogicalIdentity | PersistentIdentity | empty

WebViewer, Server

Leave parameter empty to get full list of all objects

Catalogue

Id

WebViewer, Server

Id is database id of object

PartAssemblyList

Identity | LogicalIdentity | PersistentIdentity | empty

WebViewer, Server

Leave parameter empty to get full list of all objects

PartAssembly

Id

WebViewer, Server

Id is database id of object

PartList

Identity | LogicalIdentity | PersistentIdentity | PartNumber | empty

WebViewer, Server

Leave parameter empty to get full list of all objects

Part

Id

WebViewer, Server

Id is database id of object

DocumentList

Identity | LogicalIdentity | PersistentIdentity | FileName | empty

WebViewer, Server

Leave parameter empty to get full list of all objects

Document

Id

WebViewer, Server

Id is database id of object

ContentSetList

Identity | LogicalIdentity | PersistentIdentity | FileName | empty

WebViewer, Server

Leave parameter empty to get full list of all objects

ContentSet

Id

WebViewer, Server

Id is database id of object

ImageList

PersistentIdentity | FileName | empty

WebViewer, Server

Leave parameter empty to get full list of all objects

ImageFile

Id

WebViewer, Server

Id is database id of object

DocumentFile

Id

WebViewer, Server

Id is database id of document, file is computed from language

ContentSetFile

Id

WebViewer, Server

Id is database id of object, the content set file

Examples

Get all catalogues

...