1. Overview

These core-specific services include those for configuration, single sign-on authentication, and setting.

1.1. Version information

Version : 1.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 : localhost:9001
BasePath : /smartedit

1.4. Tags

  • authentications : Controller used to generate OAuth2 token based on SSO authentication

  • configurations : Controller used to send the requested CRUD operations to the secured webservice responsible of executing the operation

  • login-smart-edit-controller : Login Smart Edit Controller

  • root : Root Controller

  • settings : Settings Controller

1.5. Produces

  • application/xml

  • application/json

2. Paths

2.1. Get the SmartEdit index page

GET /

2.1.1. Description

Endpoint to retrieve the index page of SmartEdit

2.1.2. Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.3. Tags

  • root

2.1.4. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.2. Create OAuth token from single sign-on authentication

POST /authenticate

2.2.1. Description

Endpoint to create an OAuth token from a single sign-on authentication

2.2.2. Parameters

Type Name Description Schema

Body

credentials
required

Single sign-on credentials

SSOCredentials

2.2.3. Responses

HTTP Code Description Schema

201

Created

OAuth2AccessToken

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.4. Consumes

  • application/json

2.2.5. Tags

  • authentications

2.2.6. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.3. Create configurations

POST /configuration

2.3.1. Description

Endpoint to create configurations.

2.3.2. Parameters

Type Name Description Schema

Header

Authorization
required

Authorization bearer token

string

Body

payload
required

Map representing the configurations to create

< string, string > map

2.3.3. Responses

HTTP Code Description Schema

201

Created

ConfigurationData

401

Must be authenticated as an Admin to access this resource

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3.4. Consumes

  • application/json

2.3.5. Tags

  • configurations

2.3.6. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.4. Get configurations

GET /configuration

2.4.1. Description

Endpoint to retrieve configurations.

2.4.2. Parameters

Type Name Description Schema

Header

Authorization
required

Authorization bearer token

string

2.4.3. Responses

HTTP Code Description Schema

200

OK

< ConfigurationData > array

401

Must be authenticated as an Admin or CMS Manager to access this resource

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.4.4. Tags

  • configurations

2.4.5. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.5. Update configurations

PUT /configuration/{key}

2.5.1. Description

Endpoint to update configurations.

2.5.2. Parameters

Type Name Description Schema

Header

Authorization
required

Authorization bearer token

string

Path

key
required

The key of the configuration to update

string

Body

payload
required

Map representing the configurations to update

< string, string > map

2.5.3. Responses

HTTP Code Description Schema

200

OK

ConfigurationData

201

Created

No Content

400

Configuration data input is invalid

No Content

401

Must be authenticated as an Admin to access this resource

No Content

403

Forbidden

No Content

404

Not Found

No Content

405

The configuration key is missing from the payload

No Content

2.5.4. Consumes

  • application/json

2.5.5. Tags

  • configurations

2.5.6. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.6. Delete configurations

DELETE /configuration/{key}

2.6.1. Description

Endpoint to delete configurations.

2.6.2. Parameters

Type Name Description Schema

Header

Authorization
required

Authorization bearer token

string

Path

key
required

The key of the configuration to delete

string

2.6.3. Responses

HTTP Code Description Schema

204

No Content

No Content

401

Must be authenticated as an Admin to access this resource

No Content

403

Forbidden

No Content

2.6.4. Tags

  • configurations

2.6.5. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.7. getLoginPage

GET /login
Caution

operation.deprecated

2.7.1. Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.7.2. Tags

  • login-smart-edit-controller

2.7.3. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

2.8. Get a map of application settings

GET /settings

2.8.1. Description

Endpoint to retrieve a map of non-protected settings necessary for front-end to self-configure

2.8.2. Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.8.3. Tags

  • settings

2.8.4. Security

Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3. Definitions

3.1. ConfigurationData

Name Schema

key
optional

string

value
optional

string

3.2. OAuth2AccessToken

Name Schema

additionalInformation
optional

object

expiration
optional

string (date-time)

expired
optional

boolean

expiresIn
optional

integer (int32)

refreshToken
optional

OAuth2RefreshToken

scope
optional

< string > array

tokenType
optional

string

value
optional

string

3.3. OAuth2RefreshToken

Type : object

3.4. SSOCredentials

Name Schema

client_id
optional

string

4. Security

4.1. oauth2_Password

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

Name

basic

4.2. oauth2_client_credentials

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

Name

extended