REST API (Built-in Resources)

Version: 5.3.23

Schemes:

Summary

Path Operation Description
/accessToken/login GET
POST
/accessToken/logout GET
POST
/accessToken/renew GET
POST
/action/{action}/{view} GET
POST
/blob/{blobLocator} GET
POST
PUT
/configuredTopic/{topicID}/{formID} GET
POST
PUT
/panel/contents POST
/topicIcon/{topicID} GET
/{conceptLocator}/objectList GET
/{conceptLocator}/objectList/printTemplate/{templateLocator} GET
/{conceptLocator}/objectList/printTemplate/{templateLocator}/{filename} GET
/{system}/storage PUT

Paths

GET /accessToken/login

POST /accessToken/login

GET /accessToken/logout

POST /accessToken/logout

GET /accessToken/renew

POST /accessToken/renew

GET /action/{action}/{view}

view path string (x-element)
action path string
panel query string (x-element)
element query string (x-element)
context body object

POST /action/{action}/{view}

panel query string (x-element)
element query string (x-element)
view path string (x-element)
action path string
context body object

GET /blob/{blobLocator}

blobLocator path string (x-element)

POST /blob/{blobLocator}

blobLocator path string (x-element)
overrideContentType query string (x-element)
uploadOnly query boolean
binaryKey query string (x-element)

PUT /blob/{blobLocator}

uploadOnly query boolean
binaryKey query string (x-element)
overrideContentType query string (x-element)
blobLocator path string (x-element)

GET /configuredTopic/{topicID}/{formID}

encoding query string
formID path string (x-element)
topicID 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)

POST /panel/contents

application query string (x-element)
element query string (x-element)

GET /topicIcon/{topicID}

extensions path boolean
topicID path string (x-element)
size path integer (int32)

GET /{conceptLocator}/objectList

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)
filter query object[] (x-element) , multiple parameters (filter=aaa&filter=bbb)
name path string

GET /{conceptLocator}/objectList/printTemplate/{templateLocator}

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

GET /{conceptLocator}/objectList/printTemplate/{templateLocator}/{filename}

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

PUT /{system}/storage

system path string

Schema definitions

Context: object

update: object

JSON with modifications for update

target: string

ID of the target element

panel: string

ID of the panel that is to be used.

expandFully: string

true if a node should be expanded fully. The default value is false.

sort: string

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

searchString: string

User: relation property Search string to find the target

refresh: boolean

True if the editor should be rendered

createSubtype: string

true if a subtype should be created. The default value is false.

preservePersistentTags: boolean

True if persistent tags should be preserved. Default is true

selectionElement: string

selected element of e.g. a table

typeaheadSize: integer

Size of typeahead element targets

stopIndex: integer

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

element: string

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

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

depth: integer

expand depth

link: boolean

True if link relations should be created. Default is false

expand: object[]

Array of element IDs

object
source: string

ID of the source element

startIndex: integer

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

materialize: boolean

True if new topics may be created automatically for tags. Only applies to tag configurations with the flag "tagging.createTags". Default is false

tags: object[]

Array of tags

view: string

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

application: string

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

nodes: object[]

Array of element IDs

object
type: string

ID of the type that is to be used

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 ∈ { adaptToCardinality , application , keyedProperties , propertyList , rdfID , schema , simpleDetails , simpleTable }