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

ユーザーの取得

get

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

このメソッドは、一意の識別子でユーザー・オブジェクトを返します。 現在、一意の識別子はレコードIDまたはログインです。

ノート: 他のユーザーのユーザー・オブジェクトを検索するには、VIEW_USER権限を持っているか、リポジトリの管理者である必要があります。 VIEW_USER権限がない場合でも、一意の識別子を使用して独自のユーザー・オブジェクト情報を取得できます。

URIの例

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

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

    このリクエストはユーザー・ビジネス・オブジェクト・データ・オブジェクトを返します。

レスポンス・エラー

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

  • OK-SEC0001

    このエラーは、ユーザーにVIEW_USER権限がなく、別のユーザーのユーザー・オブジェクトの取得を試行した場合に発生します。

リクエスト

パス・パラメータ
  • 取得するオブジェクトの一意の識別子。
トップに戻る

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : ユーザー
タイプ: object
タイトル: User
ソースを表示
ネストされたスキーマ : contentLocales
タイプ: array
ロケールと多数の関係
ソースを表示
ネストされたスキーマ : customKeyValues
タイプ: array
UserKeyValueとの関係が多すぎます
ソースを表示
ネストされたスキーマ : dataFormNotifications
タイプ: array
評点と多数の関係
ソースを表示
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
ネストされたスキーマ : ViewKey
タイプ: object
タイトル: ViewKey
ソースを表示
ネストされたスキーマ : UserGroupKey
タイプ: object
タイトル: UserGroupKey
ソースを表示
ネストされたスキーマ : securityRoles
タイプ: array
SecurityRoleとの関係が多すぎます
ソースを表示
ネストされたスキーマ : スキル
タイプ: array
カテゴリと多数の関係
ソースを表示
ネストされたスキーマ : サブスクリプション
タイプ: array
サブスクリプションと多数の関係
ソースを表示
ネストされたスキーマ : ビュー
タイプ: array
表示する関係が多すぎます
ソースを表示
ネストされたスキーマ : workTeams
タイプ: array
WorkTeamとの多数の関係
ソースを表示
ネストされたスキーマ : UserKeyValueKey
タイプ: object
タイトル: UserKeyValueKey
ソースを表示
ネストされたスキーマ : RatingKey
タイプ: object
タイトル: RatingKey
ソースを表示
ネストされたスキーマ : SecurityRoleKey
タイプ: object
タイトル: SecurityRoleKey
ソースを表示
  • ExternalIdは、外部システムからの対応するロールのIDです。 ExternalTypeとともに使用すると、このシステムのセキュリティ・ロールと外部システムのオブジェクトとの間のギャップを埋めることができます。 RightNowモードの場合、外部IDは、外部タイプがRN_PROFILEに設定されている場合にのみ、RightNowプロファイルIDを表します。 外部IDは、外部タイプがRN_WEB_ROLEに設定されている場合にのみ、RightNowアクセスIDを表すこともできます。
  • ExternalTypeは、外部システムからの対応するロールのタイプです。 ExternalIdとともに使用すると、このシステムのセキュリティ・ロールと外部システムのオブジェクトとの間のギャップを埋めることができます。 RightNowモードの場合、許可されるタイプはRN_PROFILEおよびRN_WEB_ROLEのみです。
  • links
  • SECURITYROLE表のGUID
  • セキュリティ・ロールのローカライズされていない名前
  • 許可された値: [ "SITE_ADMINISTRATOR_ROLE", "SUPER_ADMIN", "SUPER_SUPPORT", "CONSOLE_ROLE", "WEB_ROLE", "INTEGRATION_ROLE" ]
    このセキュリティ・ロールのタイプを返します。 有効なタイプはwebロールとコンソール・ロールです
ネストされたスキーマ : CategoryKey
タイプ: object
タイトル: CategoryKey
ソースを表示

  • このフィールドには、カテゴリの直下の子の数が返されます。

    このフィールドは、childrenCount問合せパラメータが値trueで渡された場合にのみ移入されます。

    このパラメータのURIの例は次のとおりです:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
  • カテゴリ・オブジェクトの説明

  • リポジトリ・データを外部システムと統合する際に使用される一意の識別子。

  • リポジトリ・データを外部システムと統合する際に使用されるカテゴリのタイプ。 有効なオプションは、PRODUCTおよびCATEGORYです。

  • 特定の製品の在庫組織ID。

  • links

  • カテゴリの名前。

  • カテゴリの階層位置
  • parents

    このフィールドは、カテゴリのすべての親を返します。

    このフィールドは、withParents問合せパラメータが値trueで渡された場合にのみ移入されます。

    このパラメータのURIの例は次のとおりです:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY

  • カテゴリ・オブジェクトの一意のレコードID。

  • カテゴリ・オブジェクトの参照キー。 カテゴリ・オブジェクトは複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

  • これは、翻訳された名前が見つからない場合に名前がデフォルト・ロケールに変換される場合に移入されるカスタム・フィールドです。

ネストされたスキーマ : 両親
タイプ: array

このフィールドは、カテゴリのすべての親を返します。

このフィールドは、withParents問合せパラメータが値trueで渡された場合にのみ移入されます。

このパラメータのURIの例は次のとおりです:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
ソースを表示
ネストされたスキーマ : SubscriptionKey
タイプ: object
タイトル: SubscriptionKey
ソースを表示
ネストされたスキーマ : WorkTeamKey
タイプ: object
タイトル: WorkTeamKey
ソースを表示
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、一意の識別子でユーザー・オブジェクトを検索する方法を示しています。

cURLコマンドの例

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

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "skills": [],
  "customKeyValues": [],
  "contentLocales": [],
  "securityRoles": [],
  "subscriptions": [],
  "dataFormNotifications": [],
  "views": [],
  "workTeams": [],
  "userType": "CONSOLE_USER",
  "recordId": "62AE91CBB23A49668BC7B9A220B696C7",
  "name": "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"
    },
    {
      "rel": "collection",
      "href": "http://IM_REST_API_HOST/km/api/latest/users",
      "mediaType": "application/json, application/xml",
      "method": "GET",
      "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/users"
    }
  ],
  "isActive": false,
  "isLocked": false,
  "adminUser": true,
  "alias": "ALIAS_VALUE",
  "banUser": false,
  "dateAdded": "2017-03-16T09:11:58-0500",
  "dateModified": "2017-03-16T09:11:58-0500",
  "email": "EMAIL_VALUE",
  "firstName": "FIRSTNAME_VALUE",
  "isDefaultAdministrator": true,
  "lastName": "LASTNAME_VALUE",
  "login": "LOGIN_VALUE",
  "canReceiveEmailNotificationsForAssignedTasks": false,
  "canReceiveEmailNotificationsForTasksICanPerform": false,
  "reputationPoints": 0,
  "showEmail": true,
  "showName": true,
  "subscribeOnTopicCreation": true,
  "subscribeOnTopicReply": true,
  "subscriptionSchedule": -1,
  "defaultLocale": {
    "recordId": "en_US",
    "links": [
      {
        "rel": "canonical",
        "href": "http://IM_REST_API_HOST/km/api/latest/locales/en_US",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  }
}
「トップに戻る」