1. Overview

These services perform admin-related functions.

1.1. Version information

Version : 1.0.0

1.2. License information

License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null

1.3. URI scheme

Host : hostname
BasePath : /adminapi

1.4. Tags

  • Sample : Sample Methods

  • business-process-controller : Business Process Controller

  • search-controller : Search Controller

2. Paths

2.1. Trigger business process event

POST /businessprocess/events

2.1.1. Description

Causes a trigger on a businnes process event

2.1.2. Parameters

Type Name Description Schema

Body

request
required

request

TriggerEventRequest

2.1.3. Responses

HTTP Code Description Schema

200

Operation succeeded

TriggerEventResponse

400

Bad request

No Content

404

event can’t be null

No Content

409

Event has been already triggered

No Content

2.1.4. Consumes

  • application/json

2.1.5. Produces

  • */*

2.1.6. Tags

  • business-process-controller

2.1.7. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.2. Execute flexible search

POST /console/search/flexible

2.2.1. Description

Runs a flexible search query

2.2.2. Parameters

Type Name Description Schema Default

Query

commit
optional

commit

boolean

"false"

Query

locale
optional

locale

string

Query

maxCount
optional

maxCount

integer (int32)

200

Body

queryData
required

queryData

QueryData

2.2.3. Responses

HTTP Code Description Schema

200

Operation succeeded

SqlSearchResultData

400

Bad request

No Content

409

locale 'unknown' is not supported

No Content

2.2.4. Consumes

  • application/json

2.2.5. Produces

  • application/json

2.2.6. Tags

  • search-controller

2.2.7. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.3. Execute polyglot query search

POST /console/search/polyglot

2.3.1. Description

Runs a a polyglot search query

2.3.2. Parameters

Type Name Description Schema Default

Query

count
optional

count

integer (int32)

-1

Query

needTotalCount
optional

needTotalCount

boolean

"false"

Query

start
optional

start

integer (int32)

0

Body

queryData
required

queryData

QueryData

2.3.3. Responses

HTTP Code Description Schema

200

Operation succeeded

SearchResultData

400

Bad request

No Content

409

locale 'unknown' is not supported

No Content

2.3.4. Consumes

  • application/json

2.3.5. Produces

  • application/json

2.3.6. Tags

  • search-controller

2.3.7. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.4. Execute sql search

POST /console/search/sql

2.4.1. Description

Runs a sql query search

2.4.2. Parameters

Type Name Description Schema Default

Query

commit
optional

commit

boolean

"false"

Query

maxCount
optional

maxCount

integer (int32)

200

Body

queryData
required

queryData

QueryData

2.4.3. Responses

HTTP Code Description Schema

200

Operation succeeded

SqlSearchResultData

400

Bad request

No Content

2.4.4. Consumes

  • application/json

2.4.5. Produces

  • application/json

2.4.6. Tags

  • search-controller

2.4.7. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3. Definitions

3.1. Exception

Name Schema

cause
optional

Throwable

localizedMessage
optional

string

message
optional

string

stackTrace
optional

< StackTraceElement > array

suppressed
optional

< Throwable > array

3.2. Map«string,object»

Type : < string, object > map

3.3. ParamData

Name Schema

placeholder
optional

string

value
optional

string

3.4. QueryData

Name Schema

params
optional

< ParamData > array

query
optional

string

3.5. SearchResultData

Name Schema

executionTime
optional

string

message
optional

string

resultCount
optional

integer (int32)

resultSet
optional

< Map«string,object» > array

totalCount
optional

integer (int32)

3.6. SqlSearchResultData

Name Schema

catalogVersionsAsString
optional

string

exception
optional

Exception

exceptionStackTrace
optional

string

executionTime
optional

integer (int64)

headers
optional

< string > array

parametersAsString
optional

string

query
optional

string

rawExecution
optional

boolean

resultCount
optional

integer (int32)

resultList
optional

< < string > array > array

3.7. StackTraceElement

Name Schema

classLoaderName
optional

string

className
optional

string

fileName
optional

string

lineNumber
optional

integer (int32)

methodName
optional

string

moduleName
optional

string

moduleVersion
optional

string

nativeMethod
optional

boolean

3.8. Throwable

Name Schema

cause
optional

Throwable

localizedMessage
optional

string

message
optional

string

stackTrace
optional

< StackTraceElement > array

suppressed
optional

< Throwable > array

3.9. TriggerEventRequest

Name Schema

choice
optional

string

event
optional

string

3.10. TriggerEventResponse

Name Schema

message
optional

string

4. Security

4.1. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : https://{oauth2_url}/authorizationserver/oauth/token

Name

basic

4.2. oauth2_password

Type : oauth2
Flow : password
Token URL : https://{oauth2_url}/authorizationserver/oauth/token

Name

basic