RestApiCategories.platformAdministration.desc

platform_administration

2025.08

2025.09

2025.10

2025.11

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

2024.09

2025.03

2025.07

Deletes all of the message bundles for the specified by the namespace. You can choose the message bundles with the filter= query parameter.

namespace

Query filter, supported fields are `type` and `id`.

filter

Delete message bundles in the specified namespace

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

Error

The data structure of the list of SAS Errors

errorCollection

A link to a related operation or resource.

Link

localizationContent

localizationContentCollection

localizationContentNamespace

localizationContentNamespaceCollection

localizationContentSummary

localizationContentSummaryCollection

localizationContentType

localizationContentTypeCollection

The version number of the API representation. This is version 2.

application/vnd.sas.api

Messages that provide additional details about the cause of the error.

A message that describes how to resolve the error.

The version number of the error representation. This representation is version 2.

application/vnd.sas.error

If this is a link to a container, `itemType` is the media type or link type for the items in the container.

The relationship of this URL to the object.

The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.

This media type's schema version number.  This representation is version 1.

string

This media type's schema version number. This representation is version 1.

SAS Developers

SAS Institute Inc.

Returns the API object that contains a set of links for the supported endpoints.

Accept

Represents the content type application/vnd.sas.api+json.

Returns a set of namespaces</li> <table border="1"><tr align="left"><th>Accept</th><td>application/vnd.sas.collection+json</td></tr> <tr align="left"><th>Accept-Item</th><td>application/vnd.sas.localization.content.namespace+json</td></tr></table>

Query filter, supported field is `namespace`.

Optional sorting instruction, supported field is `namespace`.

sortBy

Offset of first item to retrieve (0-based). Defaults to 0.

start

Maximum number of items to retrieve. Defaults to 30.

limit

The application/vnd.sas.collection+json is used to get the list of namespaces.

Requested media type for collection of message bundles.

Accept-Item

Represents the content type application/vnd.sas.collection+json.

Returns a list of type summaries or message bundles as properties files or a ZIP file.
Retrieves one of five resources by specifying the http header Accept and
Accept-Item. Only the second item requires the http header
Accept-Language and returns a set of all message bundles that belong
to the namespace.
<table border="1"><tr><th>&nbsp;</th><th>resource</th><th>Accept http request header</th><th>Accept-Item http request header</th></tr>
<tr><td align="center">1</td><td>a set of types summary</td><td>application/json or application/vnd.sas.collection+json</td><td>application/json or application/vnd.sas.localization.content.type+json</td></tr>
<tr><td align="center">2</td><td>a set of message bundles</td><td>application/vnd.sas.collection+json</td><td>application/vnd.sas.localization.content+json</td></tr>
<tr><td align="center">3</td><td>message bundles as the properties files</td><td>multipart/form-data</td><td>application/vnd.sas.properties.file</td></tr>
<tr><td align="center">4</td><td>message bundles as a ZIP file using MIME</td><td>multipart/form-data</td><td>application/zip</td></tr>
<tr><td align="center">5</td><td>message bundles as a ZIP file</td><td>application/zip</td><td>&nbsp;</td></tr>
</table>
Retrieving (exporting) the message bundles as the properties files or a ZIP file.

The properties file names are followed by the naming convention, which is described in the section "import/export the message bundles as properties files".
In the http response, the properties files, the ZIP file, or the ZIP file that is in the MIME multipart/form-data format <a href="https://www.rfc-editor.org/rfc/rfc7578">RFC7578</a>.
The character encoding of the properties files is utf-8.


When the Accept http header is application/zip, the http response body is the content of the ZIP file.
The Accept-Item http header must be specified when the Accept http header is application/json, application/vnd.sas.collection+json, or multipart/form-data. The available values are "application/zip" and "application/vnd.sas.properties.file".
When the "application/zip" is specified for the Accept-Item http header, a ZIP file is returned in a MIME part.
When the "application/vnd.sas.properties.file" is specified, each properties file is returned in a MIME part.


Using the curl command, a ZIP file can be downloaded. 
Here is an example.
<pre>
HOST=[Your cluster address]
TOKEN=[Access token]
curl -X GET -o archive.zip \
-H "authorization:bearer $TOKEN" \
-H "Accept: application/zip" \
https://$HOST/localization/contents/entertainment
</pre>
The example downloads the archive.zip file that contains all the properties files in the
namespace "entertainment".

Maximum number of items to retrieve. Defaults to 30 for a set of type summary. 0 for the message bundles, means all the message bundles.

The Accept-Language http header is required only when the Accept
http header is "application/vnd.sas.collection+json" and the
Accept-Item http header is
"application/vnd.sas.localization.content+json". 
This API returns the [resolved bundles](#LocaleChain) for the local
specified in the Accept-Language. 
The resolved bundles have the full set of message keys.
The locale follows
<a href="https://tools.ietf.org/html/bcp47">BCP-47</a>. The bundle
id consists of three items
&lt;service name&gt;-&lt;bundle type&gt;-&lt;bundle format&gt;.
 See the Terminology section for detail.

Accept-Language

<ul>
<li>application/vnd.sas.localization.content.type+json for a set of types summary
<li>application/vnd.sas.localization.content+json for a set of
 message bundles. The Accept-Language is required in this case.
<li>application/vnd.sas.properties.file or application/zip for message bundles as properties files or a ZIP file
</ul>

<ul>
<li>application/vnd.sas.collection+json for a set of types summary
<li>multipart/form-data for message bundles as properties files or a ZIP file
<li>application/json for a ZIP file
</ul>

The request succeeded.

For the Example-1 of Media type "multipart/form-data", here are
the http headers Content-Type and Content-Item-Type.
<pre>Content-Type: multipart/form-data;boundary=aBoundaryString
Content-Item-Type: application/vnd.sas.properties.file</pre>
For the Example-2 of Media type "multipart/form-data",
the http headers Content-Type and Content-Item-Type are below.
<pre>Content-Type: multipart/form-data;boundary=aBoundaryString
Content-Item-Type: application/zip</pre>

This http header is specified when the Content-Type is
multipart/form-data or application/vnd.sas.collection+json.
Representing the content item type. application/zip or
application/vnd.sas.properties.file for multipart/form-data.

Represents the content type. multipart/form-data, application/zip, or application/vnd.sas.collection+json.

Get a list of type summaries or message bundles

Retrieves the headers and check the availability of a namespace

<ul>
<li>application/vnd.sas.localization.content.type+json for a set of types summary
<li>application/vnd.sas.properties.file or application/zip for message bundles as properties files or a ZIP file
</ul>

<ul>
<li>application/vnd.sas.collection+json for a set of types summary
<li>multipart/form-data for message bundles as properties files or a ZIP file
</ul>

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

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

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>

Delete message bundles in the specified namespace

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses