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

割り当てられたすべてのユーザー・グループの取得

get

/km/api/v1/views/{id}/userGroups

このメソッドは、指定されたIDパラメータを持つビュー・オブジェクトに関連付けられているUserGroupオブジェクトのリストを返します。

このリソースは、orderByリクエスト・パラメータをサポートしています。このパラメータをHTTPサービス・リクエストとともに使用して、返されたリストをソートできます。

orderByパラメータで使用できる追加の値については、リソースのスキーマおよびカタログを取得する必要があります。リソースのスキーマおよびカタログを取得するには、HTTPリクエストでmediaType値をapplication/schema+jsonとしてGETメソッドを使用する必要があります。

リソースのスキーマおよびカタログを取得するURIの例を次に示します:

http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/userGroups

URIの例:

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

http://<IM_REST_API_HOST>/km/api/latest/views/{id}/userGroups
このメソッドは、指定されたIDパラメータを持つビュー・オブジェクトに関連付けられているUserGroupオブジェクトのリストを参照キーでソートして昇順で返します。
http://<IM_REST_API_HOST>/km/api/latest/views/{id}/userGroups?orderBy=referenceKey:desc
このメソッドは、指定されたIDパラメータを持つビュー・オブジェクトに関連付けられているUserGroupオブジェクトのリストを、参照キーでソートして降順で返します。

リクエスト

パス・パラメータ

id: string

ビュー・オブジェクトの一意の識別子

トップに戻る

レスポンス

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

application/json
application/xml

200 レスポンス

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

ルート・スキーマ : ResultList UserGroupKey

タイプ: object

タイトル: ResultList UserGroupKey

ソースを表示

count(optional): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(optional): boolean

サーバーで使用可能なリソースが現在のページで返されたサブセットよりも多い場合にtrueに設定されるブール値。
items(optional): array items
limit(optional): integer

サーバーが使用する実際のページング・サイズ。
links(optional): array links
offset(optional): integer

現在のページで使用される相殺値。
totalResults(optional): integer

現在の範囲内のインスタンスと、リクエストを満たすサーバー上のインスタンスの両方を含む、リソース・インスタンスの合計数。

{
    "title":"ResultList UserGroupKey",
    "properties":{
        "hasMore":{
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page.",
            "type":"boolean"
        },
        "limit":{
            "description":"Actual paging size used by the server.",
            "type":"integer"
        },
        "count":{
            "description":"Number of resource instances returned in the current range.",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.",
            "type":"integer"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/UserGroupKey"
            },
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "offset":{
            "description":"Offset value used in the current page. ",
            "type":"integer"
        }
    },
    "type":"object"
}

ネストされたスキーマ : アイテム

タイプ: array

ソースを表示

Array of: object UserGroupKey

タイトル: UserGroupKey

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: UserGroupKey

ソースを表示

externalId(optional): integer

外部システムからの対応するuserGroupの一意の識別子。外部IDをExternalTypeパラメータとともに使用して、内部および外部システム内のユーザー・グループを接続できます。
externalType(optional): string

ExternalTypeは、外部システムからの対応するuserGroupのタイプです。
links(optional): array links
name(optional): string

ユーザー・グループのローカライズされた名前。名前フィールドはソートにのみ使用できます。
recordId(optional): string

userGroupsリソースを表すTAG表の一意の識別子
referenceKey(optional): string

ユーザー・グループのローカライズされていない名前
stripeCD(optional): string

UserGroupのストライプ

{
    "title":"UserGroupKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>",
            "type":"string"
        },
        "externalType":{
            "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The non localized name of the user group</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe for UserGroup</p>",
            "type":"string"
        },
        "externalId":{
            "description":"<p>The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.</p>",
            "type":"integer"
        }
    }
}

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

タイプ: 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リソースに対する取得リクエストを発行することによって、指定されたビュー・オブジェクトに関連付けられたユーザー・グループ・オブジェクトのリストを検索する方法を示しています。

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

レスポンス本文の例

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

{
  "items": [],
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "http://IM_REST_API_HOST/km/api/latest/views/C3643883234B4B319793840918246A31/userGroups?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 0
}

「トップに戻る」