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

コンテンツの更新

put

/km/api/v1/content/{id}

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

このメソッドは、マスター・ロケールまたはその他のロケール(コンテンツがすでに翻訳されているもの)のコンテンツを更新します。 このメソッドは、マスター・ロケール以外の新しいロケールで翻訳を作成します。

コンテンツ・レコードの更新時に、サービスは、XML入力内のユーザー・インタフェース・フィールドのネストされた条件コンテンツを含む条件コンテンツを検証します。

コンテンツ・レコードを更新する場合、ユーザーはReasonForEditをプレーン・テキストとしてのみペイロードに追加できます(HTMLまたはJavaScriptは受け入れません)

ノート : このフィールドは、Get/Contentでは表示されません。 コンテンツ履歴の取得時にコメントとして使用できます。

コンテンツ・セキュリティ

このサービスでは、ログイン・ユーザーのセキュリティ・ロール権限を使用して、ユーザーがコンテンツ・タイプの変更権限を持っているかどうかが判断されます。 コンテンツは、ユーザーに変更権限がある場合にのみ作成されます。 ロケールはユーザーのデフォルト・ロケールとして指定する必要があります。指定しない場合、サービスはエラーを返します。


添付ファイルによるコンテンツの更新

サポートされているメディア・タイプ: 'multipart/form-data'


添付ファイルを含むコンテンツ・レコードを更新できます。 コンテンツ・レコードの更新時に、既存の添付のファイルを渡す必要はありません。 HTTPリクエストで更新されたビジネス・オブジェクトを渡すだけで、サービスによってコンテンツ・レコードが更新され、以前のファイル添付が最新バージョンのコンテンツ・レコードに関連付けられます。 最新のコンテンツ・レコードにまだ関連付けられていない新規ファイルを添付する場合、サービスでは、コンテンツ・レコードにすでに関連付けられている添付ファイルがコピーされ、新規ファイル添付が最新のコンテンツ・レコードに関連付けられます。

コンテンツ・レコードを新しい添付で更新するには、コンテンツXMLペイロードで添付ファイルのファイル・ノードを指定し、そのファイルをリクエストのFILEPARTに渡す必要があります。

コンテンツに複数の添付ファイルがある場合は、ファイルごとにファイル・ノードを繰り返す必要があります。

以前のバージョンのファイル添付を削除する必要がある場合は、そのファイル添付のファイル・ノードをコンテンツxmlから削除できます。

いずれかの添付ファイルを以前のバージョンと同じにする必要がある場合は、それらの添付ファイルのファイル・ノードを、そのIDノードを含むcontent xmlに保持する必要があります。 また、FILEPARTには変更ファイルが渡されないため、。

ファイル・ノードの詳細を次に示します:

ノード必須説明
KM_ATTACHMENTS_ATTRYES各ファイル添付のルート・ノード。
FILEYES添付のファイル詳細の親ノード。
IDNOこれは、ファイルの一意の識別子です。 コンテンツが作成されると、このフィールドには、新規アップロード済ファイルのファイル参照が移入されます。
  • 添付として使用されるファイルは、FILEPARTで渡す必要があります。
  • 以前のバージョンからのファイルに変更がない場合、ファイルはFILEPARTで渡されず、以前のバージョンのIDノードはcontent xmlで渡す必要があります。これは、添付と同じファイルを使用することを示します。
  • このバージョンでファイルを削除する必要がある場合は、完全なFILEノードをcontent xmlから削除する必要があります。
FILENAMEYES添付ファイルの名前。 この名前は、FILEPARTにアップロードされたファイルの名前と一致する必要があります。
TITLENO添付ファイルのタイトルが渡されていない場合は、ファイル名にデフォルト設定されます。
DESCRIPTIONYES添付ファイルの説明。

「次に、最小ペイロードexamples(using one file attachment)を示します。」

XMLの例: 
 
<Content>
   <recordId>CONTENT_RECORD_ID</recordId>
   <versionId>CONTENT_VERSION_ID</versionId>
   <documentId>CONTENT_DOCUMENT_ID</documentId>
   <version>CONTENT_VERSION</version>
   <answerId>CONTENT_ANSWER_ID</answerId>
   <locale>
      <recordId>LOCALE_CODE</recordId>
   </locale>
   <dateModified>2018-05-30T07:52:23-0700</dateModified>
   <contentType>
      <recordId>CONTENT_TYPE_RECORD_ID</recordId>
      <referenceKey>CONTENT_TYPE_REF_KEY</referenceKey>
      <name>CONTENT_TYPE_NAME</name>
   </contentType>
   <createDate>2018-05-30T07:52:23-0700</createDate>
   <lastModifiedDate>2018-05-30T07:52:23-0700</lastModifiedDate>
   <dateAdded>2018-05-30T07:52:23-0700</dateAdded>
   <displayStartDate>1900-01-01T03:00:00-0500</displayStartDate>
   <displayEndDate>9999-12-31T03:00:00-0500</displayEndDate>
   <owner>
      <recordId>OWNER_RECORD_ID</recordId>
      <name>OWNER_NAME</name>
      <email>OWNER_EMAIL</email>
      <externalType>ACCOUNT</externalType>
   </owner>
   <published>false</published>
   <pending>false</pending>
   <checkedOut>false</checkedOut>
   <xml>
      <CONTENT_TYPE_REF_KEY>
         <KM_ATTACHMENTS_ATTR>
            <FILE>
               <ID>
                  <![CDATA[DOCUMENT_ID]]>
               </ID>
               <FILENAME>
                  <![CDATA[FILE_NAME]]>
               </FILENAME>
               <TITLE>
                  <![CDATA[OPTIONAL_FILE_TITLE]]>
               </TITLE>
               <DESCRIPTION>
                  <![CDATA[FILE_DESCRIPTION]]>
               </DESCRIPTION>
            </FILE>
         </KM_ATTACHMENTS_ATTR>
      </CONTENT_TYPE_REF_KEY>
   </xml>
   <isForEdit>true</isForEdit>
   <categories/>
   <userGroups/>
   <views>
      <ViewKey>
         <recordId>VIEW_RECORD_ID</recordId>
         <referenceKey>VIEW_REF_KEY</referenceKey>
         <name>VIEW_NAME</name>
      </ViewKey>
   </views>
</Content> 


JSON Example: 
{
   'recordId': 'CONTENT_RECORD_ID',
   'versionId': 'CONTENT_VERSION_ID',
   'documentId': 'CONTENT_DOCUMENT_ID',
   'version': 'CONTENT_VERSION',
   'answerId': 'CONTENT_ANSWER_ID',
   'locale': {
      'recordId': 'LOCALE_CODE'
   },
   'dateModified': '2018-05-30T07:52:23-0700',
   'contentType': {
      'recordId': 'CONTENT_TYPE_RECORD_ID',
      'referenceKey': 'CONTENT_TYPE_REF_KEY',
      'name': 'CONTENT_TYPE_NAME'
   },
   'createDate': '2018-05-30T07:52:23-0700',
   'lastModifiedDate': '2018-05-30T07:52:23-0700',
   'dateAdded': '2018-05-30T07:52:23-0700',
   'displayStartDate': '1900-01-01T03:00:00-0500',
   'displayEndDate': '9999-12-31T03:00:00-0500',
   'owner': {
      'recordId': 'OWNER_RECORD_ID',
      'name': 'OWNER_NAME',
      'email': 'OWNER_EMAIL',
      'externalType': 'ACCOUNT'
   },
   'published': 'false',
   'pending': 'false',
   'checkedOut': 'false',
   'xml': '<CONTENT_TYPE_REF_KEY><KM_ATTACHMENTS_ATTR><FILE><ID><![CDATA[DOCUMENT_ID]]></ID><FILENAME>
   <![CDATA[FILE_NAME]]></FILENAME><TITLE><![CDATA[OPTIONAL_FILE_TITLE]]></TITLE><DESCRIPTION><![CDATA[FILE_DESCRIPTION]]>
   </DESCRIPTION></FILE></KM_ATTACHMENTS_ATTR></CONTENT_TYPE_REF_KEY>',
   'isForEdit': 'true',
   'views': [{
      'recordId': 'VIEW_RECORD_ID',
      'referenceKey': 'VIEW_REF_KEY',
      'name': 'VIEW_NAME'
   }]
}

XMLファイルには、次の情報が含まれている必要があります:

  • 新しい添付のファイル名。
  • サービスが最新バージョンのコンテンツ・レコードにコピーする既存の添付のファイル名。

レスポンス・エラー

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

  • OKDOM-CONT0110

    このエラーは、条件セクションに無効なUserGroupオブジェクトを指定すると発生します。 条件セクションのUserGroupオブジェクトがマップされている場合にのみ、コンテンツにアクセスできます。

  • OK-FMS0005

    このエラーは、XMLファイルで指定されたファイル・ノードが、アップロードされたファイルと一致しない場合に発生します。

  • OKDOM-FMS0001

    このエラーは、新しい添付の名前と、リクエストとともに既存の添付ファイルの名前を指定しなかった場合に発生します。

  • OKDOM-CONT0202

    このエラーは、XMLで指定されたファイルの説明が最大サイズを超える場合に発生

  • OKDOM-SCHEMA0018

    XMLにファイルの説明が指定されていない場合にエラーが発生

  • OKDOM-CONT0203

    重複ファイルが添付されているときにエラーが発生

  • $ERROR.Content.INACTIVE_ARTICLE_STATUS_ASSIGNED$

    このエラーは、リクエストで指定されたContentUpdateBO.articleStatusが非アクティブである場合に発生します。

  • $ERROR.Content.ARTICLE_STATUS_FEATURE_NOT_AVAILABLE$

    このエラーは、リクエストでContentUpdateBO.articleStatusが指定され、記事ステータス機能が使用できない場合に発生します。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
  • 更新するオブジェクトの一意の識別子。
本文( )
更新するオブジェクト。
ルート・スキーマ : コンテンツ
タイプ: object
タイトル: Content
ソースを表示
  • allTranslations

    このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

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

  • アンサーとコンテンツ間のマッピングを可能にする一意の識別子。

  • ArticleStatusKey
    タイトル: ArticleStatusKey
  • LocaleKey
    タイトル: LocaleKey
  • コンテンツ・オブジェクトのバージョン
  • categories

    コンテンツに割り当てられたカテゴリ・オブジェクトまたはカテゴリ・オブジェクトのリスト。

    たとえば 世界がレベル1のカテゴリである場合、レベル2にアフリカ、ウクライナ、アメリカなどがある可能性があります。 カテゴリ内のオブジェクトのリクエストは、階層的または非階層的に指定できます。 フロリダが割り当てられているコンテンツが階層型のリクエスト・ワールドを使用してリクエストされると、結果が表示されます。 一方、同じリクエストが非階層的に実行されても、結果はありません。

    カテゴリ・パラメータを使用すると、単一構成と複数構成の両方で、結果を第1レベル・カテゴリおよび階層カテゴリでフィルタできます。

      いずれかと一致

      リクエストとともに contentType.refKey eqパラメータまたはcontentType.refKey inパラメータを渡すと、サービスはリクエストで指定されたカテゴリのいずれかに一致します。

      categoryパラメータのURIの例を次に示します:

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

      • OR

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

      • 次のURIの例は、指定したカテゴリのレベルに存在するコンテンツ・オブジェクトを返します。 これにより、子コンテンツ・オブジェクトは返されません。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

      • OR

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

      • 次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular

      次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent

      返されたリストのオブジェクトは、公開日に基づいてソートされます。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

      返されるリスト内のオブジェクトは、dateModifiedでソートされます。

      すべて一致

      リクエストとともに andcategories.refKey matchAll パラメータを渡すと、リクエストで指定されたすべてのカテゴリがサービスによって照合されます。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY

      このリクエストは、ワールドおよびムービー・カテゴリ内のすべてのコンテンツ・オブジェクトを返します。 アフリカはカテゴリworldの子カテゴリであるため、サービスはAfricaカテゴリのコンテンツ・オブジェクトを返します。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular

      返されたリストのオブジェクトは、ビューによって降順にソートされます。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

      返されたリストのオブジェクトは、公開された日付の降順でソートされます。

  • 作成者がドキュメントを編集のためにチェックアウトまたはロックした日付。

  • UserKey
    タイトル: UserKey
  • ContentTypeKey
    タイトル: ContentTypeKey

  • コンテンツが作成された日付。 レガシー・システムの場合、作成日は、それらのシステムでドキュメントが作成された日付です。

  • UserKey
    タイトル: UserKey

  • コンテンツがコンテンツ・タイプに追加された日付。 レガシー・システムの場合、作成日は、ドキュメントがレガシー・システムからOracle Knowledge Repositoryに移行された日付です。

  • Oracle Knowledge Repositoryでコンテンツが最後に変更された日付。

  • サービスがエンド・ユーザーへのドキュメントの表示を停止する日付。

  • 許可された値: [ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]
    Fixed@Top、Place@Top、Historical UsefulnessのLookUpコード

  • レビューを実行できる作成者によるレビューが文書に必要な日付。

  • 文書をエンドユーザーに表示できるようになる日付。

  • コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。

  • ドキュメントのイベントが終了する日付。

  • ドキュメントのイベントが開始する日付。

  • 編集可能なコンテンツをリクエストするパラメータ。

  • コンテンツが最後に変更された日付。 レガシー・システムの場合、lastModifiedDate日付は、これらのシステムでドキュメントが最後に変更された日付です。

  • UserKey
    タイトル: UserKey
  • ContentKey
    タイトル: ContentKey
  • links
  • LocaleKey
    タイトル: LocaleKey
  • コンテンツ・オブジェクトのMetaDataResourcePath
  • コンテンツ・オブジェクトのMetaDataXml
  • UserKey
    タイトル: UserKey

  • 文書が公開待ちかどうかを示すフラグ。

  • 許可された値: [ "PRIORITY_0", "PRIORITY_1", "PRIORITY_2", "PRIORITY_3", "PRIORITY_4", "PRIORITY_5", "PRIORITY_6", "PRIORITY_7", "PRIORITY_8", "PRIORITY_9", "PRIORITY_10", "PRIORITY_11", "PRIORITY_12", "PRIORITY_13", "PRIORITY_14", "PRIORITY_15", "PRIORITY_16", "PRIORITY_17", "PRIORITY_18", "PRIORITY_19", "PRIORITY_20" ]

    コンテンツに割り当てられた優先度。

    有効な値は次のとおりです: PRIORITY_0からPRIORITY_20。 たとえば、PRIORITY_1またはPRIORITY_18は有効な値ですが、PRIORITY_21は有効ではありません。

  • 文書がエンド・ユーザーに最初に表示される日付。

  • 文書が公開されているかどうかを示すフラグ。

  • ContentKey
    タイトル: ContentKey
  • コンテンツ・オブジェクトのバージョン
  • DataForm
    タイトル: DataForm
  • AggregateFormResults
    タイトル: AggregateFormResults
  • コンテンツを編集または作成する理由。 これは、ドキュメントの作成または更新時にのみ使用されます。

  • 文書の一意の識別子。 このIDは、ドキュメントのすべてのロケールのすべてのバージョンで同じです。

  • replacementTokens

    短く、管理しやすい用語(tokenName)を作成するオブジェクト。 これらのトークンは、標準化および翻訳可能であり、場合によっては複雑なコンテンツ(統合テキスト、イメージ、リスト、表など)を表します。

  • URLの例 : http:// <IM_REST_API_HOST> /okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. ユーザー名を渡さない場合は、'guest'ユーザーにデフォルト設定されます。
  • schemaAttributes

    このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

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

  • ドキュメントのタイトル。

  • userGroups

    コンテンツに割り当てられたユーザー・グループ。 割り当てられたユーザー・グループのメンバーのみがコンテンツにアクセスできます。 デフォルト値は全員です。

  • コンテンツ・オブジェクトのバージョン

  • 特定のロケールでのドキュメントの特定のバージョンの一意の識別子。 このフィールドは、q問合せパラメータを使用して作成された問合せでは使用できません。

  • views

    コンテンツに割り当てられたビュー。 コンテンツにビューが割り当てられているユーザー、またはコンテンツが保存されているコンテンツ・タイプは、そのコンテンツにのみアクセスできます。

  • レビューに関与する作成者にサービスが通知を送信する日付。 ワークフロー通知が提供されると、サービスは次のレビュー日を更新します。

  • WorkflowStepKey
    タイトル: WorkflowStepKey
  • コンテンツ・オブジェクトのxml
ネストされたスキーマ : allTranslations
タイプ: array

このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

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

ソースを表示
ネストされたスキーマ : ArticleStatusKey
タイプ: object
タイトル: ArticleStatusKey
ソースを表示
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
ネストされたスキーマ : カテゴリ
タイプ: array

コンテンツに割り当てられたカテゴリ・オブジェクトまたはカテゴリ・オブジェクトのリスト。

たとえば 世界がレベル1のカテゴリである場合、レベル2にアフリカ、ウクライナ、アメリカなどがある可能性があります。 カテゴリ内のオブジェクトのリクエストは、階層的または非階層的に指定できます。 フロリダが割り当てられているコンテンツが階層型のリクエスト・ワールドを使用してリクエストされると、結果が表示されます。 一方、同じリクエストが非階層的に実行されても、結果はありません。

カテゴリ・パラメータを使用すると、単一構成と複数構成の両方で、結果を第1レベル・カテゴリおよび階層カテゴリでフィルタできます。

    いずれかと一致

    リクエストとともに contentType.refKey eqパラメータまたはcontentType.refKey inパラメータを渡すと、サービスはリクエストで指定されたカテゴリのいずれかに一致します。

    categoryパラメータのURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

    • 次のURIの例は、指定したカテゴリのレベルに存在するコンテンツ・オブジェクトを返します。 これにより、子コンテンツ・オブジェクトは返されません。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

    • 次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular

    次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent

    返されたリストのオブジェクトは、公開日に基づいてソートされます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

    返されるリスト内のオブジェクトは、dateModifiedでソートされます。

    すべて一致

    リクエストとともに andcategories.refKey matchAll パラメータを渡すと、リクエストで指定されたすべてのカテゴリがサービスによって照合されます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY

    このリクエストは、ワールドおよびムービー・カテゴリ内のすべてのコンテンツ・オブジェクトを返します。 アフリカはカテゴリworldの子カテゴリであるため、サービスはAfricaカテゴリのコンテンツ・オブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular

    返されたリストのオブジェクトは、ビューによって降順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

    返されたリストのオブジェクトは、公開された日付の降順でソートされます。

ソースを表示
ネストされたスキーマ : UserKey
タイプ: object
タイトル: UserKey
ソースを表示
  • ユーザー・オブジェクトの電子メール
  • ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
  • ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
  • links
  • ユーザーのフルネーム
  • ユーザー・オブジェクトの一意のレコードID。
ネストされたスキーマ : ContentTypeKey
タイプ: object
タイトル: ContentTypeKey
ソースを表示

  • ContentTypeオブジェクトの説明。 コンテンツ・タイプは複数の言語をサポートしています。

    このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。

  • links

  • ContentTypeオブジェクトの名前。 名前フィールドはソートにのみ使用できます。

    コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。

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

  • ContentTypeオブジェクトの参照キー。

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

  • ストライプ・コードを示す参照コード。

ネストされたスキーマ : ContentKey
タイプ: object
タイトル: ContentKey
ソースを表示
ネストされたスキーマ : リンク
タイプ: array
ソースを表示
  • instanceLink
ネストされたスキーマ : DataForm
タイプ: object
タイトル: DataForm
ソースを表示
ネストされたスキーマ : AggregateFormResults
タイプ: object
タイトル: AggregateFormResults
ソースを表示
ネストされたスキーマ : replacementTokens
タイプ: array

短く、管理しやすい用語(tokenName)を作成するオブジェクト。 これらのトークンは、標準化および翻訳可能であり、場合によっては複雑なコンテンツ(統合テキスト、イメージ、リスト、表など)を表します。

ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array

このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

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

ソースを表示
ネストされたスキーマ : userGroups
タイプ: array

コンテンツに割り当てられたユーザー・グループ。 割り当てられたユーザー・グループのメンバーのみがコンテンツにアクセスできます。 デフォルト値は全員です。

ソースを表示
ネストされたスキーマ : ビュー
タイプ: array

コンテンツに割り当てられたビュー。 コンテンツにビューが割り当てられているユーザー、またはコンテンツが保存されているコンテンツ・タイプは、そのコンテンツにのみアクセスできます。

ソースを表示
ネストされたスキーマ : WorkflowStepKey
タイプ: object
タイトル: WorkflowStepKey
ソースを表示
ネストされたスキーマ : 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
ソースを表示
ネストされたスキーマ : allTranslations
タイプ: array

このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

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

ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array

このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

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

ソースを表示
ネストされたスキーマ : SchemaAttribute
タイプ: object
タイトル: SchemaAttribute
ソースを表示
ネストされたスキーマ : 子供
タイプ: array
現在の要素の子ノードのリスト
ソースを表示
ネストされたスキーマ : localizedAttributes
タイプ: array
様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト
ソースを表示
ネストされたスキーマ : schemaAttributeUserGroupList
タイプ: array
この属性を保護するために使用できるユーザー・グループのリスト。 これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります
ソースを表示
ネストされたスキーマ : LocalizedAttributes
タイプ: object
タイトル: LocalizedAttributes
ソースを表示
ネストされたスキーマ : SchemaAttributeUserGroup
タイプ: object
タイトル: SchemaAttributeUserGroup
ソースを表示
ネストされたスキーマ : UserGroupKey
タイプ: object
タイトル: UserGroupKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
質問と多数の関係
ソースを表示
ネストされたスキーマ : ビュー
タイプ: array
表示する関係が多すぎます
ソースを表示
ネストされたスキーマ : DataFormQuestion
タイプ: object
タイトル: DataFormQuestion
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
回答との関連性が多すぎます
ソースを表示
ネストされたスキーマ : DataFormKey
タイプ: object
タイトル: DataFormKey
ソースを表示
ネストされたスキーマ : DataFormAnswer
タイプ: object
タイトル: DataFormAnswer
ソースを表示
ネストされたスキーマ : DataFormQuestionKey
タイプ: object
タイトル: DataFormQuestionKey
ソースを表示
ネストされたスキーマ : ViewKey
タイプ: object
タイトル: ViewKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
AggregateQuestionResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateQuestionResult
タイプ: object
タイトル: AggregateQuestionResult
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
AggregateAnswerResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateAnswerResult
タイプ: object
タイトル: AggregateAnswerResult
ソースを表示
ネストされたスキーマ : ReplacementToken
タイプ: object
タイトル: ReplacementToken
ソースを表示
トップに戻る

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : コンテンツ
タイプ: object
タイトル: Content
ソースを表示
  • allTranslations

    このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

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

  • アンサーとコンテンツ間のマッピングを可能にする一意の識別子。

  • ArticleStatusKey
    タイトル: ArticleStatusKey
  • LocaleKey
    タイトル: LocaleKey
  • コンテンツ・オブジェクトのバージョン
  • categories

    コンテンツに割り当てられたカテゴリ・オブジェクトまたはカテゴリ・オブジェクトのリスト。

    たとえば 世界がレベル1のカテゴリである場合、レベル2にアフリカ、ウクライナ、アメリカなどがある可能性があります。 カテゴリ内のオブジェクトのリクエストは、階層的または非階層的に指定できます。 フロリダが割り当てられているコンテンツが階層型のリクエスト・ワールドを使用してリクエストされると、結果が表示されます。 一方、同じリクエストが非階層的に実行されても、結果はありません。

    カテゴリ・パラメータを使用すると、単一構成と複数構成の両方で、結果を第1レベル・カテゴリおよび階層カテゴリでフィルタできます。

      いずれかと一致

      リクエストとともに contentType.refKey eqパラメータまたはcontentType.refKey inパラメータを渡すと、サービスはリクエストで指定されたカテゴリのいずれかに一致します。

      categoryパラメータのURIの例を次に示します:

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

      • OR

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

      • 次のURIの例は、指定したカテゴリのレベルに存在するコンテンツ・オブジェクトを返します。 これにより、子コンテンツ・オブジェクトは返されません。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

      • OR

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

      • 次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular

      次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent

      返されたリストのオブジェクトは、公開日に基づいてソートされます。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

      返されるリスト内のオブジェクトは、dateModifiedでソートされます。

      すべて一致

      リクエストとともに andcategories.refKey matchAll パラメータを渡すと、リクエストで指定されたすべてのカテゴリがサービスによって照合されます。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY

      このリクエストは、ワールドおよびムービー・カテゴリ内のすべてのコンテンツ・オブジェクトを返します。 アフリカはカテゴリworldの子カテゴリであるため、サービスはAfricaカテゴリのコンテンツ・オブジェクトを返します。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular

      返されたリストのオブジェクトは、ビューによって降順にソートされます。

    • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

      返されたリストのオブジェクトは、公開された日付の降順でソートされます。

  • 作成者がドキュメントを編集のためにチェックアウトまたはロックした日付。

  • UserKey
    タイトル: UserKey
  • ContentTypeKey
    タイトル: ContentTypeKey

  • コンテンツが作成された日付。 レガシー・システムの場合、作成日は、それらのシステムでドキュメントが作成された日付です。

  • UserKey
    タイトル: UserKey

  • コンテンツがコンテンツ・タイプに追加された日付。 レガシー・システムの場合、作成日は、ドキュメントがレガシー・システムからOracle Knowledge Repositoryに移行された日付です。

  • Oracle Knowledge Repositoryでコンテンツが最後に変更された日付。

  • サービスがエンド・ユーザーへのドキュメントの表示を停止する日付。

  • 許可された値: [ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]
    Fixed@Top、Place@Top、Historical UsefulnessのLookUpコード

  • レビューを実行できる作成者によるレビューが文書に必要な日付。

  • 文書をエンドユーザーに表示できるようになる日付。

  • コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。

  • ドキュメントのイベントが終了する日付。

  • ドキュメントのイベントが開始する日付。

  • 編集可能なコンテンツをリクエストするパラメータ。

  • コンテンツが最後に変更された日付。 レガシー・システムの場合、lastModifiedDate日付は、これらのシステムでドキュメントが最後に変更された日付です。

  • UserKey
    タイトル: UserKey
  • ContentKey
    タイトル: ContentKey
  • links
  • LocaleKey
    タイトル: LocaleKey
  • コンテンツ・オブジェクトのMetaDataResourcePath
  • コンテンツ・オブジェクトのMetaDataXml
  • UserKey
    タイトル: UserKey

  • 文書が公開待ちかどうかを示すフラグ。

  • 許可された値: [ "PRIORITY_0", "PRIORITY_1", "PRIORITY_2", "PRIORITY_3", "PRIORITY_4", "PRIORITY_5", "PRIORITY_6", "PRIORITY_7", "PRIORITY_8", "PRIORITY_9", "PRIORITY_10", "PRIORITY_11", "PRIORITY_12", "PRIORITY_13", "PRIORITY_14", "PRIORITY_15", "PRIORITY_16", "PRIORITY_17", "PRIORITY_18", "PRIORITY_19", "PRIORITY_20" ]

    コンテンツに割り当てられた優先度。

    有効な値は次のとおりです: PRIORITY_0からPRIORITY_20。 たとえば、PRIORITY_1またはPRIORITY_18は有効な値ですが、PRIORITY_21は有効ではありません。

  • 文書がエンド・ユーザーに最初に表示される日付。

  • 文書が公開されているかどうかを示すフラグ。

  • ContentKey
    タイトル: ContentKey
  • コンテンツ・オブジェクトのバージョン
  • DataForm
    タイトル: DataForm
  • AggregateFormResults
    タイトル: AggregateFormResults
  • コンテンツを編集または作成する理由。 これは、ドキュメントの作成または更新時にのみ使用されます。

  • 文書の一意の識別子。 このIDは、ドキュメントのすべてのロケールのすべてのバージョンで同じです。

  • replacementTokens

    短く、管理しやすい用語(tokenName)を作成するオブジェクト。 これらのトークンは、標準化および翻訳可能であり、場合によっては複雑なコンテンツ(統合テキスト、イメージ、リスト、表など)を表します。

  • URLの例 : http:// <IM_REST_API_HOST> /okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. ユーザー名を渡さない場合は、'guest'ユーザーにデフォルト設定されます。
  • schemaAttributes

    このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

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

  • ドキュメントのタイトル。

  • userGroups

    コンテンツに割り当てられたユーザー・グループ。 割り当てられたユーザー・グループのメンバーのみがコンテンツにアクセスできます。 デフォルト値は全員です。

  • コンテンツ・オブジェクトのバージョン

  • 特定のロケールでのドキュメントの特定のバージョンの一意の識別子。 このフィールドは、q問合せパラメータを使用して作成された問合せでは使用できません。

  • views

    コンテンツに割り当てられたビュー。 コンテンツにビューが割り当てられているユーザー、またはコンテンツが保存されているコンテンツ・タイプは、そのコンテンツにのみアクセスできます。

  • レビューに関与する作成者にサービスが通知を送信する日付。 ワークフロー通知が提供されると、サービスは次のレビュー日を更新します。

  • WorkflowStepKey
    タイトル: WorkflowStepKey
  • コンテンツ・オブジェクトのxml
ネストされたスキーマ : allTranslations
タイプ: array

このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

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

ソースを表示
ネストされたスキーマ : ArticleStatusKey
タイプ: object
タイトル: ArticleStatusKey
ソースを表示
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
ネストされたスキーマ : カテゴリ
タイプ: array

コンテンツに割り当てられたカテゴリ・オブジェクトまたはカテゴリ・オブジェクトのリスト。

たとえば 世界がレベル1のカテゴリである場合、レベル2にアフリカ、ウクライナ、アメリカなどがある可能性があります。 カテゴリ内のオブジェクトのリクエストは、階層的または非階層的に指定できます。 フロリダが割り当てられているコンテンツが階層型のリクエスト・ワールドを使用してリクエストされると、結果が表示されます。 一方、同じリクエストが非階層的に実行されても、結果はありません。

カテゴリ・パラメータを使用すると、単一構成と複数構成の両方で、結果を第1レベル・カテゴリおよび階層カテゴリでフィルタできます。

    いずれかと一致

    リクエストとともに contentType.refKey eqパラメータまたはcontentType.refKey inパラメータを渡すと、サービスはリクエストで指定されたカテゴリのいずれかに一致します。

    categoryパラメータのURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY

    • 次のURIの例は、指定したカテゴリのレベルに存在するコンテンツ・オブジェクトを返します。 これにより、子コンテンツ・オブジェクトは返されません。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY

    • OR

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY

    • 次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular

    次のURIの例は、リクエストで指定された複数の基準に一致するコンテンツ・オブジェクトを返します

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'PUBLISHED'&mode=KEY&orderBy=mostRecent

    返されたリストのオブジェクトは、公開日に基づいてソートされます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE') and filterMode.contentState eq 'LATESTVALID'&mode=KEY&orderBy=mostRecent

    返されるリスト内のオブジェクトは、dateModifiedでソートされます。

    すべて一致

    リクエストとともに andcategories.refKey matchAll パラメータを渡すと、リクエストで指定されたすべてのカテゴリがサービスによって照合されます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY

    このリクエストは、ワールドおよびムービー・カテゴリ内のすべてのコンテンツ・オブジェクトを返します。 アフリカはカテゴリworldの子カテゴリであるため、サービスはAfricaカテゴリのコンテンツ・オブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular

    返されたリストのオブジェクトは、ビューによって降順にソートされます。

  • http://<IM_REST_API_HOST>/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent

    返されたリストのオブジェクトは、公開された日付の降順でソートされます。

ソースを表示
ネストされたスキーマ : UserKey
タイプ: object
タイトル: UserKey
ソースを表示
  • ユーザー・オブジェクトの電子メール
  • ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
  • ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
  • links
  • ユーザーのフルネーム
  • ユーザー・オブジェクトの一意のレコードID。
ネストされたスキーマ : ContentTypeKey
タイプ: object
タイトル: ContentTypeKey
ソースを表示

  • ContentTypeオブジェクトの説明。 コンテンツ・タイプは複数の言語をサポートしています。

    このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。

  • links

  • ContentTypeオブジェクトの名前。 名前フィールドはソートにのみ使用できます。

    コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。

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

  • ContentTypeオブジェクトの参照キー。

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

  • ストライプ・コードを示す参照コード。

ネストされたスキーマ : ContentKey
タイプ: object
タイトル: ContentKey
ソースを表示
ネストされたスキーマ : リンク
タイプ: array
ソースを表示
  • instanceLink
ネストされたスキーマ : DataForm
タイプ: object
タイトル: DataForm
ソースを表示
ネストされたスキーマ : AggregateFormResults
タイプ: object
タイトル: AggregateFormResults
ソースを表示
ネストされたスキーマ : replacementTokens
タイプ: array

短く、管理しやすい用語(tokenName)を作成するオブジェクト。 これらのトークンは、標準化および翻訳可能であり、場合によっては複雑なコンテンツ(統合テキスト、イメージ、リスト、表など)を表します。

ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array

このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

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

ソースを表示
ネストされたスキーマ : userGroups
タイプ: array

コンテンツに割り当てられたユーザー・グループ。 割り当てられたユーザー・グループのメンバーのみがコンテンツにアクセスできます。 デフォルト値は全員です。

ソースを表示
ネストされたスキーマ : ビュー
タイプ: array

コンテンツに割り当てられたビュー。 コンテンツにビューが割り当てられているユーザー、またはコンテンツが保存されているコンテンツ・タイプは、そのコンテンツにのみアクセスできます。

ソースを表示
ネストされたスキーマ : WorkflowStepKey
タイプ: object
タイトル: WorkflowStepKey
ソースを表示
ネストされたスキーマ : 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
ソースを表示
ネストされたスキーマ : allTranslations
タイプ: array

このフィールドは、ユーザーが表示できるすべての翻訳済コンテンツのリストを返します

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

ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array

このフィールドには、このコンテンツのコンテンツ・タイプに関連付けられたスキーマ属性のリストが返されます。

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

ソースを表示
ネストされたスキーマ : SchemaAttribute
タイプ: object
タイトル: SchemaAttribute
ソースを表示
ネストされたスキーマ : 子供
タイプ: array
現在の要素の子ノードのリスト
ソースを表示
ネストされたスキーマ : localizedAttributes
タイプ: array
様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト
ソースを表示
ネストされたスキーマ : schemaAttributeUserGroupList
タイプ: array
この属性を保護するために使用できるユーザー・グループのリスト。 これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります
ソースを表示
ネストされたスキーマ : LocalizedAttributes
タイプ: object
タイトル: LocalizedAttributes
ソースを表示
ネストされたスキーマ : SchemaAttributeUserGroup
タイプ: object
タイトル: SchemaAttributeUserGroup
ソースを表示
ネストされたスキーマ : UserGroupKey
タイプ: object
タイトル: UserGroupKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
質問と多数の関係
ソースを表示
ネストされたスキーマ : ビュー
タイプ: array
表示する関係が多すぎます
ソースを表示
ネストされたスキーマ : DataFormQuestion
タイプ: object
タイトル: DataFormQuestion
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
回答との関連性が多すぎます
ソースを表示
ネストされたスキーマ : DataFormKey
タイプ: object
タイトル: DataFormKey
ソースを表示
ネストされたスキーマ : DataFormAnswer
タイプ: object
タイトル: DataFormAnswer
ソースを表示
ネストされたスキーマ : DataFormQuestionKey
タイプ: object
タイトル: DataFormQuestionKey
ソースを表示
ネストされたスキーマ : ViewKey
タイプ: object
タイトル: ViewKey
ソースを表示
ネストされたスキーマ : 質問
タイプ: array
AggregateQuestionResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateQuestionResult
タイプ: object
タイトル: AggregateQuestionResult
ソースを表示
ネストされたスキーマ : 答え
タイプ: array
AggregateAnswerResultとの関係が多すぎます
ソースを表示
ネストされたスキーマ : AggregateAnswerResult
タイプ: object
タイトル: AggregateAnswerResult
ソースを表示
ネストされたスキーマ : ReplacementToken
タイプ: object
タイトル: ReplacementToken
ソースを表示
トップに戻る

例

次の例は、マスター・ロケールまたはコンテンツがすでに翻訳されている他のロケールのコンテンツを更新する方法を示しています:

curl -X PUT "https://<IM_REST_API_HOST>/km/api/latest/content/{id}" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
  "isForEdit": true,
  "categories": [],
  "userGroups": [],
  "views": [
    {
      "recordId": "BBA181DFB52148779A416184A191B2AF",
      "referenceKey": "SERVICE",
      "name": "Service",
      "links": [
        {
          "rel": "canonical",
          "href": "https://<IM_REST_API_HOST>/km/api/latest/views/BBA181DFB52148779A416184A191B2AF",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    }
  ],
  "recordId": "55139CC10D70461B8657C239D641FC52",
  "versionId": "EABCAD3CEF3241E6AF69AF39F7C3CD01",
  "documentId": "FAQ14",
  "version":"1.0",
  "locale": {
    "recordId": "en_US",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/locales/en_US",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "dateModified": "2018-11-26T13:45:56+0530",
  "contentType": {
    "recordId": "98055D055BA8467B8097FB0B52923FD2",
    "referenceKey": "FAQ",
    "name": "FAQ",
    "description": "A template containing a common question and answer on a specific topic",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/contentTypes/98055D055BA8467B8097FB0B52923FD2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "priority": "PRIORITY_0",
  "createDate": "2018-11-26T13:45:03+0530",
  "dateAdded": "2018-11-26T13:45:03+0530",
  "owner": {
    "recordId": 2,
    "name": "Default Administrator",
    "email": "user@example.com",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/users/2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  
  "published": false,
  "pending": false,
  "checkedOut": false,
  "xml": "<FAQ><QUESTION><![CDATA[Q query Testing-upd]]></QUESTION><ANSWER><![CDATA[Q query Testing-upd]]></ANSWER><SUMMARY><![CDATA[Q query  Testing-upd]]></SUMMARY></FAQ>"
}

レスポンス本文の例

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

{
  "isForEdit": true,
  "categories": [],
  "userGroups": [],
  "views": [
    {
      "recordId": "BBA181DFB52148779A416184A191B2AF",
      "referenceKey": "SERVICE",
      "name": "Service",
      "links": [
        {
          "rel": "canonical",
          "href": "https://<IM_REST_API_HOST>/km/api/latest/views/BBA181DFB52148779A416184A191B2AF",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    }
  ],
  "recordId": "55139CC10D70461B8657C239D641FC52",
  "versionId": "1A6E0737C6934364928964ABBDF6E862",
  "documentId": "FAQ14",
  "title": "Q query  Testing-upd",
  "version": "2.0",
  "answerId": 1001005,
  "locale": {
    "recordId": "en_US",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/locales/en_US",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "dateModified": "2018-11-26T13:59:54+0530",
  "links": [
    {
      "rel": "canonical",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content/55139CC10D70461B8657C239D641FC52",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "collection",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content",
      "mediaType": "application/json, application/xml",
      "method": "GET",
      "profile": "https://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/content"
    }
  ],
  "contentType": {
    "recordId": "98055D055BA8467B8097FB0B52923FD2",
    "referenceKey": "FAQ",
    "name": "FAQ",
    "description": "A simple template containing a common question and answer on a specific topic",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/contentTypes/98055D055BA8467B8097FB0B52923FD2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "priority": "PRIORITY_0",
  "createDate": "2018-11-26T13:45:03+0530",
  "lastModifiedDate": "2018-11-26T13:59:54+0530",
  "dateAdded": "2018-11-26T13:59:54+0530",
  "displayStartDate": "1900-01-01T00:00:00+0530",
  "displayEndDate": "9999-12-31T00:00:00+0530",
  "owner": {
    "recordId": 2,
    "name": "Default Administrator",
    "email": "user@example.com",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/users/2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "lastModifier": {
    "recordId": 2,
    "name": "Default Administrator",
    "email": "user@example.com",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/users/2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "creator": {
    "recordId": 2,
    "name": "Default Administrator",
    "email": "user@example.com",
    "externalType": "ACCOUNT",
    "links": [
      {
        "rel": "canonical",
        "href": "https://<IM_REST_API_HOST>/km/api/latest/users/2",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "published": false,
  "pending": false,
  "checkedOut": false,
  "publishedVersion": "1.0",
  "xml": "<FAQ><QUESTION><![CDATA[Q query Testing-upd]]></QUESTION><ANSWER><![CDATA[Q query Testing-upd]]></ANSWER><SUMMARY><![CDATA[Q query  Testing-upd]]></SUMMARY></FAQ>",
  "resourcePath": "$STAGING_RESOURCE_HOST_URL/fusion/content/draft/55139CC10D70461B8657C239D641FC52/1A6E0737C6934364928964ABBDF6E862/"
}
「トップに戻る」