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

すべてのユーザー・グループの取得

get

/km/api/v1/userGroups

指定したオプション基準に一致するすべてのユーザー・グループを取得します。

リクエスト

問合せパラメータ
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、返されるリソースに含める情報の量を定義 - KEYは情報の最小化(したがって、パフォーマンスが向上)されており、FULLはほとんどの情報を持つ情報です。
    許可された値: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • このパラメータは、指定された属性に基づいてリソース・コレクションを順序付けします。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと'asc'または'desc'が続きます。 昇順には'asc'を指定し、降順には'desc'を指定します。 デフォルト値は'asc'です。 たとえば、?orderBy=field1:asc,field2:descです。
  • このパラメータの値はOracle Knowledge Q問合せである必要があります - この操作の『スタート・ガイド』ドキュメント(「問合せ」ページ)およびQ問合せのドキュメントを参照してください。
トップに戻る

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : ResultList UserGroupData
タイプ: object
タイトル: ResultList UserGroupData
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
ソースを表示
ネストされたスキーマ : UserGroupData
タイプ: object
タイトル: UserGroupData
ソースを表示
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、Oracle Knowledgeリポジトリからユーザー・グループ・オブジェクトのリストを検索する方法を示しています。

curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/userGroups"

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

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

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

レスポンス本文の例

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

{
    "items": [
        {
            "recordId": "8410EB4CB48C5E7CE05323BDF20A8468",
            "referenceKey": "EMPLOYEEHCM",
            "name": "Employee",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/userGroups/8410EB4CB48C5E7CE05323BDF20A8468",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/userGroups",
                    "mediaType": "application/json, application/xml",
                    "method": "GET",
                    "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/userGroups"
                }
            ],
            "dateAdded": "1970-01-01T23:11:11+0000",
            "dateModified": "1970-01-01T23:11:11+0000",
            "objectId": "-3",
            "description": "EMPLOYEE user group for the HCM Department",
            "stripeCd": "ORA_SVC_HCM"
        }
    ],
    "hasMore": true,
    "limit": 1,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/userGroups?limit=1&offset=0&langpref=en_US",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/userGroups?limit=1&offset=1&langpref=en_US",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 1
}
「トップに戻る」