RestApiCategories.platformAdministration.desc

platform_administration

2024.11

2024.08

2024.09

2024.10

2024.12

The Localization service provides the ways to get, add or localize the
message bundles. With the GET request, the Localization service returns
the localized message bundle corresponding to the requested locale.

Localization

Retrieves multiple properties files in the http request and the API creates new message bundles or updates the existing message bundles.
The properties files can be archived in a ZIP file. This API accepts the ZIP file.
In the http request, the properties files or a ZIP file are written in the MIME multipart/form-data format <a href="https://www.rfc-editor.org/rfc/rfc7578">RFC7578</a>.

The properties file names have to follow the naming convention which is described in the section "import/export the message bundles as properties files".

This API returns a set of returned statuses. Its items that correspond to the properties files.

Using the curl command, a ZIP file can be posted. 
Here is an example.
<pre>
HOST=[Your cluster address]
TOKEN=[Access token]
curl -X POST \
-H "authorization:bearer $TOKEN" \
-H "Accept: application/vnd.sas.collection+json" \
-F "file=@archive.zip" \
https://$HOST/localization/contents/entertainment
</pre>
The example uploads the archive.zip file that contains some properties files for the
namespace "entertainment" and gets the results of the POST operation from the
endpoint in the standard output.

The properties files must be written in UTF-8.

The http request body can contain multiple properties files or a ZIP file in the MIME multipart/form-data format <a href="https://www.rfc-editor.org/rfc/rfc7578">RFC7578</a>. The Content-Type must be `multipart/form-data` followed by the `boundary=` MIME parameter to specify the boundary of the MIME parts. Here is an example.
<pre>Content-Type: multipart/form-data; boundary=aBoundaryString</pre>
Each MIME part needs to have the MIME header `Content-Disposition`, which has parameters name="file" and filename=. 
Here are examples.
<pre>Content-Disposition: form-data; name="file"; filename="myNamespace_default.properties"</pre>
<pre>Content-Disposition: form-data; name="file"; filename="myProperties.zip"</pre>


Each properties file is assumed to put in each MIME body. The content of each properties file can be encoded in the quoted-printable or base64.
 
If the content is encoded in quoted-printable or base64, the MIME header "Content-Transfer-Encoding" needs to be specified to indicate the encoding. 


If a ZIP file is included in the MIME body, the MIME header "Content-Type" must indicate "application/zip". Also, the content of the ZIP file should be encoded in base64. The MIME header "Content-Transfer-Encoding" needs to be specified to indicate base64 as below.
<pre>
Content-Type: application/zip
Content-Transfer-Encoding: base64
</pre>

The Content-Type should be 'multipart/form-data' and the MIME boundary needs to be specified with the 'boundary='. Here''s an example. 'Content-Type: multipart/form-data; boundary=aBoundaryString'

Content-Type

"application/json" or "application/vnd.sas.collection+json" are accepted.

Accept

"application/json" or "application/vnd.sas.error+json" are accepted.

Accept-Item

namespace

The data structure of the list of SAS Errors

Create or update message bundles

The list of links to top-level resources and operations available from the root of the API.

Status	Meaning	Description
200	OK	The request succeeded.		Schema
400	Bad Request	The request was invalid.		Schema

Create or update message bundles

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses

Name	Type	Required	Description
Accept	string	true	"application/json" or "application/vnd.sas.collection+json" are accepted.
Accept-Item	string	true	"application/json" or "application/vnd.sas.error+json" are accepted.
Content-Type	string	true	The Content-Type should be 'multipart/form-data' and the MIME boundary needs to be specified with the 'boundary='. Here''s an example. 'Content-Type: multipart/form-data; boundary=aBoundaryString'