1. Overview

These core-specific services include those for configuration, internationalization, and language.

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 : /smarteditwebservices

1.4. Tags

  • configurations : Smartedit Configurations

  • languages : Smartedit Languages

1.5. Produces

  • application/json

2. Paths

2.1. Save a Configuration

POST /v1/configurations

2.1.1. Description

Endpoint to create cms configuration data

2.1.2. Parameters

Type Name Description Schema

Body

data
required

Configuration data

configurationData

2.1.3. Responses

HTTP Code Description Schema

200

OK

configurationData

201

Created

No Content

401

Must be authenticated as an Admin to access this resource

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.4. Consumes

  • application/json

2.1.5. Tags

  • configurations

2.1.6. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.2. Get All Configurations

GET /v1/configurations

2.2.1. Description

Endpoint to retrieve all cms configuration data

2.2.2. Responses

HTTP Code Description Schema

200

OK

ConfigurationDataListWsDto

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.2.3. Tags

  • configurations

2.2.4. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.3. Find a Configuration by Key

GET /v1/configurations/{key}

2.3.1. Description

Endpoint to retrieve cms configuration data that matches the given key value

2.3.2. Parameters

Type Name Description Schema

Path

key
required

Configuration data identifier

string

2.3.3. Responses

HTTP Code Description Schema

200

OK

configurationData

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.3.4. Tags

  • configurations

2.3.5. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.4. Update a Configuration

PUT /v1/configurations/{key}

2.4.1. Description

Endpoint to update cms configuration data

2.4.2. Parameters

Type Name Description Schema

Path

key
required

Configuration data identifier

string

Body

data
required

Configuration data

configurationData

2.4.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

2.4.4. Consumes

  • application/json

2.4.5. Tags

  • configurations

2.4.6. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.5. Remove a Configuration

DELETE /v1/configurations/{key}

2.5.1. Description

Endpoint to remove cms configuration data that matches the given key

2.5.2. Parameters

Type Name Description Schema

Path

key
required

Configuration data identifier

string

2.5.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Must be authenticated as an Admin to access this resource

No Content

403

Forbidden

No Content

2.5.4. Tags

  • configurations

2.5.5. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.6. Get Languages

GET /v1/i18n/languages

2.6.1. Description

Endpoint to retrieve list of supported languages

2.6.2. Responses

HTTP Code Description Schema

200

OK

SmarteditLanguageListData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.6.3. Tags

  • languages

2.6.4. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

2.7. Get a Translation Map

GET /v1/i18n/translations/{locale}

2.7.1. Description

Endpoint to retrieve translated data using the specified locale value

2.7.2. Parameters

Type Name Description Schema

Path

locale
required

Locale identifier consisting of a language and region

string

2.7.3. Responses

HTTP Code Description Schema

200

OK

languageMap

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.7.4. Tags

  • languages

2.7.5. Security

Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3. Definitions

3.1. ConfigurationDataListWsDto

List of configurations

Name Description Schema

configurations
required

The list of configuration data

< configurationData > array

3.2. SmarteditLanguageListData

List of languages

Name Description Schema

languages
required

The list of language data

< languageData > array

3.3. configurationData

Configuration data

Name Description Schema

key
required

The configuration data key
Example : "defaultToolingLanguage"

string

value
required

The configuration data value
Example : "en"

string

3.4. languageData

Language data

Name Description Schema

isoCode
required

The iso code of the language data
Example : "en"

string

name
required

The name of the language data
Example : "English"

string

3.5. languageMap

Language map for a given locale

Name Description Schema

value
required

The map of localized key-value pairs

< string, string > map

4. Security

4.1. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token

Name

extended

4.2. oauth2_password

Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

basic