Get language resource

get

/apiplatform/developers/v1/language/{languageCode}

Returns the custom Developer Portal language resource that has been submitted for the {languageCode} language as JSON. Returns a 404 if no custom language resources for the language code exist.

All authenticated users can request this resource.

• Request
• Response
• Examples

Request

Path Parameters

languageCode

Type: string

Required: true

Language code, like en-us.

Query Parameters

portalName

Type: string

Optional portal name query parameter, for site-specific settings

Response

Supported Media Types

• application/json

200 Response

JSON language resource structure.

Body

This is the JSON decription of language resources, in form of "language_code":{"id":"translated_text"}.

Root Schema : resources

Type: object

This is the JSON decription of language resources, in form of "language_code":{"id":"translated_text"}.

401 Response

Authentication required.

404 Response

No language resource found.

Examples

The following example shows how to retrieve custom language resources for the Oracle API Platform Cloud Service Developer Portal by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/developers/v1/language/en-us

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date: Sun, 01 Jan 2017 16:13:46 GMT
Content-length: 125
X-oracle-dms-ecid: 7Gs7D0PnR00000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Example of Response Body

The following example shows the contents of the response body in JSON format, including custom language resources for the specified language.

{
  "oap": {
    "navbar": {
      "buttons": {
        "apicatalog": "APIs",
        "appcatalog": "My Applications",
        "help": "Documentation",
        "user": "User Menu"
      }
    }
  }
}