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

機械翻訳について

ユーザー・キー値の取得

get

/km/api/v1/users/{userId}/userKeyValues/{id}

このメソッドは、指定されたユーザー・キー値IDを持つUserKeyValueオブジェクトを返します。

URIの例

このメソッドのURIの例は、次のとおりです:

http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues/{id}
このリクエストは、指定されたIDパラメータを持つUserKeyValueオブジェクトを返します。

レスポンス・エラー

このメソッドの考えられるエラー・レスポンスは次のとおりです:

OKDOM-GEN0001
このエラーは、指定したIDのUserKeyValueオブジェクトが存在しない場合に発生します。

リクエスト

パス・パラメータ

id: string

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

トップに戻る

レスポンス

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

application/json
application/xml

200 レスポンス

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

ルート・スキーマ : UserKeyValue

タイプ: object

タイトル: UserKeyValue

ソースを表示

dateAdded(optional): string(date-time)

UserKeyValueオブジェクトが作成された日付。
dateModified(optional): string(date-time)

UserKeyValueオブジェクトが最後に変更された日付。
key(optional): string

UserKeyValueオブジェクトに関連付けられたキー。このフィールドは、ユーザーの値フィールドに関連付けられています。 FAVORITESは鍵の例です。
links(optional): array links
recordId(optional): string

userKeyValueリソースを表す一意の識別子。
userInformation(optional): object UserKey

タイトル: UserKey
value(optional): string

UserKeyValueオブジェクトに関連付けられた値。このフィールドは、ユーザーのキー・フィールドに関連付けられています。 FAQ1、FAQ23、FAQ44は値の例です。

{
    "title":"UserKeyValue",
    "properties":{
        "recordId":{
            "description":"The unique identifier that represents a userKeyValue resource.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the UserKeyValue object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "value":{
            "description":"The value associated with the UserKeyValue object. This field is related to the key field for a user. FAQ1, FAQ23, FAQ44 are example values.",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the UserKeyValue object was created.",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "userInformation":{
            "description":"The relationship between the user and object.",
            "$ref":"#/definitions/UserKey"
        },
        "key":{
            "description":"The key associated with the UserKeyValue object. This field is related to the value field for a user. FAVORITES is an example key.",
            "type":"string"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: UserKey

ソースを表示

email(optional): string

ユーザー・オブジェクトの電子メール
externalId(optional): integer

ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
externalType(optional): string

ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
links(optional): array links
name(optional): string

ユーザーのフルネーム
recordId(optional): string

ユーザー・オブジェクトの一意のレコードID。

{
    "title":"UserKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the User object.",
            "type":"string"
        },
        "externalType":{
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"string"
        },
        "email":{
            "description":"Email of the User object",
            "type":"string"
        },
        "name":{
            "description":"User's full name",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"integer"
        }
    }
}

ネストされたスキーマ : 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"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定したユーザーIDのユーザー・キー値オブジェクトを検索する方法を示しています。

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

レスポンス本文の例

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

{
  "userInformation": {
    "recordId": "62AE91CBB23A49668BC7B9A220B696C7",
    "name": "User Name Value",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "recordId": "75F56044C4D94DC181CDA898D0F0B3E2",
  "links": [
    {
      "rel": "canonical",
      "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues/75F56044C4D94DC181CDA898D0F0B3E2",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "collection",
      "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "dateAdded": "2017-03-28T14:48:21-0500",
  "dateModified": "2017-03-28T14:48:21-0500",
  "key": "FAVORITES2",
  "value": "FAQ1,FAQ23,FAQ44"
}

「トップに戻る」