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

すべてのビューの取得

get

/km/api/v1/views

このメソッドは、Oracle Knowledge RepositoryからViewオブジェクトのリストを返します。

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

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

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

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

問合せで検索

サポートされているメディア・タイプ: 'application/json', 'application/xml'


このメソッドは、指定された基準に一致するビュー・オブジェクトのリストを返します。

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

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

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

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/views
問合せパラメータ

次の表では、このリソースの問合せパラメータについて説明します。

パラメータ問合せ可能ソート可能タイプ説明
recordIdYY'type' : 'string'ビュー定義を含むSITE表のGUID
referenceKeyYY'type' : 'string'ビューのローカライズされていない参照キー
nameNY'type' : 'string'ビューのローカライズ名
stripeCDNY'type' : 'string'

ビューのストライプ

dateAddedYY'type' : 'string', 'format' : 'date-time'ビューが作成されたときのタイムスタンプ
dateModifiedYY'type' : 'string', 'format' : 'date-time'ビューの最終変更時のタイムスタンプ
親YN'$ref' : '#/definitions/ViewKey'現在のビューの親への参照
categoriesYN'$ref' : '#/definitions/ListCategoryKey'ビューに割り当てられたカテゴリのリスト
userGroupsYN'$ref' : '#/definitions/ListUserGroupKey'このビューに割り当てられたユーザー・グループのリスト

リクエスト

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

レスポンス

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

200 レスポンス

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

例

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

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/views" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"

レスポンス本文の例

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

{
  "items": [
    {
      "dateAdded": "1970-01-01T23:11:11-0800",
      "dateModified": "2017-04-24T17:41:32-0700",
      "objectId": "001.001",
      "recordId": "BBA181DFB52148779A416184A191B2AF",
      "referenceKey": "SERVICE",
      "name": "Service",
      "links": [
        {
          "rel": "parent",
          "href": "http://IM_REST_API_HOST/km/api/latest/views/FBA17E28CAAB4A7387A44BEE77240E33",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "canonical",
          "href": "http://IM_REST_API_HOST/km/api/latest/views/BBA181DFB52148779A416184A191B2AF",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "http://IM_REST_API_HOST/km/api/latest/views",
          "mediaType": "application/json, application/xml",
          "method": "GET",
          "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/views"
        }
      ]
    },
    {
      "dateAdded": "1970-01-01T23:11:11-0800",
      "dateModified": "2017-04-13T05:30:07-0700",
      "objectId": "001.002",
      "recordId": "B6AD9BA886A743D2B5CB9A1DE2CE7D00",
      "referenceKey": "HCM",
      "name": "HCM",
      "links": [
        {
          "rel": "parent",
          "href": "http://IM_REST_API_HOST/km/api/latest/views/FBA17E28CAAB4A7387A44BEE77240E33",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "canonical",
          "href": "http://IM_REST_API_HOST/km/api/latest/views/B6AD9BA886A743D2B5CB9A1DE2CE7D00",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "http://IM_REST_API_HOST/km/api/latest/views",
          "mediaType": "application/json, application/xml",
          "method": "GET",
          "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/views"
        }
      ]
    },
   ],
  "hasMore": false,
  "limit": 20,
  "offset": 0,
  "links": [
    {
      "rel": "canonical",
      "href": "http://IM_REST_API_HOST/km/api/latest/views?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 2
}
「トップに戻る」