REST API (Built-in Resources)

Schemes:

Summary

Path Operation Description
/action/{action} DELETE
GET
POST
PUT
/blob/{blobLocator} GET
POST
PUT
/configuredTopic/{topicID}/{formID} GET
POST
PUT
/topicIcon/{topicID} GET
/{conceptLocator}/objectList GET
/{conceptLocator}/objectList/printTemplate/{templateLocator} GET
/{conceptLocator}/objectList/printTemplate/{templateLocator}/{filename} GET

Paths

DELETE /action/{action}
request query string (x-element)
action path string (x-element)
response query string (x-element)
context body object

GET /action/{action}
request query string (x-element)
action path string (x-element)
response query string (x-element)
context body object

POST /action/{action}
response query string (x-element)
request query string (x-element)
action path string (x-element)
context body object

PUT /action/{action}
request query string (x-element)
action path string (x-element)
response query string (x-element)
context body object

GET /blob/{blobLocator}
blobLocator path string (x-element)

POST /blob/{blobLocator}
uploadOnly query boolean
binaryKey query string (x-element)
overrideContentType query string (x-element)
blobLocator path string (x-element)

PUT /blob/{blobLocator}
overrideContentType query string (x-element)
blobLocator path string (x-element)
uploadOnly query boolean
binaryKey query string (x-element)

GET /configuredTopic/{topicID}/{formID}
topicID path string (x-element)
encoding query string
formID path string (x-element)

POST /configuredTopic/{topicID}/{formID}
formID path string (x-element)
topicID path string (x-element)

PUT /configuredTopic/{topicID}/{formID}
topicID path string (x-element)
formID path string (x-element)

GET /topicIcon/{topicID}
size query integer (int32)
extensions path boolean
topicID path string (x-element)

GET /{conceptLocator}/objectList
filter query object[] (x-element) , multiple parameters (filter=aaa&filter=bbb)
type path string (x-element)
startTopic query string (x-element)
conceptLocator path string (x-element)
elementsPath query string (x-element)
name path string
application path string (x-element)
elements query string (x-element)
sort query object[] (x-element) , multiple parameters (sort=aaa&sort=bbb)
disableInheritance query boolean

GET /{conceptLocator}/objectList/printTemplate/{templateLocator}
application path string (x-element)
elements query string (x-element)
disableInheritance query boolean
sort query object[] (x-element) , multiple parameters (sort=aaa&sort=bbb)
filter query object[] (x-element) , multiple parameters (filter=aaa&filter=bbb)
type path string (x-element)
startTopic query string (x-element)
conceptLocator path string (x-element)
elementsPath query string (x-element)
name path string

GET /{conceptLocator}/objectList/printTemplate/{templateLocator}/{filename}
filter query object[] (x-element) , multiple parameters (filter=aaa&filter=bbb)
name path string
elementsPath query string (x-element)
elements query string (x-element)
sort query object[] (x-element) , multiple parameters (sort=aaa&sort=bbb)
application path string (x-element)
disableInheritance query boolean
type path string (x-element)
startTopic query string (x-element)
conceptLocator path string (x-element)

Schema definitions

Context: object

selectionIndex: integer

User; alternative Selection index of selected alternative. Starts with 1

applyIn: string

Locator of an application or configuration, which is used to find the right editor for json rendering

searchString: string

User: relation property Search string to find the target

startIndex: integer

Use: table Start index for the first element of the side view. Starts with 0

update: object

JSON with modifications for update

sort: string

Use: table A string with comma seperated integers with sort order

view: string

ID of the view that is to be used. Note: the parameter element OR the parameter view is necessary.

stopIndex: integer

Use: table Stop index for the last element of the side view. Starts with 0

application: string

Use: Table Determining which application for the appropriate configuration table to be searched. Specifying the identifier of the requested application

element: string

ID of the element that is to be used. Note: the parameter element OR the parameter view is necessary.

RenderContext: object

preferredLocatorTypes: string[]

Set the preferred locator types. Two possibilities: Use the string "InternalNameLocator" or the internal name of the attribute, which is used as locator

string
levelsOfDetail: string[]

Set the levels of detail

string , x ∈ { keyedProperties , propertyList , rdfID , schema , simpleDetails , simpleTable }