Oracle Fusionサービスでのナレッジ管理のREST API

機械翻訳について

ロケールの取得

get

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

このメソッドは、IDパラメータで指定されたLocaleオブジェクトを返します。

URIの例

このメソッドのURIの例を次に示します:

http://<IM_REST_API_HOST>/km/api/latest/locales/{id}
このメソッドは、指定されたIDパラメータを持つLocaleオブジェクトをFULLモードで返します。
http://<IM_REST_API_HOST>/km/api/latest/locales/{id}?mode=KEY
このメソッドは、KEYモードで指定されたIDパラメータを持つLocaleオブジェクトを返します。

リクエスト

パス・パラメータ

id: string

取得するオブジェクトの一意の識別子。

トップに戻る

レスポンス

サポートされるメディア・タイプ

application/json
application/xml

200 レスポンス

「OK」をクリックします。

ルート・スキーマ : 言語

タイプ: object

タイトル: Locale

ソースを表示

active(optional): boolean

このフラグは、LocaleオブジェクトがOracle Knowledgeシステムでアクティブかどうかを示します。
dateAdded(optional): string(date-time)

Localeオブジェクトが追加または作成された日付。
dateFormat(optional): string

ロケール・オブジェクトに関連付けられているエンド・ユーザーに日付を表示するための規定の書式。規定された書式クラスは、com.webobjects.foundation.NSTimestampFormatterです。
dateFormatDisplay(optional): string

表示されたコンテンツに日付が表示される規定の書式。規定された書式クラスは、java.text.DateFormatです。
dateModified(optional): string(date-time)

ロケール・オブジェクトが最後に変更された日付。
encoding(optional): string

言語での文字の表示に使用される規定エンコーディング形式。
groupDefault(optional): boolean

このフラグは、指定されたLocaleオブジェクトがグループのデフォルト・オブジェクトであるかどうかを示します。ロケール・オブジェクトは、それらが表す言語に従ってグループ化されます。
language(optional): object LanguageKey

タイトル: LanguageKey
links(optional): array links
localeCode(optional): string

Localeオブジェクトに関連付けられている言語および国を表す一意のコード。
localeDesc(optional): string

Localeオブジェクトが表す言語と国に関する説明。
localeValue(optional): integer

Localeオブジェクトが表す言語と国のロケールIDの値。
recordId(optional): string

ロケール・オブジェクトの一意の識別子。
timeFormat(optional): string

Localeオブジェクトに関連付けられているエンド・ユーザーに時間を表示するための規定の書式。規定された書式クラスは、com.webobjects.foundation.NSTimestampFormatterです。
timeFormatDisplay(optional): string

表示されたコンテンツに時間が表示される規定の書式。規定された書式クラスは、java.text.DateFormatです。

{
    "title":"Locale",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Locale object.</p>",
            "type":"string"
        },
        "groupDefault":{
            "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>",
            "type":"boolean"
        },
        "localeValue":{
            "description":"<p>The Locale ID value for the language and country that the Locale object represents.</p>",
            "type":"integer"
        },
        "dateModified":{
            "description":"<p>The date when the Locale object was last modified.</p>",
            "format":"date-time",
            "type":"string"
        },
        "timeFormat":{
            "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>",
            "type":"string"
        },
        "localeDesc":{
            "description":"<p>The description about the language and country that the Locale object represents.</p>",
            "type":"string"
        },
        "dateAdded":{
            "description":"<p>The date when the Locale object was added or created.</p>",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "localeCode":{
            "description":"<p>The unique code that represents the language and country associated with the Locale object.</p>",
            "type":"string"
        },
        "timeFormatDisplay":{
            "description":"<p>The prescribed format in which time appears in the displayed content. The prescribed format class is <code>java.text.DateFormat</code>.</p>",
            "type":"string"
        },
        "encoding":{
            "description":"<p>The prescribed encoding format used to display characters in the language.</p>",
            "type":"string"
        },
        "active":{
            "description":"<p>The flag indicates whether the Locale object is active in the Oracle Knowledge system.</p>",
            "type":"boolean"
        },
        "dateFormat":{
            "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>",
            "type":"string"
        },
        "language":{
            "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>",
            "$ref":"#/definitions/LanguageKey"
        },
        "dateFormatDisplay":{
            "description":"<p>The prescribed format in which dates appears in the displayed content. The prescribed format class is <code>java.text.DateFormat</code>.</p>",
            "type":"string"
        }
    }
}

ネストされたスキーマ : LanguageKey

タイプ: object

タイトル: LanguageKey

ソースを表示

links(optional): array links
recordId(optional): string

Languageオブジェクトの一意の識別子。

{
    "title":"LanguageKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Language object.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

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

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

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

ネストされたスキーマ : instanceLink

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

href: string

URI [RFC3986]またはURIテンプレート[RFC6570]。値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
mediaType(optional): string

RFC 2046で定義された、リンク・ターゲットを説明するメディア・タイプ。
method(optional): string

リンクのターゲットをリクエストするためのHTTPメソッド。
profile(optional): string

ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
rel: string

リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。たとえば、hrefやprofileです。
templated(optional): boolean

hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。プロパティがURIテンプレートの場合は、この値をtrueに設定します。デフォルトでは、この値はfalseです。

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "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"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "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"
        },
        "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"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "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"
    ],
    "type":"object"
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定されたIDパラメータを持つLocaleオブジェクトを検索する方法を示しています。

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

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/locales/{id}" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

{
    "recordId": "sk_SK",
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/locales/sk_SK",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "collection",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/locales",
            "mediaType": "application/json, application/xml",
            "method": "GET",
            "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/locales"
        }
    ],
    "active": true,
    "dateAdded": "1970-01-01T23:11:11+0000",
    "dateFormat": "%d/%m/%Y",
    "dateFormatDisplay": "dd/mm/yyyy",
    "dateModified": "1970-01-01T23:11:11+0000",
    "encoding": "UTF-8",
    "groupDefault": true,
    "localeCode": "sk_SK",
    "localeDesc": "Slovak - Slovakia",
    "localeValue": 1051,
    "timeFormat": "%H:%M",
    "timeFormatDisplay": "HH:mm",
    "language": {
        "recordId": "sk",
        "links": [
            {
                "rel": "canonical",
                "href": "https://<IM_REST_API_HOST>/km/api/v1/languages/sk",
                "mediaType": "application/json, application/xml",
                "method": "GET"
            }
        ]
    }
}

「トップに戻る」