Technical documentation - Server APIs v1
- Mattias Löfstrand
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.
<!-- 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>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
http://demo.site.com/AssertServer/api/v1/en/DemoSite/CatalogueList/Returns
<Catalogues>
<Catalogue id="1" identity="start" logicalIdentity="start" modes="none">
<Name>
<Text id="14"/>
</Name>
<Note/>
</Catalogue>
<Catalogue id="10" persistent-id="accessories" logicalIdentity="accessories" modes="none">
<Name>
<Text id="12"/>
</Name>
<Description>
<Text id="16"/>
</Description>
<Note/>
</Catalogue>
<Catalogue id="1018" persistent-id="8153567253" identity="8153567253" modes="none">
<Name>
<Text id="2149"/>
</Name>
<Specification id="1015">
<SpecificationType id="7" persistent-id="WorkingPreassure" ValueType="Decimal" Modes="printable,searchable,visible">
<Category>
<SpecificationCategoryType id="1" persistent-id="PartRelation" code="TechnicalData" Modes="none">
<Name>
<Text id="43">
<Translation language="en">Technical data</Translation>
</Text>
</Name>
</SpecificationCategoryType>
</Category>
<Name>
<Text id="65">
<Translation language="en">Working preassure</Translation>
</Text>
</Name>
</SpecificationType>
<Value>7,50</Value>
</Specification>
<Note/>
</Catalogue>
</Catalogues>Get one part
Get part with part number 123456
Returns
The api is extendable, in that custom modules may define more operations similar to the ones above.