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

すべての記事のステータスを取得

get

/km/api/v1/articleStatus

このメソッドは、ArticleStatusオブジェクトのリストを返します。

このリソースは、ArticleStatusオブジェクトの返されたリストをソートできるorderByリクエスト・パラメータをサポートしています。

スキーマ内のorderByパラメータとリソースのカタログ情報で使用する様々な値を検索できます。 スキーマおよびカタログ情報を取得するには、HTTPリクエストでmediaType値を'application/schema+json' としてGETメソッドを使用します。

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

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

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/latest/articleStatus

    リクエストは、DATAモードでArticleStatusオブジェクトのページ区切りリストを返します。 デフォルトでは、記事ステータス・オブジェクトは、オブジェクトが作成された日付の降順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/articleStatus?mode=KEY&limit=10&offset=20

    このリクエストは、KEYモードで記事ステータス・オブジェクトのリストの3番目のページを返します。 デフォルトでは、記事ステータス・オブジェクトは、オブジェクトが作成された日付の降順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/articleStatus?orderBy=name

    リクエストは、DATAモードでArticleStatusオブジェクトのページ区切りリストを返します。 記事ステータス・オブジェクトは、名前に従って昇順にソートされます。


問合せで検索

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


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

このリソースは、ArticleStatusオブジェクトの返されたリストをソートできるorderByリクエスト・パラメータをサポートしています。

スキーマ内のorderByパラメータとリソースのカタログ情報で使用する様々な値を検索できます。 スキーマおよびカタログ情報を取得するには、HTTPリクエストでmediaType値を'application/schema+json' としてGETメソッドを使用します。

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

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

URIの例

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

  • http://<IM_REST_API_HOST>/km/api/articleStatus?q=dateAdded after '2015-01-01'&orderBy=dateAdded&limit=10&offset=20

    このリクエストは、2015年1月1日より後に追加されたDATAモードで記事ステータス・オブジェクトのリストの3番目のページを返します。 リスト内のオブジェクトは、最後に追加された日付でソートされます。

  • http://<IM_REST_API_HOST>/km/api/latest/articleStatus?q=active eq 'true'&mode=KEY

    このリクエストは、KEYモードでアクティブな記事ステータス・オブジェクトのページ区切りリストを返します。 デフォルトでは、記事ステータス・オブジェクトは、オブジェクトが作成された日付の降順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/articleStatus?q=referenceKey in ('DRAFT', 'WORK_IN_PROGRESS', 'TECHNICAL_REVIEW')

    リクエストは、これらの参照キー値のいずれかを持つ、データ・モードの項目ステータス・オブジェクトのページ区切りリストを返します: DRAFT, WORK_IN_PROGRESS, TECHNICAL_REVIEW. リスト内のオブジェクトは、オブジェクトが作成された日付の降順にソートされます。

問合せパラメータ

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

パラメータ問合せ可能ソート可能タイプ説明
recordIdYY'type' : 'string'

ArticleStatusオブジェクトの一意の識別子。

referenceKeyYY'type' : 'string'

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

nameNY'type' : 'string'

ArticleStatusオブジェクトのローカライズされた名前。 名前フィールドはソートにのみ使用できます。

dateAddedYY'type' : 'string', 'format' : 'date-time'

ArticleStatusオブジェクトが作成または追加された日付。

dateModifiedYY'type' : 'string', 'format' : 'date-time'

ArticleStatusオブジェクトが最後に変更された日付。

アクティブYY'type' : 'boolean'

このパラメータを使用して、ArticleStatusオブジェクトがシステムでアクティブまたは非アクティブである場合に、それらをフィルタできます。

リクエスト

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

レスポンス

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

200 レスポンス

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

例

次の例は、ArticleStatusオブジェクトのリストを取得する方法を示しています。

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/articleStatus"

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

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

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

レスポンス本文の例

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

{
    "items": [
        {
            "recordId": "DF4F09BD045D4E9ABC5DC5B7601C88C2",
            "referenceKey": "NEW_ARTICLE_STATUS",
            "name": "New Article Status",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/articleStatus/DF4F09BD045D4E9ABC5DC5B7601C88C2",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "https://<IM_REST_API_HOST>/km/api/v1/articleStatus",
                    "mediaType": "application/json, application/xml",
                    "method": "GET",
                    "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/articleStatus"
                }
            ],
            "dateAdded": "2019-04-11T07:23:25+0000",
            "dateModified": "2019-04-11T07:23:27+0000",
            "active": true
        }
    ],
    "hasMore": true,
    "limit": 1,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/articleStatus?limit=1&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/articleStatus?limit=1&offset=1",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 1
}
「トップに戻る」