Jump to

• Request
• Response
• Examples

Find by ID

get

/km/api/v1/locales/{id}

This method returns the Locale object specified by the ID parameter.

Example URIs

The example URIs for this method are as follows:

• http://<IM_REST_API_HOST>/km/api/latest/locales/{id}

  This method returns the Locale object having the specified ID parameter in the FULL mode.

• http://<IM_REST_API_HOST>/km/api/latest/locales/{id}?mode=KEY

  This method returns the Locale object having the specified ID parameter in KEY mode.

Request

Path Parameters

• id: string
  The unique identifier of the object to be retrieved.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : Locale

Match All

Show Source

• allOf LocaleKey
• object Locale-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/LocaleKey"
        },
        {
            "properties":{
                "active":{
                    "type":"boolean",
                    "description":"<p>The flag indicates whether the Locale object is active in the Oracle Knowledge system.</p>"
                },
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the Locale object was added or created.</p>"
                },
                "dateFormat":{
                    "type":"string",
                    "description":"<p>The prescribed format for displaying dates to the end users who are associated with the Locale object. The prescribed format class is <code>com.webobjects.foundation.NSTimestampFormatter</code>.</p>"
                },
                "dateFormatDisplay":{
                    "type":"string",
                    "description":"<p>The prescribed format in which dates appears in the displayed content. The prescribed format class is <code>java.text.DateFormat</code>.</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the Locale object was last modified.</p>"
                },
                "encoding":{
                    "type":"string",
                    "description":"<p>The prescribed encoding format used to display characters in the language.</p>"
                },
                "groupDefault":{
                    "type":"boolean",
                    "description":"<p>The flag indicates whether the specified Locale object is the default object for the group. Locale objects are grouped according to the language they represent.</p>"
                },
                "localeCode":{
                    "type":"string",
                    "description":"<p>The unique code that represents the language and country associated with the Locale object.</p>"
                },
                "localeDesc":{
                    "type":"string",
                    "description":"<p>The description about the language and country that the Locale object represents.</p>"
                },
                "localeValue":{
                    "type":"integer",
                    "description":"<p>The Locale ID value for the language and country that the Locale object represents.</p>"
                },
                "timeFormat":{
                    "type":"string",
                    "description":"<p>The prescribed format for displaying time to the end users associated with the Locale object. The prescribed format class is <code>com.webobjects.foundation.NSTimestampFormatter</code>.</p>"
                },
                "timeFormatDisplay":{
                    "type":"string",
                    "description":"<p>The prescribed format in which time appears in the displayed content. The prescribed format class is <code>java.text.DateFormat</code>.</p>"
                },
                "language":{
                    "$ref":"#/definitions/LanguageKey",
                    "description":"<p>The Language object with which the Locale object is associated.  The language is of type languageKeyBO and will generally be addressed using the recordId subfield.  For example language.recordId eq 'en'</p>"
                },
                "spellCheckingAlternateLocale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"<p>The Locale object with which the Locale object is associated for speller purposes.  The language is of type localeKeyBO and will generally be addressed using the recordId subfield.  For example locale.recordId eq 'en'</p>"
                }
            }
        }
    ]
}

Nested Schema : LocaleKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object LocaleKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Locale object.</p>"
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : LocaleKey-allOf[1]

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the Locale object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Locale object.</p>"
        }
    }
}

Nested Schema : Locale-allOf[1]

Type: object

Show Source

• active(optional): boolean

  The flag indicates whether the Locale object is active in the Oracle Knowledge system.

• dateAdded(optional): string(date-time)

  The date when the Locale object was added or created.

• dateFormat(optional): string

  The prescribed format for displaying dates to the end users who are associated with the Locale object. The prescribed format class is com.webobjects.foundation.NSTimestampFormatter.

• dateFormatDisplay(optional): string

  The prescribed format in which dates appears in the displayed content. The prescribed format class is java.text.DateFormat.

• dateModified(optional): string(date-time)

  The date when the Locale object was last modified.

• encoding(optional): string

  The prescribed encoding format used to display characters in the language.

• groupDefault(optional): boolean

  The flag indicates whether the specified Locale object is the default object for the group. Locale objects are grouped according to the language they represent.

• language(optional): LanguageKey
• localeCode(optional): string

  The unique code that represents the language and country associated with the Locale object.

• localeDesc(optional): string

  The description about the language and country that the Locale object represents.

• localeValue(optional): integer

  The Locale ID value for the language and country that the Locale object represents.

• spellCheckingAlternateLocale(optional): LocaleKey
• timeFormat(optional): string

  The prescribed format for displaying time to the end users associated with the Locale object. The prescribed format class is com.webobjects.foundation.NSTimestampFormatter.

• timeFormatDisplay(optional): string

  The prescribed format in which time appears in the displayed content. The prescribed format class is java.text.DateFormat.

{
    "properties":{
        "active":{
            "type":"boolean",
            "description":"<p>The flag indicates whether the Locale object is active in the Oracle Knowledge system.</p>"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the Locale object was added or created.</p>"
        },
        "dateFormat":{
            "type":"string",
            "description":"<p>The prescribed format for displaying dates to the end users who are associated with the Locale object. The prescribed format class is <code>com.webobjects.foundation.NSTimestampFormatter</code>.</p>"
        },
        "dateFormatDisplay":{
            "type":"string",
            "description":"<p>The prescribed format in which dates appears in the displayed content. The prescribed format class is <code>java.text.DateFormat</code>.</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the Locale object was last modified.</p>"
        },
        "encoding":{
            "type":"string",
            "description":"<p>The prescribed encoding format used to display characters in the language.</p>"
        },
        "groupDefault":{
            "type":"boolean",
            "description":"<p>The flag indicates whether the specified Locale object is the default object for the group. Locale objects are grouped according to the language they represent.</p>"
        },
        "localeCode":{
            "type":"string",
            "description":"<p>The unique code that represents the language and country associated with the Locale object.</p>"
        },
        "localeDesc":{
            "type":"string",
            "description":"<p>The description about the language and country that the Locale object represents.</p>"
        },
        "localeValue":{
            "type":"integer",
            "description":"<p>The Locale ID value for the language and country that the Locale object represents.</p>"
        },
        "timeFormat":{
            "type":"string",
            "description":"<p>The prescribed format for displaying time to the end users associated with the Locale object. The prescribed format class is <code>com.webobjects.foundation.NSTimestampFormatter</code>.</p>"
        },
        "timeFormatDisplay":{
            "type":"string",
            "description":"<p>The prescribed format in which time appears in the displayed content. The prescribed format class is <code>java.text.DateFormat</code>.</p>"
        },
        "language":{
            "$ref":"#/definitions/LanguageKey",
            "description":"<p>The Language object with which the Locale object is associated.  The language is of type languageKeyBO and will generally be addressed using the recordId subfield.  For example language.recordId eq 'en'</p>"
        },
        "spellCheckingAlternateLocale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"<p>The Locale object with which the Locale object is associated for speller purposes.  The language is of type localeKeyBO and will generally be addressed using the recordId subfield.  For example locale.recordId eq 'en'</p>"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/instanceLink"
    }
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

• href: string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
• mediaType(optional): string
  Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  HTTP method for requesting the target of the link.
• profile(optional): string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel: string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
• templated(optional): boolean
  Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : LanguageKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object LanguageKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Language object.</p>"
                }
            }
        }
    ]
}

Nested Schema : LanguageKey-allOf[1]

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the Language object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Language object.</p>"
        }
    }
}

Back to Top

Examples

The following example shows how to find the Locale object specified by the ID parameter by submitting a get request on the REST resource using cURL.

cURL Command

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/locales/{id}"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
-H "Accept: application/json"

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "active" : true,
  "dateAdded" : "2013-04-23T21:06:42EDT",
  "dateFormat" : "DATEFORMAT_VALUE",
  "dateFormatDisplay" : "DATEFORMATDISPLAY_VALUE",
  "dateModified" : "2013-04-23T21:06:42EDT",
  "encoding" : "UTF-8",
  "groupDefault" : true,
  "localeCode" : "en_US",
  "localeDesc" : "English United States",
  "localeValue" : 1033,
  "timeFormat" : "%I:%M %p",
  "timeFormatDisplay" : "hh:mm",
  "language" : {
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
    } ]
  },
  "recordId" : "en_US",
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
    "mediaType" : "application/json, application/xml",
    "templated" : true,
    "method" : "GET",
    "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
  } ]
}

Back to Top