機械翻訳について
  1. Oracle Fusionサービスでのナレッジ管理のREST API
  2. タスク
  3. コンテンツ(IM)
  4. ユーザー・キー値

ユーザー・キー値の作成

post

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

このメソッドは、Oracle KnowledgeリポジトリにUserKeyValueオブジェクトを作成します。

UserKeyValueオブジェクトは、ユーザーとオブジェクト間の関係を表すために使用できます。 たとえば、UserKeyValueオブジェクトを使用して、webアプリケーションを使用するREST APIを使用して、ユーザーのお気に入りドキュメントを保存できます。


URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues

    このリクエストは、Oracle Knowledgeリポジトリに新しいUserKeyValueオブジェクトを作成します。

レスポンス・エラー

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

  • OK-GEN0005

    次のいずれかの場合にエラーが発生します:

    • 指定されたIDのユーザー・レコードが存在しません。
    • userKeyValue.key、ユーザー情報またはuserinformation.reocrdIdのパラメータ値はnullです。

  • OKDOM-USERKV0001

    このエラーは、ユーザーが同じキーを持つ既存のUserKeyValueをすでに持っている場合に発生します。

  • OKDOM-USERKV0002

    このエラーは、指定したユーザー・レコードIDがuserinformation.recordIdパラメータ値と一致しない場合に発生します。

リクエスト

サポートされるメディア・タイプ
本文( )
作成するオブジェクト。
ルート・スキーマ : UserKeyValue
タイプ: object
タイトル: UserKeyValue
ソースを表示
ネストされたスキーマ : UserKey
タイプ: object
タイトル: UserKey
ソースを表示
  • ユーザー・オブジェクトの電子メール
  • ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
  • ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
  • links
  • ユーザーのフルネーム
  • ユーザー・オブジェクトの一意のレコードID。
トップに戻る

レスポンス

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

201 レスポンス

作成された。
本文( )
ルート・スキーマ : UserKeyValue
タイプ: object
タイトル: UserKeyValue
ソースを表示
ネストされたスキーマ : UserKey
タイプ: object
タイトル: UserKey
ソースを表示
  • ユーザー・オブジェクトの電子メール
  • ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
  • ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
  • links
  • ユーザーのフルネーム
  • ユーザー・オブジェクトの一意のレコードID。
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するポスト・リクエストを発行することによって、Oracle Knowledgeリポジトリにユーザー・キー値オブジェクトを作成する方法を示しています。

curl -X POST "https://<IM_REST_API_HOST>/km/api/latest/users/{userId}/userKeyValues" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています:

{
  "userInformation" : {
    "recordId" : "62AE91CBB23A49668BC7B9A220B696C7",
    "name" : "User_Name",
    "externalId" : 12345,
    "externalType" : "CONTACT",
    "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}"
    } ]
  },
  "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}"
  } ],
  "dateAdded" : "2013-04-23T20:06:43-0500",
  "dateModified" : "2013-04-23T20:06:43-0500",
  "key" : "FAVORITES2",
  "value" : "FAQ1,FAQ23,FAQ44"
}

レスポンス本文の例

次の例は、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"
}
「トップに戻る」