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 |
Authentication
See separate article on authentication: https://signifikant.atlassian.net/wiki/spaces/ASKB/pages/901578756/Technical+documentation+-+Signifikant+REST+API+authentication?src=search
Examples
Get all catalogues
| Code Block |
|---|
http://demo.site.com/AssertServer/api/v1/en/DemoSite/CatalogueList/ |
Returns
| Code Block | ||
|---|---|---|
| ||
<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
| Code Block |
|---|
http://demo.site.com/AssertWeb/api/v1/en/DemoSite/PartList/123456 |
Returns
| Code Block | ||
|---|---|---|
| ||
<Parts>
<Part id="2" persistent-id="1234567890" identity="1234567890" modes="none" isSellable="True" number="1234567890">
<Name>
<Text id="2166">
<Translation language="en">3D Print Powder Titan Premium</Translation>
</Text>
</Name>
<Description>
<Text id="19">
<Translation language="en">
Descriptive text
</Translation>
</Text>
</Description>
<Note/>
<QuantityUnit>
<Text id="1093">
<Translation language="en">pcs</Translation>
</Text>
</QuantityUnit>
</Part>
</Parts> |
| Info |
|---|
The api is extendable, in that custom modules may define more operations similar to the ones above. |