SmartEdit Webservices
These core-specific services include those for configuration, internationalization, and language.
Version: 1.0
BasePath:/smarteditwebservices
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.
http://apache.org/licenses/LICENSE-2.0.html
Access
- OAuth AuthorizationUrl:TokenUrl:https://{oauth2_url}/authorizationserver/oauth/token
- OAuth AuthorizationUrl:TokenUrl:https://{oauth2_url}/authorizationserver/oauth/token
[ Jump to Models ]
Table of Contents
Up
delete /v1/configurations/{key}
Remove a Configuration (deleteUsingDELETE)
Endpoint to remove cms configuration data that matches the given key
Path parameters
key (required)
Path Parameter — Configuration data identifier
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
204
No Content
401
Must be authenticated as an Admin to access this resource
403
Forbidden
Up
get /v1/configurations/{key}
Find a Configuration by Key (findByKeyUsingGET)
Endpoint to retrieve cms configuration data that matches the given key value
Path parameters
key (required)
Path Parameter — Configuration data identifier
Return type
Example data
Content-Type: application/json
{
"value" : "en",
"key" : "defaultToolingLanguage"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
configurationData
401
Must be authenticated as an Admin or CMS Manager to access this resource
403
Forbidden
404
Not Found
Up
get /v1/configurations
Get All Configurations (loadAllUsingGET)
Endpoint to retrieve all cms configuration data
Return type
Example data
Content-Type: application/json
{
"configurations" : [ {
"value" : "en",
"key" : "defaultToolingLanguage"
}, {
"value" : "en",
"key" : "defaultToolingLanguage"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
ConfigurationDataListWsDto
401
Must be authenticated as an Admin or CMS Manager to access this resource
403
Forbidden
404
Not Found
Up
post /v1/configurations
Save a Configuration (saveUsingPOST)
Endpoint to create cms configuration data
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Configuration data
Return type
Example data
Content-Type: application/json
{
"value" : "en",
"key" : "defaultToolingLanguage"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
configurationData
201
Created
401
Must be authenticated as an Admin to access this resource
403
Forbidden
404
Not Found
Up
put /v1/configurations/{key}
Update a Configuration (updateUsingPUT)
Endpoint to update cms configuration data
Path parameters
key (required)
Path Parameter — Configuration data identifier
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Configuration data
Return type
Example data
Content-Type: application/json
{
"value" : "en",
"key" : "defaultToolingLanguage"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
configurationData
201
Created
400
Configuration data input is invalid
401
Must be authenticated as an Admin to access this resource
403
Forbidden
404
Not Found
Up
get /v1/i18n/languages
Get Languages (getToolingLanguagesUsingGET)
Endpoint to retrieve list of supported languages
Return type
Example data
Content-Type: application/json
{
"languages" : [ {
"isoCode" : "en",
"name" : "English"
}, {
"isoCode" : "en",
"name" : "English"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
SmarteditLanguageListData
401
Unauthorized
403
Forbidden
404
Not Found
Up
get /v1/i18n/translations/{locale}
Get a Translation Map (getTranslationMapUsingGET)
Endpoint to retrieve translated data using the specified locale value
Path parameters
locale (required)
Path Parameter — Locale identifier consisting of a language and region
Return type
Example data
Content-Type: application/json
{
"value" : {
"key" : "value"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
languageMap
401
Unauthorized
403
Forbidden
404
Not Found
[ Jump to Methods ]
Table of Contents
ConfigurationDataListWsDto - ConfigurationDataListWsDtoSmarteditLanguageListData - SmarteditLanguageListDataconfigurationData - configurationDatalanguageData - languageDatalanguageMap - languageMap
Configuration data
key
String The configuration data key
example: defaultToolingLanguage
value
String The configuration data value
example: en
Language data
isoCode
String The iso code of the language data
example: en
name
String The name of the language data
example: English
Language map for a given locale