RESTful API

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up

GET /rest/activateUser/{group}/{storeName}/{username}

(restActivateUserGroupStoreNameUsernameGet)

Path parameters

group (required)Path Parameter —storeName (required)Path Parameter —username (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Return type

Boolean

Example data

Content-Type: application/json

true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK Boolean


Up

GET /rest/analyse/{group}/{storeName}/{project}/{purpose}

(restAnalyseGroupStoreNameProjectPurposeGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —purpose (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/authenticateTrusted/{group}

(restAuthenticateTrustedGroupGet)

Path parameters

group (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

callbackURL (required)Query Parameter —secret (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/authenticate/{username}

(restAuthenticateUsernameGet)

Path parameters

username (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/checkLicense

(restCheckLicenseGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

token (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/consumeFiles/{group}/{storeName}/{project}

(restConsumeFilesGroupStoreNameProjectPost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • multipart/form-data

Query parameters

delimiter (optional)Query Parameter — default: ,encoding (optional)Query Parameter — default: UTF8origPath (optional)Query Parameter —password (required)Query Parameter —quote (optional)Query Parameter —rootNode (required)Query Parameter —sheetno (optional)Query Parameter — default: 0systemName (optional)Query Parameter — default: Defaulttoken (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/context/{group}/{project}

(restContextGroupProjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/deleteListener/{group}/{storeName}/{project}

(restDeleteListenerGroupStoreNameProjectPost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/deleteMessage/{group}/{storeName}/{project}/{msgid}

(restDeleteMessageGroupStoreNameProjectMsgidGet)

Path parameters

group (required)Path Parameter —msgid (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —type (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/getJobStatus/{group}/{storeName}/{project}

(restGetJobStatusGroupStoreNameProjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/getJobStatus/{group}/{storeName}/{project}/{jobID}

(restGetJobStatusGroupStoreNameProjectJobIDGet)

Path parameters

group (required)Path Parameter —jobID (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/getListeners/{group}/{storeName}/{project}/{type}

(restGetListenersGroupStoreNameProjectTypeGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —type (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

listenerID (required)Query Parameter —password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/getMessages/{group}/{storeName}/{project}

(restGetMessagesGroupStoreNameProjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/getMetadata/{group}/{storeName}/{project}/{type}

(restGetMetadataGroupStoreNameProjectTypeGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —type (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

globalTables (required)Query Parameter —id (required)Query Parameter —password (required)Query Parameter —relTables (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/getSummary/{group}/{storeName}/{project}

(restGetSummaryGroupStoreNameProjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —subject (required)Query Parameter —token (required)Query Parameter —type (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/getTasks/{group}/{storeName}/{project}/{type}

(restGetTasksGroupStoreNameProjectTypeGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —type (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

limits (required)Query Parameter —nodeid (required)Query Parameter —page (required)Query Parameter —password (required)Query Parameter —subject (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/hierarchy/combinedKey/{group}/{storeName}/{project}/{id}

(restHierarchyCombinedKeyGroupStoreNameProjectIdGet)

Path parameters

group (required)Path Parameter —id (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

adjacencies (required)Query Parameter —direction (required)Query Parameter —form (required)Query Parameter —fullValues (required)Query Parameter —history (required)Query Parameter —password (required)Query Parameter —relType (required)Query Parameter —toTop (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —when (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/hierarchy/eid/{group}/{storeName}/{project}/{eid}

(restHierarchyEidGroupStoreNameProjectEidGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

direction (required)Query Parameter —eid (required)Query Parameter —history (required)Query Parameter —password (required)Query Parameter —relType (required)Query Parameter —toTop (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/hierarchy/pkey/{group}/{storeName}/{project}/{pkey}

(restHierarchyPkeyGroupStoreNameProjectPkeyGet)

Path parameters

group (required)Path Parameter —pkey (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

direction (required)Query Parameter —history (required)Query Parameter —password (required)Query Parameter —relType (required)Query Parameter —toTop (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/hierarchy/search/{group}/{storeName}/{project}/{subject}

(restHierarchySearchGroupStoreNameProjectSubjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —where (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/job/{group}/{storeName}/{project}

(restJobGroupStoreNameProjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/job/{group}/{storeName}/{project}/{jobID}

(restJobGroupStoreNameProjectJobIDGet)

Path parameters

group (required)Path Parameter —jobID (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

action (required)Query Parameter —password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/loadFile/{group}/{storeName}/{project}

(restLoadFileGroupStoreNameProjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

delimiter (required)Query Parameter —email (required)Query Parameter —encoding (required)Query Parameter —filelist (required)Query Parameter —hioverride (required)Query Parameter —idprefix (required)Query Parameter —mappings (required)Query Parameter —override (required)Query Parameter —password (required)Query Parameter —quote (required)Query Parameter —readcount (required)Query Parameter —relName (required)Query Parameter —rootNode (required)Query Parameter —sheetno (required)Query Parameter —skip (required)Query Parameter —stopat (required)Query Parameter —subject (required)Query Parameter —systemName (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/logout/{group}/{storeName}

(restLogoutGroupStoreNameGet)

Path parameters

group (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/match/{group}/{storeName}/{project}/{subject}

(restMatchGroupStoreNameProjectSubjectPost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Request body

body object (required)Body Parameter —

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/parseFile/{group}/{storeName}/{project}

(restParseFileGroupStoreNameProjectPost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • multipart/form-data

Query parameters

delimiter (required)Query Parameter —encoding (required)Query Parameter —password (required)Query Parameter —quote (required)Query Parameter —rootNode (required)Query Parameter —sheetno (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

array[Document]

Example data

Content-Type: application/json

[ {
  "date" : "{}",
  "string" : "string",
  "asMap" : "{}",
  "double" : 0.80082819046101150206595775671303272247314453125,
  "integer" : 6,
  "list" : [ { }, { } ],
  "long" : 1,
  "empty" : true,
  "boolean" : true,
  "native" : "{}",
  "projection" : "{}",
  "properties" : [ "properties", "properties" ]
}, {
  "date" : "{}",
  "string" : "string",
  "asMap" : "{}",
  "double" : 0.80082819046101150206595775671303272247314453125,
  "integer" : 6,
  "list" : [ { }, { } ],
  "long" : 1,
  "empty" : true,
  "boolean" : true,
  "native" : "{}",
  "projection" : "{}",
  "properties" : [ "properties", "properties" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK


Up

GET /rest/Project/{group}/{storeName}/{project}/{command}

(restProjectGroupStoreNameProjectCommandGet)

Path parameters

command (required)Path Parameter —group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

menuName (required)Query Parameter —password (required)Query Parameter —table (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/publishSchema/{group}/{storeName}/{project}

(restPublishSchemaGroupStoreNameProjectPost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/putMetadata/{group}/{storeName}/{project}

(restPutMetadataGroupStoreNameProjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

action (required)Query Parameter —id (required)Query Parameter —password (required)Query Parameter —token (required)Query Parameter —type (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/putMetadata/{group}/{storeName}/{project}

(restPutMetadataGroupStoreNameProjectPost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

id (required)Query Parameter —password (required)Query Parameter —token (required)Query Parameter —type (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/recordAsKeyValue/{group}/{storeName}/{project}/{id}

(restRecordAsKeyValueGroupStoreNameProjectIdGet)

Path parameters

group (required)Path Parameter —id (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

history (required)Query Parameter —password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/recordByKey/{group}/{storeName}/{project}/{subject}/{id}

(restRecordByKeyGroupStoreNameProjectSubjectIdGet)

Path parameters

group (required)Path Parameter —id (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

history (required)Query Parameter —password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/recordLabels/{group}/{storeName}/{project}/{subject}

(restRecordLabelsGroupStoreNameProjectSubjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —where (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/recordLinks/{group}/{storeName}/{project}/{parent}/{child}

(restRecordLinksGroupStoreNameProjectParentChildGet)

Path parameters

child (required)Path Parameter —group (required)Path Parameter —parent (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —reltype (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —when (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/recordLinks/{group}/{storeName}/{project}/{subject}/{id}/{reltype}

(restRecordLinksGroupStoreNameProjectSubjectIdReltypeGet)

Path parameters

group (required)Path Parameter —id (required)Path Parameter —project (required)Path Parameter —reltype (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —when (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/registerUser/{username}

(restRegisterUserUsernameGet)

Path parameters

username (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —

Return type

Boolean

Example data

Content-Type: application/json

true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK Boolean


Up

GET /rest/relationship/{group}/{storeName}/{project}/{parent}/{child}/{reltype}

(restRelationshipGroupStoreNameProjectParentChildReltypeGet)

Path parameters

child (required)Path Parameter —group (required)Path Parameter —parent (required)Path Parameter —project (required)Path Parameter —reltype (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

action (required)Query Parameter —data (required)Query Parameter —direction (required)Query Parameter —password (required)Query Parameter —reason (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —when (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/rules/{group}/{storeName}/{project}

(restRulesGroupStoreNameProjectPost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/rules/{group}/{storeName}/{project}/{purpose}

(restRulesGroupStoreNameProjectPurposeGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —purpose (required)Path Parameter —storeName (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —query (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/saveListener/{group}/{storeName}/{project}/{type}

(restSaveListenerGroupStoreNameProjectTypePost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —type (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/search/eid/{group}/{storeName}/{project}/{subject}

(restSearchEidGroupStoreNameProjectSubjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

page (required)Query Parameter —password (required)Query Parameter —q (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/search/find/{group}/{storeName}/{project}/{subject}

(restSearchFindGroupStoreNameProjectSubjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

page (required)Query Parameter —password (required)Query Parameter —query (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/search/{group}/{storeName}/{project}/{subject}

(restSearchGroupStoreNameProjectSubjectGet)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —query (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

POST /rest/setRecord/{group}/{storeName}/{project}/{subject}

(restSetRecordGroupStoreNameProjectSubjectPost)

Path parameters

group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —subject (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

password (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Up

GET /rest/task/action/{group}/{storeName}/{project}/{action}/{taskid}

(restTaskActionGroupStoreNameProjectActionTaskidGet)

Path parameters

action (required)Path Parameter —group (required)Path Parameter —project (required)Path Parameter —storeName (required)Path Parameter —taskid (required)Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Query parameters

assignee (required)Query Parameter —msg (required)Query Parameter —password (required)Query Parameter —survivingID (required)Query Parameter —token (required)Query Parameter —username (required)Query Parameter —

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK String


Models

[ Jump to Methods ]

Table of Contents

  1. Document –
  2. Object –

Document –Up

asDocument (optional)DocumentasMap (optional)Objectboolean (optional)Booleandate (optional)Objectdouble (optional)BigDecimalempty (optional)Booleaninteger (optional)Integerlist (optional)array[Object]long (optional)Integernative (optional)Objectprojection (optional)Objectproperties (optional)array[String]string (optional)String

Object –Up