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

インポートからのコンテンツの更新

put

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

このメソッドは、リクエストで指定されたコンテンツ・ビジネス・オブジェクトをインポートします。インポートは、既存の文書の更新として実行されます。インポートを実行するには、複合コンテンツ・ビジネス・オブジェクトとともにファイル添付を指定する必要があります。

インポート・フロー条件の作成

インポート・フローの作成中に新しい文書を作成する場合は、次の点を考慮してください:

新しいドキュメントのdateAdded値は、新しいドキュメントのcreateDateとして設定されます。指定したdateAdded値はすべて無視されます。
createDateフィールドの値を指定する場合は、次の点を考慮してください:
- createDate値は過去である必要があります。
- createDate値は、dateModified値以前である必要があります。
- nullに設定されたcreateDate値は、現在の日付および現在の時間値が作成日として設定されます。
dateModifiedフィールドの値を指定する場合は、次の点を考慮してください:
- dateModified値は将来にできません。
- dateModified値は、createDate以降にする必要があります。
- dateModified値は、createDate値がある場合にのみ指定する必要があります。
- dateModified値がnullに設定されている場合、現在の日付および現在の時間の値は変更日に設定されます。

インポート・フロー条件の更新

更新のインポート・フロー中に現在のロケールで文書の新しいバージョンを作成する場合は、次の点を考慮してください:

新しいバージョンのドキュメントのcreateDateは、以前のバージョンのドキュメントのcreateDateとして設定されます。指定したcreateDate値はすべて無視されます。

新しいバージョンのドキュメントのdateAddedは、以前のバージョンのドキュメントのdateAddedとして設定されます。指定したdateAdded値はすべて無視されます。

dateModifiedフィールドの値を指定する場合は、次の点を考慮してください:

dateModified値は将来にできません。
dateModified値は、以前のバージョンのdateModified以降にする必要があります。
nullに設定されたdateModified値は、現在の日付および現在の時間値が新しいバージョンの日付変更として設定されます。

インポート・フロー条件の翻訳

翻訳インポート・フロー中に別のロケールで文書の新しいバージョンを作成する場合は、次の点を考慮してください:

新しいバージョンのドキュメントのdateAdded値は、createDate値として設定されます。指定したdateAdded値はすべて無視されます。
createDateフィールドの値を指定する場合は、次の点を考慮してください:
- createDate値は将来にできません。
- createDate値は、dateModified以前である必要があります。
- nullに設定されたcreateDate値は、現在の日付および現在の時間値が作成日として設定されます。
dateModifiedフィールドの値を指定する場合は、次の点を考慮してください :
- dateModified値は将来にできません。
- dateModified値は、createDate以降にする必要があります。
- dateModified値がnullに設定されている場合、現在の日付および現在の時間の値は変更された日付として設定されます。
- dateModified値は、createDate値がある場合にのみ指定する必要があります。

次の表に、作成、変換および更新メソッドのコール時に使用されるフィールド・パラメータの通常のフロー条件とインポート・フロー条件を示します。

フィールド	通常フロー	通常のフロー条件	インポート・フロー	フロー条件のインポート
作成/ 翻訳	更新	作成/ 翻訳	更新
創造者	許可されていません	許可されていません	なし	ALLOWED	IGNORED	記事の作成中にのみ、ユーザーを作成者として指定できます。作成者が指定されていない場合、アクティブ・ユーザーは作成者として設定されます。
所有者	OPTIONAL	OPTIONAL	作成者フィールドを使用して、別のユーザーを所有者として指定できます。所有者が指定されていない場合、アクティブなユーザーは所有者として設定されます。	OPTIONAL	OPTIONAL	所有者フィールドを使用して、別のユーザーを所有者として指定できます。更新中に所有者が指定されていない場合、アクティブ・ユーザーは作成者として設定されます。
lastModifier	許可されていません	許可されていません	デフォルトでは、アクティブなユーザーは常に最後の修飾子です。	OPTIONAL	OPTIONAL	lastModifierフィールドを使用して、最後の修飾子として別のユーザーを指定できます。最後の修飾子が指定されていない場合、アクティブなユーザーは最後の修飾子とみなされます。
createDate	許可されていません	許可されていません	なし	OPTIONAL	OPTIONAL
dateAdded	許可されていません	許可されていません	なし	IGNORED	IGNORED	dateAdded値は、すべてのインポート・フローでは無視されます。
dateModified	許可されていません	EXPECTED	更新中、dateModified値は最新バージョンのDateModifiedと一致する必要があります。	OPTIONAL	OPTIONAL	詳細は、インポート・フロー条件の作成、インポート・フロー条件の更新および「インポート・フロー条件の翻訳」の項を参照してください。
公開	該当なし	該当なし	公開フィールドは通常のフローでは適用できません。	OPTIONAL	OPTIONAL	なし。

フィールド

通常フロー

通常のフロー条件

インポート・フロー

フロー条件のインポート

作成/ 翻訳

更新

作成/ 翻訳

更新

創造者

許可されていません

なし

ALLOWED

IGNORED

記事の作成中にのみ、ユーザーを作成者として指定できます。作成者が指定されていない場合、アクティブ・ユーザーは作成者として設定されます。

所有者

OPTIONAL

作成者フィールドを使用して、別のユーザーを所有者として指定できます。所有者が指定されていない場合、アクティブなユーザーは所有者として設定されます。

OPTIONAL

所有者フィールドを使用して、別のユーザーを所有者として指定できます。更新中に所有者が指定されていない場合、アクティブ・ユーザーは作成者として設定されます。

lastModifier

許可されていません

デフォルトでは、アクティブなユーザーは常に最後の修飾子です。

OPTIONAL

lastModifierフィールドを使用して、最後の修飾子として別のユーザーを指定できます。最後の修飾子が指定されていない場合、アクティブなユーザーは最後の修飾子とみなされます。

createDate

許可されていません

なし

OPTIONAL

dateAdded

許可されていません

なし

IGNORED

dateAdded値は、すべてのインポート・フローでは無視されます。

dateModified

許可されていません

EXPECTED

更新中、dateModified値は最新バージョンのDateModifiedと一致する必要があります。

OPTIONAL

詳細は、インポート・フロー条件の作成、インポート・フロー条件の更新および「インポート・フロー条件の翻訳」の項を参照してください。

公開

該当なし

公開フィールドは通常のフローでは適用できません。

OPTIONAL

なし。

ノート: 新しいドキュメントをインポートするには、インポート時に対応するPOSTメソッドを使用します。

リクエスト

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

application/json
application/xml

パス・パラメータ

id: string

コンテンツ識別子

更新するContentBOと変更クオリファイアBOの複合。

ルート・スキーマ : CompositeContent

タイプ: object

タイトル: CompositeContent

ソースを表示

content(optional): object Content

タイトル: Content
contentModificationQualifier(optional): object ContentModificationQualifier

タイトル: ContentModificationQualifier

{
    "title":"CompositeContent",
    "properties":{
        "contentModificationQualifier":{
            "description":"Qualifiers on the Content Modifications",
            "$ref":"#/definitions/ContentModificationQualifier"
        },
        "content":{
            "description":"ContentBO object being created or updated",
            "$ref":"#/definitions/Content"
        }
    }
}

ネストされたスキーマ : コンテンツ

タイプ: object

タイトル: Content

ソースを表示

allTranslations(optional): array allTranslations

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

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

アンサーとコンテンツ間のマッピングを可能にする一意の識別子。
articleStatus(optional): object ArticleStatusKey

タイトル: ArticleStatusKey
basedLocale(optional): object LocaleKey

タイトル: LocaleKey
basedOnVersion(optional): string

コンテンツ・オブジェクトのバージョン
categories(optional): array categories
コンテンツに割り当てられたカテゴリ・オブジェクトまたはカテゴリ・オブジェクトのリスト。

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

カテゴリ・パラメータを使用すると、単一構成と複数構成の両方で、結果を第1レベル・カテゴリおよび階層カテゴリでフィルタできます。
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY
- 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でソートされます。
- 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
  返されたリストのオブジェクトは、公開された日付の降順でソートされます。
checkedOut(optional): boolean

作成者がドキュメントを編集のためにチェックアウトまたはロックした日付。
checkedOutBy(optional): object UserKey

タイトル: UserKey
contentType(optional): object ContentTypeKey

タイトル: ContentTypeKey
createDate(optional): string(date-time)

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

タイトル: UserKey
dateAdded(optional): string(date-time)

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

Oracle Knowledge Repositoryでコンテンツが最後に変更された日付。
displayEndDate(optional): string(date-time)

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

許可された値: [ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]

Fixed@Top、Place@Top、Historical UsefulnessのLookUpコード
displayReviewDate(optional): string(date-time)

レビューを実行できる作成者によるレビューが文書に必要な日付。
displayStartDate(optional): string(date-time)

文書をエンドユーザーに表示できるようになる日付。
documentId(optional): string

コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。
eventEndDate(optional): string(date-time)

ドキュメントのイベントが終了する日付。
eventStartDate(optional): string(date-time)

ドキュメントのイベントが開始する日付。
isForEdit(optional): boolean

編集可能なコンテンツをリクエストするパラメータ。
lastModifiedDate(optional): string(date-time)

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

タイトル: UserKey
latestContent(optional): object ContentKey

タイトル: ContentKey
links(optional): array links
locale(optional): object LocaleKey

タイトル: LocaleKey
metaDataResourcePath(optional): string

コンテンツ・オブジェクトのMetaDataResourcePath
metaDataXml(optional): string

コンテンツ・オブジェクトのMetaDataXml
owner(optional): object UserKey

タイトル: UserKey
pending(optional): boolean

文書が公開待ちかどうかを示すフラグ。
priority(optional):

許可された値: [ "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は有効ではありません。
publishDate(optional): string(date-time)

文書がエンド・ユーザーに最初に表示される日付。
published(optional): boolean

文書が公開されているかどうかを示すフラグ。
publishedContent(optional): object ContentKey

タイトル: ContentKey
publishedVersion(optional): string

コンテンツ・オブジェクトのバージョン
rating(optional): object DataForm

タイトル: DataForm
ratingsAggregate(optional): object AggregateFormResults

タイトル: AggregateFormResults
reasonForEdit(optional): string

コンテンツを編集または作成する理由。これは、ドキュメントの作成または更新時にのみ使用されます。
recordId(optional): string

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

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

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

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

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

ドキュメントのタイトル。
userGroups(optional): array userGroups

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

コンテンツ・オブジェクトのバージョン
versionId(optional): string

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

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

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

タイトル: WorkflowStepKey
xml(optional): string

コンテンツ・オブジェクトのxml

{
    "title":"Content",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>",
            "type":"string"
        },
        "basedOnVersion":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "eventEndDate":{
            "description":"<p>The date when the document's event ends.</p>",
            "format":"date-time",
            "type":"string"
        },
        "contentType":{
            "description":"<p>The channel to which the content is categorized and saved. The following are the subfields that can be used with contentType query parameter: </p> <ul> <li>contentType.recordId : The unique identifier of the ContentType object.</li> <li>contentType.referenceKey : The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages. For Example to request articles for content type FAQ, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.referenceKey eq 'FAQ'</code></li> <li>contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.</li> </ul>",
            "$ref":"#/definitions/ContentTypeKey"
        },
        "displayReviewDate":{
            "description":"<p>The date when the document requires a review by an author capable of performing the review.</p>",
            "format":"date-time",
            "type":"string"
        },
        "displayPosition":{
            "description":"LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness",
            "enum":[
                "FIXED_AT_TOP",
                "PLACE_AT_TOP",
                "HISTORICAL_USEFULNESS"
            ]
        },
        "priority":{
            "description":"<p>The priority assigned to the content.</p><p>The valid values are: PRIORITY_0 to PRIORITY_20. For example, PRIORITY_1 or PRIORITY_18 are valid values, but PRIORITY_21 is not.</p>",
            "enum":[
                "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"
            ]
        },
        "pending":{
            "description":"<p>The flag that indicates whether the document is pending for publication.</p>",
            "type":"boolean"
        },
        "lastModifier":{
            "description":"<p>The user or author who performed the last content modification. The following are the subfields that can be used with lastModifier query parameter: </p> <ul> <li>lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=lastModifier.recordId eq '{id}'</code></li> <li>lastModifier.email : User's email.</li>  <li>lastModifier.firstName : User's firstName.</li>  <li>lastModifier.lastName : User's lastName.</li>  <li>lastModifier.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "articleStatus":{
            "description":"<p>The article status.</p> <ul> <p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p> <p>Example URIs for the articleStatus parameter are as follows:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li>    <br/>    <p>The following example URIs returns Content objects whose contentState is LATEST:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li> </br>       <p>The following example URI returns Content objects with no article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li>    </br>       <p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li>    </br>       <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>    <br/>    <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>  </ul>",
            "$ref":"#/definitions/ArticleStatusKey"
        },
        "reasonForEdit":{
            "description":"Reasons for editing or creating a content. This will only be used when creating or updating the document.",
            "type":"string"
        },
        "publishDate":{
            "description":"<p>The date when the document was first displayed to end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "replacementTokens":{
            "items":{
                "$ref":"#/definitions/ReplacementToken"
            },
            "description":"<p>The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.</p>",
            "type":"array"
        },
        "metaDataXml":{
            "description":"MetaDataXml of the Content object",
            "type":"string"
        },
        "eventStartDate":{
            "description":"<p>The date when the document's event begins.</p>",
            "format":"date-time",
            "type":"string"
        },
        "xml":{
            "description":"Xml of the Content object",
            "type":"string"
        },
        "ratingsAggregate":{
            "description":"<p>The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "$ref":"#/definitions/AggregateFormResults"
        },
        "metaDataResourcePath":{
            "description":"MetaDataResourcePath of the Content object",
            "type":"string"
        },
        "owner":{
            "description":"<p>The user or author who owns or is responsible for the document. The following are the subfields that can be used with owner query parameter: </p> <ul> <li>owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=owner.recordId eq '{id}'</code></li> <li>owner.email : User's email.</li>  <li>owner.firstName : User's firstName.</li>  <li>owner.lastName : User's lastName.</li>  <li>owner.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "checkedOut":{
            "description":"<p>The date when an author has checked out or locked the document for editing.</p>",
            "type":"boolean"
        },
        "workflowStep":{
            "description":"<p>The step of the workflow in which the document version currently exist.</p>",
            "$ref":"#/definitions/WorkflowStepKey"
        },
        "locale":{
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>",
            "$ref":"#/definitions/LocaleKey"
        },
        "checkedOutBy":{
            "description":"<p>The user or author who performed the last content checkout. The following are the subfields that can be used with checkedOutBy query parameter: </p> <ul> <li>checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=checkedOutBy.recordId eq '{id}'</code></li> <li>checkedOutBy.email : User's email.</li>  <li>checkedOutBy.firstName : User's firstName.</li>  <li>checkedOutBy.lastName : User's lastName.</li>  <li>checkedOutBy.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "dateAdded":{
            "description":"<p>The date when the content was added to the content type. For legacy systems, the create date is the date when the document was migrated from the legacy system to the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "isForEdit":{
            "description":"<p>The parameter to request editable content.",
            "type":"boolean"
        },
        "latestContent":{
            "description":"<p>Latest BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "basedLocale":{
            "description":"<p>The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.</p>",
            "$ref":"#/definitions/LocaleKey"
        },
        "creator":{
            "description":"<p>The user who originally authored or created the document. The following are the subfields that can be used with creator query parameter: </p> <ul> <li>creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=creator.recordId eq '{id}'</code></li> <li>creator.email : User's email.</li>  <li>creator.firstName : User's firstName.</li>  <li>creator.lastName : User's lastName.</li>  <li>creator.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "version":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "resourcePath":{
            "description":"EXAMPLE URL : http://&lt;IM_REST_API_HOST&gt;/okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. If the user name is not passed then it will be defaulted to <b>'guest'</b> user.",
            "type":"string"
        },
        "title":{
            "description":"<p>The tittle of the document.</p>",
            "type":"string"
        },
        "displayStartDate":{
            "description":"<p>The date when the document will be available to display to end-users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "createDate":{
            "description":"<p>The date when the content was created. For legacy systems, the create date is the date when the document was created in those systems.</p>",
            "format":"date-time",
            "type":"string"
        },
        "published":{
            "description":"<p>The flag that indicates whether the document is published.</p>",
            "type":"boolean"
        },
        "publishedContent":{
            "description":"<p>Published BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "wfStepNotificationOverride":{
            "description":"<p>The date when the service sends notification to the author involved in the review. Once the workflow notification is given, the service updates the next review date.</p>",
            "format":"date-time",
            "type":"string"
        },
        "allTranslations":{
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
            "type":"array"
        },
        "schemaAttributes":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "userGroups":{
            "items":{
                "$ref":"#/definitions/UserGroupKey"
            },
            "description":"<p>The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone. </p>",
            "type":"array"
        },
        "views":{
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"<p>The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.</p>",
            "type":"array"
        },
        "publishedVersion":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "displayEndDate":{
            "description":"<p>The date when the service stops the display of the document to the end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "lastModifiedDate":{
            "description":"<p>The date when the content was last modified. For legacy systems, the lastModifiedDate date is the date when the document was last modified in those systems.</p>",
            "format":"date-time",
            "type":"string"
        },
        "versionId":{
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>",
            "type":"string"
        },
        "categories":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>The Category object or list of Category objects assigned to the Content.</p> <p>For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.</p> <p>The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.</p> <ul>  <b>Match Any</b>  <p>The service matches any of the category specified in the request if you pass the<code> contentType.refKey eq</code> parameter or <code>contentType.refKey in</code> parameter with the request.</p> <p>Example URIs for the category parameter are as follows:</p>   <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY</code></li>    <br/>    <p>The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY</code></li> <br/> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular</code> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the published Date.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the dateModified.</p></li>  </ul>  <ul> <b>Match  ALL</b> <p>The service matches all the categories specified in the request if you pass the<code> andcategories.refKey matchAll </code> parameter with the request.</code></p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY</code> <p>The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular</code> <p>The objects in the returned list are sorted by the view in descending order.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent</code> <p>The objects in the returned list are sorted by the published date descending order.</p></li> </ul>",
            "type":"array"
        },
        "answerId":{
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>",
            "type":"integer"
        },
        "rating":{
            "description":"<p>Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>.",
            "$ref":"#/definitions/DataForm"
        },
        "documentId":{
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>",
            "type":"string"
        }
    }
}

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

タイプ: object

タイトル: ContentModificationQualifier

ソースを表示

bypassWorkflowAndPublish(optional): boolean

レコードの保存後にワークフローをバイパスして、更新する既存のレコードを自動的に公開するかどうかを示すフラグ(存在する場合でも)。
ipAddress(optional): string

コンテンツを変更しているクライアントのIPアドレス
publish(optional): boolean

新規レコードを作成するか、更新する既存のレコードを保存後に自動的に公開するかを示すフラグ

{
    "title":"ContentModificationQualifier",
    "properties":{
        "bypassWorkflowAndPublish":{
            "description":"Flag indicating whether the existing record to be updated  should be published automatically by bypassing workflow (even if one exists) after saving the record.",
            "type":"boolean"
        },
        "publish":{
            "description":"Flag indicating whether the new record to be created  or existing record to be updated should be published automatically after saving it",
            "type":"boolean"
        },
        "ipAddress":{
            "description":"IP Address of the Client who is making modifications to Content",
            "type":"string"
        }
    }
}

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

タイプ: array

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

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

ソースを表示

Array of: object ContentKey

タイトル: ContentKey

{
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
    "type":"array"
}

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

タイプ: object

タイトル: ArticleStatusKey

ソースを表示

links(optional): array links
name(optional): string

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

ArticleStatusオブジェクトの一意の識別子。
referenceKey(optional): string

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

{
    "title":"ArticleStatusKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ArticleStatus object.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ArticleStatus object. <br/>ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the ArticleStatus object. The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: object

タイトル: LocaleKey

ソースを表示

links(optional): array links
recordId(optional): string

ロケール・オブジェクトの一意の識別子。

{
    "title":"LocaleKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Locale object.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

ネストされたスキーマ : カテゴリ

タイプ: 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

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

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
返されたリストのオブジェクトは、公開された日付の降順でソートされます。

ソースを表示

Array of: object CategoryKey

タイトル: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>The Category object or list of Category objects assigned to the Content.</p> <p>For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.</p> <p>The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.</p> <ul>  <b>Match Any</b>  <p>The service matches any of the category specified in the request if you pass the<code> contentType.refKey eq</code> parameter or <code>contentType.refKey in</code> parameter with the request.</p> <p>Example URIs for the category parameter are as follows:</p>   <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY</code></li>    <br/>    <p>The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY</code></li> <br/> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular</code> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the published Date.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the dateModified.</p></li>  </ul>  <ul> <b>Match  ALL</b> <p>The service matches all the categories specified in the request if you pass the<code> andcategories.refKey matchAll </code> parameter with the request.</code></p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY</code> <p>The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular</code> <p>The objects in the returned list are sorted by the view in descending order.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent</code> <p>The objects in the returned list are sorted by the published date descending order.</p></li> </ul>",
    "type":"array"
}

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

タイプ: object

タイトル: UserKey

ソースを表示

email(optional): string

ユーザー・オブジェクトの電子メール
externalId(optional): integer

ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
externalType(optional): string

ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
links(optional): array links
name(optional): string

ユーザーのフルネーム
recordId(optional): string

ユーザー・オブジェクトの一意のレコードID。

{
    "title":"UserKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the User object.",
            "type":"string"
        },
        "externalType":{
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"string"
        },
        "email":{
            "description":"Email of the User object",
            "type":"string"
        },
        "name":{
            "description":"User's full name",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"integer"
        }
    }
}

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

タイプ: object

タイトル: ContentTypeKey

ソースを表示

description(optional): string

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

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

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

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

ContentTypeオブジェクトの一意の識別子。
referenceKey(optional): string

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

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

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

{
    "title":"ContentTypeKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ContentType object.</p>",
            "type":"string"
        },
        "stripeCd":{
            "description":"<p>Lookup code that indicates the stripe code.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "description":{
            "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: object

タイトル: ContentKey

ソースを表示

allTranslations(optional): array allTranslations

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

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

アンサーとコンテンツ間のマッピングを可能にする一意の識別子。
articleStatus(optional): object ArticleStatusKey

タイトル: ArticleStatusKey
dateModified(optional): string(date-time)

Oracle Knowledge Repositoryでコンテンツが最後に変更された日付。
displayEndDate(optional): string(date-time)

サービスがエンド・ユーザーへのドキュメントの表示を停止する日付。
displayReviewDate(optional): string(date-time)

レビューを実行できる作成者によるレビューが文書に必要な日付。
displayStartDate(optional): string(date-time)

文書をエンドユーザーに表示できるようになる日付。
documentId(optional): string

コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。
latestContent(optional): object ContentKey

タイトル: ContentKey
links(optional): array links
locale(optional): object LocaleKey

タイトル: LocaleKey
publishedContent(optional): object ContentKey

タイトル: ContentKey
rating(optional): object DataForm

タイトル: DataForm
ratingsAggregate(optional): object AggregateFormResults

タイトル: AggregateFormResults
recordId(optional): string

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

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

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

ドキュメントのタイトル。
version(optional): string

コンテンツ・オブジェクトのバージョン
versionId(optional): string

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

{
    "title":"ContentKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "locale":{
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>",
            "$ref":"#/definitions/LocaleKey"
        },
        "allTranslations":{
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
            "type":"array"
        },
        "schemaAttributes":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "latestContent":{
            "description":"<p>Latest BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "version":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "displayReviewDate":{
            "description":"<p>The date when the document requires a review by an author capable of performing the review.</p>",
            "format":"date-time",
            "type":"string"
        },
        "title":{
            "description":"<p>The tittle of the document.</p>",
            "type":"string"
        },
        "ratingsAggregate":{
            "description":"<p>The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "$ref":"#/definitions/AggregateFormResults"
        },
        "displayStartDate":{
            "description":"<p>The date when the document will be available to display to end-users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "displayEndDate":{
            "description":"<p>The date when the service stops the display of the document to the end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "articleStatus":{
            "description":"<p>The article status.</p> <ul> <p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p> <p>Example URIs for the articleStatus parameter are as follows:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li>    <br/>    <p>The following example URIs returns Content objects whose contentState is LATEST:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li> </br>       <p>The following example URI returns Content objects with no article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li>    </br>       <p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li>    </br>       <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>    <br/>    <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>  </ul>",
            "$ref":"#/definitions/ArticleStatusKey"
        },
        "versionId":{
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>",
            "type":"string"
        },
        "answerId":{
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>",
            "type":"integer"
        },
        "rating":{
            "description":"<p>Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>.",
            "$ref":"#/definitions/DataForm"
        },
        "documentId":{
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>",
            "type":"string"
        },
        "publishedContent":{
            "description":"<p>Published BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: DataForm

ソースを表示

dateAdded(optional): string(date-time)

DataFormオブジェクトが作成または追加された日付
dateModified(optional): string(date-time)

DataFormオブジェクトが最後に変更された日付。
displayEndDate(optional): string(date-time)

DataFormオブジェクトのDisplayEndDate
displayStartDate(optional): string(date-time)

DataFormオブジェクトのDisplayStartDate
emailContent(optional): boolean

DataFormオブジェクトのEmailContent
links(optional): array links
name(optional): string

データ・フォームの名前。名前フィールドはソートにのみ使用できます。
questions(optional): array questions

質問と多数の関係
ratingType(optional): integer
5つ星評価かY/Nタイプの評価かを決定
- CUSTOM(0)
- YES(1)
- YES_NO(2)
- THREE_STARS(3)
- FIVE_STARS(4)
recordId(optional): string

DataFormオブジェクトの一意のレコードID。
referenceKey(optional): string

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

タイトル: UserKey
views(optional): array views

表示する関係が多すぎます

{
    "title":"DataForm",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataForm object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "displayStartDate":{
            "description":"DisplayStartDate of the DataForm object",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "emailContent":{
            "description":"EmailContent of the DataForm object",
            "type":"boolean"
        },
        "views":{
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"To Many Relationship to View",
            "type":"array"
        },
        "name":{
            "description":"The name of the data form.  The name field can only be used for sorting.",
            "type":"string"
        },
        "displayEndDate":{
            "description":"DisplayEndDate of the DataForm object",
            "format":"date-time",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the DataForm object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "ratingType":{
            "description":"Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>",
            "type":"integer"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/DataFormQuestion"
            },
            "description":"To Many Relationship to Question",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "user":{
            "description":"Relationship to User",
            "$ref":"#/definitions/UserKey"
        }
    }
}

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

タイプ: object

タイトル: AggregateFormResults

ソースを表示

links(optional): array links
questions(optional): array questions

AggregateQuestionResultとの関係が多すぎます
recordId(optional): string

AggregateFormResultsオブジェクトの一意のレコードID。
referenceKey(optional): string

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

AggregateFormResultsオブジェクトのTotalResponses

{
    "title":"AggregateFormResults",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateFormResults object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateFormResults object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateFormResults object. AggregateFormResults objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/AggregateQuestionResult"
            },
            "description":"To Many Relationship to AggregateQuestionResult",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

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

ソースを表示

Array of: object ReplacementToken

タイトル: ReplacementToken

{
    "items":{
        "$ref":"#/definitions/ReplacementToken"
    },
    "description":"<p>The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.</p>",
    "type":"array"
}

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

タイプ: array

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

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

ソースを表示

Array of: object SchemaAttribute

タイトル: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
    "type":"array"
}

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

タイプ: array

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

ソースを表示

Array of: object UserGroupKey

タイトル: UserGroupKey

{
    "items":{
        "$ref":"#/definitions/UserGroupKey"
    },
    "description":"<p>The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone. </p>",
    "type":"array"
}

ネストされたスキーマ : ビュー

タイプ: array

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

ソースを表示

Array of: object ViewKey

タイトル: ViewKey

{
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "description":"<p>The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.</p>",
    "type":"array"
}

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

タイプ: object

タイトル: WorkflowStepKey

ソースを表示

links(optional): array links
name(optional): string

ワークフロー・ステップのローカライズされた名前
recordId(optional): string

WORKFLOWSTEP表からのGUID
referenceKey(optional): string

ワークフロー・ステップのローカライズされていない名前

{
    "title":"WorkflowStepKey",
    "properties":{
        "recordId":{
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized name of the workflow step",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the workflow step",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: 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"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: CategoryKey

ソースを表示

childrenCount(optional): integer
このフィールドには、カテゴリの直下の子の数が返されます。

このフィールドは、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
description(optional): string

カテゴリ・オブジェクトの説明
externalId(optional): integer

リポジトリ・データを外部システムと統合する際に使用される一意の識別子。
externalType(optional): string

リポジトリ・データを外部システムと統合する際に使用されるカテゴリのタイプ。有効なオプションは、PRODUCTおよびCATEGORYです。
inventoryOrgId(optional): integer

特定の製品の在庫組織ID。
links(optional): array links
name(optional): string

カテゴリの名前。
objectId(optional): string

カテゴリの階層位置
parents(optional): array 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
recordId(optional): string

カテゴリ・オブジェクトの一意のレコードID。
referenceKey(optional): string

カテゴリ・オブジェクトの参照キー。カテゴリ・オブジェクトは複数の言語をサポートしています。このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。
responseLocale(optional): string

これは、翻訳された名前が見つからない場合に名前がデフォルト・ロケールに変換される場合に移入されるカスタム・フィールドです。

{
    "title":"CategoryKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique record ID of the Category object.</p>",
            "type":"string"
        },
        "responseLocale":{
            "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>",
            "type":"string"
        },
        "childrenCount":{
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>",
            "type":"integer"
        },
        "externalType":{
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>",
            "type":"string"
        },
        "parents":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
            "type":"array"
        },
        "referenceKey":{
            "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "objectId":{
            "description":"The hierarchichal position of the category",
            "type":"string"
        },
        "description":{
            "description":"Description of the Category object",
            "type":"string"
        },
        "name":{
            "description":"<p>The name of the category.</p>",
            "type":"string"
        },
        "inventoryOrgId":{
            "description":"<p>The inventory organization id of the specific product.</p>",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>",
            "type":"integer"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

ネストされたスキーマ : 両親

タイプ: 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

ソースを表示

Array of: object CategoryKey

タイトル: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
    "type":"array"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

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

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

ソースを表示

Array of: object ContentKey

タイトル: ContentKey

{
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
    "type":"array"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

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

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

ソースを表示

Array of: object SchemaAttribute

タイトル: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
    "type":"array"
}

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

タイプ: object

タイトル: SchemaAttribute

ソースを表示

allowMultipleNodes(optional): boolean

このタイプの複数のノードが許可されるかどうかを示すフラグ@since 8.3
allowPreselectedUserGroupChange(optional): boolean

エディタによる事前選択済ユーザー・グループ制限の変更の有効化 @since 8.3
children(optional): array children

現在の要素の子ノードのリスト
counter(optional): integer

この属性には、ContentType DOC IDカウンタの現在の値が含まれます。この値は、コンテンツがContentTypeに追加された後に変更しないでください
counterPrefix(optional): string

この属性には、DOC IDカウンタの前面に追加されるプレフィクスが含まれます
dateAdded(optional): string(date-time)

この属性は、SchemaAttribute定義が最初に作成された時点のタイムスタンプを表します
dateModified(optional): string(date-time)

この属性は、SchemaAttribute定義が最後に変更された時点のタイムスタンプを表します
description(optional): string

属性のローカライズされたヘルプ・テキスト。このテキストはオーサリング・ビューに表示されます
enableAttributeLevelSearch(optional): boolean

このフィールドを属性レベル検索用に構成する必要があるかどうかを示すフラグ - 例: TITLE='xyz'。このフィールドは以前、検索可能@since 8.3と呼ばれていました
enableFullTextSearch(optional): boolean

このフィールドを全文索引に含めるかどうかを示すフラグ。このフィールドは、以前は索引付け可能@since 8.3と呼ばれていました
includeInMasterIdentifier(optional): boolean

このフィールドをドキュメントのマスター識別子に追加する必要があるかどうかを示すフラグ
isNode(optional): boolean

この要素がノードであるかどうかを示すフラグ @since 8.3
isRequired(optional): boolean

属性を必須フィールドにします @since 8.3
links(optional): array links
localizedAttributes(optional): array localizedAttributes

様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト
name(optional): string

属性のローカライズされた名前。これはスキーマ内で一意である必要はありません。
readOnly(optional): boolean

このフィールドが編集可能かどうかを示すフラグ
recordId(optional): string

SchemaAttributeオブジェクトの一意の識別子
referenceKey(optional): string

属性のローカライズされていない名前です。 SchemaAttributeのreferenceKeyは、そのスキーマ内で一意である必要はありません。ただし、そのxpathはスキーマ内で一意になります。
requireWorkflowApproval(optional): boolean

ワークフローが使用可能な場合、属性にはワークフロー承認が必要です
schemaAttributeUserGroupList(optional): array schemaAttributeUserGroupList

この属性を保護するために使用できるユーザー・グループのリスト。これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります
schemaAttrType(optional):

許可された値: [ "TEXT_AREA", "WYSIWYG_EDIT", "TEXT_FIELD", "FILE", "BOOLEAN", "LIST", "COUNTER", "DATE", "DATETIME", "TIME", "INTEGER", "FLOAT" ]

属性のタイプを表す列挙型 - テキスト・フィールド、リッチ・テキスト領域など
securedFileResource(optional): boolean

この属性(ファイル・タイプのみ)をセキュアとしてマークする必要があるかどうかを示すフラグ - つまり、コンテンツXMLファイル付近の~secureフォルダに格納されます
secureWithUserGroups(optional): boolean

選択したユーザー・グループに属性を制限
securityRegex(optional): string

セキュリティ攻撃に対してフィールドを検証するために使用する正規表現。
sortOrder(optional): integer

編集フォーム内のスキーマ属性の表示順序
textHeight(optional): string

テキスト領域およびリッチ・テキスト・フィールドのテキストの高さを指定
textWidth(optional): string

テキスト・フィールドの最大長を指定
userGroupSelectionRequired(optional): boolean

属性にはユーザー・グループが必要です
wysiwygType(optional):

許可された値: [ "BASIC", "MEDIUM", "FULL" ]

WYSIWYGリッチ・テキスト・フィールドのタイプ - たとえば、FULL、BASIC、MEDIUM @since 8.3です
xpath(optional): string

スキーマ内のこの属性のXPATH。これはスキーマ内で一意です。

{
    "title":"SchemaAttribute",
    "properties":{
        "recordId":{
            "description":"Unique identifier for the SchemaAttribute object",
            "type":"string"
        },
        "textHeight":{
            "description":"Specifies the text height for text areas and rich text fields",
            "type":"string"
        },
        "dateModified":{
            "description":"This attribute represents the timestamp when the SchemaAttribute definition was last modified",
            "format":"date-time",
            "type":"string"
        },
        "wysiwygType":{
            "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM          @since 8.3",
            "enum":[
                "BASIC",
                "MEDIUM",
                "FULL"
            ]
        },
        "includeInMasterIdentifier":{
            "description":"Flag indicating whether this field should be appended to the master identifier of the document",
            "type":"boolean"
        },
        "allowMultipleNodes":{
            "description":"Flag indicating if multiple nodes are allowed of this type          @since 8.3",
            "type":"boolean"
        },
        "dateAdded":{
            "description":"This attribute represents the timestamp when the SchemaAttribute definition was first created",
            "format":"date-time",
            "type":"string"
        },
        "children":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"List of child nodes of the current element",
            "type":"array"
        },
        "securedFileResource":{
            "description":"Flag indicating if this attribute (file types only) should be marked as secure - i.e. stored in the ~secure folder near the content XML file",
            "type":"boolean"
        },
        "xpath":{
            "description":"The XPATH of this attribute within the schema. This is unique within the Schema.",
            "type":"string"
        },
        "description":{
            "description":"Localized help text for the attribute. This text is displayed in the authoring view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the attribute. This need NOT be unique within the Schema.",
            "type":"string"
        },
        "secureWithUserGroups":{
            "description":"Restrict attribute to selected user groups",
            "type":"boolean"
        },
        "userGroupSelectionRequired":{
            "description":"User groups are required for attribute",
            "type":"boolean"
        },
        "securityRegex":{
            "description":"The regular expression used to validate the field against security attacks.",
            "type":"string"
        },
        "sortOrder":{
            "description":"Display order of the schema attributes within the edit form",
            "type":"integer"
        },
        "counter":{
            "description":"This attribute contains the current value of the ContentType DOC ID counter. This value should not be changed after content is added to the ContentType",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "counterPrefix":{
            "description":"This attribute contains the prefix that is appended to the front of the DOC ID counter",
            "type":"string"
        },
        "textWidth":{
            "description":"Specifies the max length for text fields",
            "type":"string"
        },
        "allowPreselectedUserGroupChange":{
            "description":"Enable editors to modify preselected user group restrictions          @since 8.3",
            "type":"boolean"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
            "type":"array"
        },
        "isNode":{
            "description":"Flag indicating if this element is a node          @since 8.3",
            "type":"boolean"
        },
        "readOnly":{
            "description":"Flag indicating whether this field is editable",
            "type":"boolean"
        },
        "enableFullTextSearch":{
            "description":"Flag indicating whether this field should be included in the full text index. This field was previously           called indexable          @since 8.3",
            "type":"boolean"
        },
        "isRequired":{
            "description":"Make attribute a required field          @since 8.3",
            "type":"boolean"
        },
        "referenceKey":{
            "description":"Non localized name of the attribute. SchemaAttribute's referenceKey need NOT be unique within its Schema.  But its xpath will be unique within its Schema.",
            "type":"string"
        },
        "schemaAttributeUserGroupList":{
            "items":{
                "$ref":"#/definitions/SchemaAttributeUserGroup"
            },
            "description":"List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType",
            "type":"array"
        },
        "requireWorkflowApproval":{
            "description":"Attribute requires workflow approval if workflow is enabled",
            "type":"boolean"
        },
        "schemaAttrType":{
            "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
            "enum":[
                "TEXT_AREA",
                "WYSIWYG_EDIT",
                "TEXT_FIELD",
                "FILE",
                "BOOLEAN",
                "LIST",
                "COUNTER",
                "DATE",
                "DATETIME",
                "TIME",
                "INTEGER",
                "FLOAT"
            ]
        },
        "enableAttributeLevelSearch":{
            "description":"Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This field          was previously called searchable          @since 8.3",
            "type":"boolean"
        }
    }
}

ネストされたスキーマ : 子供

タイプ: array

現在の要素の子ノードのリスト

ソースを表示

Array of: object SchemaAttribute

タイトル: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"List of child nodes of the current element",
    "type":"array"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト

ソースを表示

Array of: object LocalizedAttributes

タイトル: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
    "type":"array"
}

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

タイプ: array

この属性を保護するために使用できるユーザー・グループのリスト。これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります

ソースを表示

Array of: object SchemaAttributeUserGroup

タイトル: SchemaAttributeUserGroup

{
    "items":{
        "$ref":"#/definitions/SchemaAttributeUserGroup"
    },
    "description":"List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType",
    "type":"array"
}

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

タイプ: object

タイトル: LocalizedAttributes

ソースを表示

description(optional): string

上のロケールでローカライズされた説明
localeId(optional): string

ロケールのRecordId - 通常、これはlocaleCode (en_USなど)であり、実際のGUIDではありません。
name(optional): string

上のロケールでローカライズされた名前

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

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

タイプ: object

タイトル: SchemaAttributeUserGroup

ソースを表示

defaultValue(optional): boolean

ユーザー・グループをデフォルトで選択する必要があるかどうかを示すフラグ
recordId(optional): string

XMLSCHEMAATTRIBUTEUSERGROUP表からのGUID
userGroup(optional): object UserGroupKey

タイトル: UserGroupKey

{
    "title":"SchemaAttributeUserGroup",
    "properties":{
        "recordId":{
            "description":"GUID from the XMLSCHEMAATTRIBUTEUSERGROUP table",
            "type":"string"
        },
        "userGroup":{
            "description":"Reference to the user group associated with this schema attribute",
            "$ref":"#/definitions/UserGroupKey"
        },
        "defaultValue":{
            "description":"Flag indiacting whether the user group should be selected by default",
            "type":"boolean"
        }
    }
}

ネストされたスキーマ : 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"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

ネストされたスキーマ : 質問

タイプ: array

質問と多数の関係

ソースを表示

Array of: object DataFormQuestion

タイトル: DataFormQuestion

{
    "items":{
        "$ref":"#/definitions/DataFormQuestion"
    },
    "description":"To Many Relationship to Question",
    "type":"array"
}

ネストされたスキーマ : ビュー

タイプ: array

表示する関係が多すぎます

ソースを表示

Array of: object ViewKey

タイトル: ViewKey

{
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "description":"To Many Relationship to View",
    "type":"array"
}

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

タイプ: object

タイトル: DataFormQuestion

ソースを表示

answers(optional): array answers

回答との関連性が多すぎます
dataForm(optional): object DataFormKey

タイトル: DataFormKey
dateAdded(optional): string(date-time)

DataFormQuestionオブジェクトが作成または追加された日付
dateModified(optional): string(date-time)

DataFormQuestionオブジェクトが最後に変更された日付。
isMasterIdentifier(optional): boolean

DataFormQuestionオブジェクトのIsMasterIdentifier
links(optional): array links
name(optional): string

DataFormQuestionオブジェクトの名前
recordId(optional): string

DataFormQuestionオブジェクトの一意のレコードID。
referenceKey(optional): string

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

DataFormQuestionオブジェクトの必須
sortOrder(optional): integer

DataFormQuestionオブジェクトのSortOrder
specialTypeIndicator(optional): integer

DataFormQuestionオブジェクトのSpecialTypeIndicator

{
    "title":"DataFormQuestion",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormQuestion object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormQuestion object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "isMasterIdentifier":{
            "description":"IsMasterIdentifier of the DataFormQuestion object",
            "type":"boolean"
        },
        "specialTypeIndicator":{
            "description":"SpecialTypeIndicator of the DataFormQuestion object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "sortOrder":{
            "description":"SortOrder of the DataFormQuestion object",
            "type":"integer"
        },
        "name":{
            "description":"Name of the DataFormQuestion object",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/DataFormAnswer"
            },
            "description":"To Many Relationship to Answer",
            "type":"array"
        },
        "dataForm":{
            "description":"Relationship to Rating",
            "$ref":"#/definitions/DataFormKey"
        },
        "dateAdded":{
            "description":"The date when the DataFormQuestion object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "required":{
            "description":"Required of the DataFormQuestion object",
            "type":"boolean"
        }
    }
}

ネストされたスキーマ : 答え

タイプ: array

回答との関連性が多すぎます

ソースを表示

Array of: object DataFormAnswer

タイトル: DataFormAnswer

{
    "items":{
        "$ref":"#/definitions/DataFormAnswer"
    },
    "description":"To Many Relationship to Answer",
    "type":"array"
}

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

タイプ: object

タイトル: DataFormKey

ソースを表示

links(optional): array links
recordId(optional): string

DataFormオブジェクトの一意のレコードID。
referenceKey(optional): string

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

{
    "title":"DataFormKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: DataFormAnswer

ソースを表示

dataFormQuestion(optional): object DataFormQuestionKey

タイトル: DataFormQuestionKey
dateAdded(optional): string(date-time)

DataFormAnswerオブジェクトが作成または追加された日付
dateModified(optional): string(date-time)

DataFormAnswerオブジェクトが最後に変更された日付。
defaultAnswer(optional): boolean

DataFormAnswerオブジェクトのDefaultAnswer
links(optional): array links
name(optional): string

DataFormAnswerオブジェクトの名前
numberValue(optional): integer

DataFormAnswerオブジェクトのNumberValue
recordId(optional): string

DataFormAnswerオブジェクトの一意のレコードID。
referenceKey(optional): string

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

DataFormAnswerオブジェクトのSortOrder

{
    "title":"DataFormAnswer",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormAnswer object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormAnswer object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormAnswer object. DataFormAnswer objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "sortOrder":{
            "description":"SortOrder of the DataFormAnswer object",
            "type":"integer"
        },
        "numberValue":{
            "description":"NumberValue of the DataFormAnswer object",
            "type":"integer"
        },
        "name":{
            "description":"Name of the DataFormAnswer object",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the DataFormAnswer object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "defaultAnswer":{
            "description":"DefaultAnswer of the DataFormAnswer object",
            "type":"boolean"
        },
        "dataFormQuestion":{
            "description":"Relationship to Question",
            "$ref":"#/definitions/DataFormQuestionKey"
        }
    }
}

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

タイプ: object

タイトル: DataFormQuestionKey

ソースを表示

links(optional): array links
recordId(optional): string

DataFormQuestionオブジェクトの一意のレコードID。
referenceKey(optional): string

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

{
    "title":"DataFormQuestionKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormQuestion object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: ViewKey

ソースを表示

links(optional): array links
name(optional): string

ビューのローカライズ名
recordId(optional): string

ビュー定義を含むSITE表のGUID
referenceKey(optional): string

ビューのローカライズされていない参照キー
stripeCD(optional): string

ビューのストライプ

{
    "title":"ViewKey",
    "properties":{
        "recordId":{
            "description":"GUID of the SITE table containing the view definition",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized reference key for the view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the view",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe of a view</p>",
            "type":"string"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

ネストされたスキーマ : 質問

タイプ: array

AggregateQuestionResultとの関係が多すぎます

ソースを表示

Array of: object AggregateQuestionResult

タイトル: AggregateQuestionResult

{
    "items":{
        "$ref":"#/definitions/AggregateQuestionResult"
    },
    "description":"To Many Relationship to AggregateQuestionResult",
    "type":"array"
}

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

タイプ: object

タイトル: AggregateQuestionResult

ソースを表示

answers(optional): array answers

AggregateAnswerResultとの関係が多すぎます
averageResponse(optional): number

AggregateQuestionResultオブジェクトのAverageResponse
name(optional): string

質問のローカライズされた表示名
recordId(optional): string

AggregateQuestionResultオブジェクトの一意のレコードID。
referenceKey(optional): string

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

AggregateQuestionResultオブジェクトのTotalResponses

{
    "title":"AggregateQuestionResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateQuestionResult object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateQuestionResult object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateQuestionResult object. AggregateQuestionResult objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "name":{
            "description":"Localized display name for the Question",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/AggregateAnswerResult"
            },
            "description":"To Many Relationship to AggregateAnswerResult",
            "type":"array"
        },
        "averageResponse":{
            "description":"AverageResponse of the AggregateQuestionResult object",
            "type":"number"
        }
    }
}

ネストされたスキーマ : 答え

タイプ: array

AggregateAnswerResultとの関係が多すぎます

ソースを表示

Array of: object AggregateAnswerResult

タイトル: AggregateAnswerResult

{
    "items":{
        "$ref":"#/definitions/AggregateAnswerResult"
    },
    "description":"To Many Relationship to AggregateAnswerResult",
    "type":"array"
}

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

タイプ: object

タイトル: AggregateAnswerResult

ソースを表示

name(optional): string

回答のローカライズされた表示名
recordId(optional): string

AggregateAnswerResultオブジェクトの一意のレコードID。
referenceKey(optional): string

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

AggregateAnswerResultオブジェクトのTotalResponses

{
    "title":"AggregateAnswerResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateAnswerResult object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateAnswerResult object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateAnswerResult object. AggregateAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "name":{
            "description":"Localized display name for the Answer",
            "type":"string"
        }
    }
}

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

タイプ: object

タイトル: ReplacementToken

ソースを表示

dateAdded(optional): string(date-time)

指定したロケールの置換トークンに追加された日付。
dateModified(optional): string(date-time)

指定したロケールの置換トークンの変更日。
links(optional): array links
recordId(optional): string

置換トークンのレコードID。
replacementText(optional): string

「HTML」書式付き置換テキスト。
replacementTextNonFormatted(optional): string

非HTML形式の置換テキスト。
tokenName(optional): string

置換トークンの名前。
tokenType(optional): string

トークンのトークン・タイプ。このトークンを作成/編集するために使用されたテキスト・エディタの種類を指定するために使用: リッチtext('RICH_TEXT')またはプレーンtext('PLAIN_TEXT')。

{
    "title":"ReplacementToken",
    "properties":{
        "recordId":{
            "description":"The replacement token's record Id.",
            "type":"string"
        },
        "tokenName":{
            "description":"The replacement token's name.",
            "type":"string"
        },
        "replacementText":{
            "description":"The HTML formatted replacement text.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date modified for the replacement token for the specified locale.",
            "format":"date-time",
            "type":"string"
        },
        "tokenType":{
            "description":"The token type of the token. Used to specify what kind of text editor was used to create/edit this token:  rich text('RICH_TEXT') or plain text('PLAIN_TEXT').",
            "type":"string"
        },
        "replacementTextNonFormatted":{
            "description":"The non-HTML formatted replacement text.",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date added for the replacement token for the specified locale.",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

トップに戻る

レスポンス

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

application/json
application/xml

200 レスポンス

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

ルート・スキーマ : コンテンツ

タイプ: object

タイトル: Content

ソースを表示

allTranslations(optional): array allTranslations

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

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

アンサーとコンテンツ間のマッピングを可能にする一意の識別子。
articleStatus(optional): object ArticleStatusKey

タイトル: ArticleStatusKey
basedLocale(optional): object LocaleKey

タイトル: LocaleKey
basedOnVersion(optional): string

コンテンツ・オブジェクトのバージョン
categories(optional): array categories
コンテンツに割り当てられたカテゴリ・オブジェクトまたはカテゴリ・オブジェクトのリスト。

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

カテゴリ・パラメータを使用すると、単一構成と複数構成の両方で、結果を第1レベル・カテゴリおよび階層カテゴリでフィルタできます。
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY
- http://<IM_REST_API_HOST>/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY
- 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でソートされます。
- 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
  返されたリストのオブジェクトは、公開された日付の降順でソートされます。
checkedOut(optional): boolean

作成者がドキュメントを編集のためにチェックアウトまたはロックした日付。
checkedOutBy(optional): object UserKey

タイトル: UserKey
contentType(optional): object ContentTypeKey

タイトル: ContentTypeKey
createDate(optional): string(date-time)

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

タイトル: UserKey
dateAdded(optional): string(date-time)

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

Oracle Knowledge Repositoryでコンテンツが最後に変更された日付。
displayEndDate(optional): string(date-time)

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

許可された値: [ "FIXED_AT_TOP", "PLACE_AT_TOP", "HISTORICAL_USEFULNESS" ]

Fixed@Top、Place@Top、Historical UsefulnessのLookUpコード
displayReviewDate(optional): string(date-time)

レビューを実行できる作成者によるレビューが文書に必要な日付。
displayStartDate(optional): string(date-time)

文書をエンドユーザーに表示できるようになる日付。
documentId(optional): string

コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。
eventEndDate(optional): string(date-time)

ドキュメントのイベントが終了する日付。
eventStartDate(optional): string(date-time)

ドキュメントのイベントが開始する日付。
isForEdit(optional): boolean

編集可能なコンテンツをリクエストするパラメータ。
lastModifiedDate(optional): string(date-time)

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

タイトル: UserKey
latestContent(optional): object ContentKey

タイトル: ContentKey
links(optional): array links
locale(optional): object LocaleKey

タイトル: LocaleKey
metaDataResourcePath(optional): string

コンテンツ・オブジェクトのMetaDataResourcePath
metaDataXml(optional): string

コンテンツ・オブジェクトのMetaDataXml
owner(optional): object UserKey

タイトル: UserKey
pending(optional): boolean

文書が公開待ちかどうかを示すフラグ。
priority(optional):

許可された値: [ "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は有効ではありません。
publishDate(optional): string(date-time)

文書がエンド・ユーザーに最初に表示される日付。
published(optional): boolean

文書が公開されているかどうかを示すフラグ。
publishedContent(optional): object ContentKey

タイトル: ContentKey
publishedVersion(optional): string

コンテンツ・オブジェクトのバージョン
rating(optional): object DataForm

タイトル: DataForm
ratingsAggregate(optional): object AggregateFormResults

タイトル: AggregateFormResults
reasonForEdit(optional): string

コンテンツを編集または作成する理由。これは、ドキュメントの作成または更新時にのみ使用されます。
recordId(optional): string

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

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

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

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

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

ドキュメントのタイトル。
userGroups(optional): array userGroups

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

コンテンツ・オブジェクトのバージョン
versionId(optional): string

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

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

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

タイトル: WorkflowStepKey
xml(optional): string

コンテンツ・オブジェクトのxml

{
    "title":"Content",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>",
            "type":"string"
        },
        "basedOnVersion":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "eventEndDate":{
            "description":"<p>The date when the document's event ends.</p>",
            "format":"date-time",
            "type":"string"
        },
        "contentType":{
            "description":"<p>The channel to which the content is categorized and saved. The following are the subfields that can be used with contentType query parameter: </p> <ul> <li>contentType.recordId : The unique identifier of the ContentType object.</li> <li>contentType.referenceKey : The reference key for the ContentType object. ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages. For Example to request articles for content type FAQ, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.referenceKey eq 'FAQ'</code></li> <li>contentType.allowRecommendations : The flag indicates whether the content type allows end users to create recommendations for its contents. This also indicates whether you can associate the recommended content with a content type.</li> </ul>",
            "$ref":"#/definitions/ContentTypeKey"
        },
        "displayReviewDate":{
            "description":"<p>The date when the document requires a review by an author capable of performing the review.</p>",
            "format":"date-time",
            "type":"string"
        },
        "displayPosition":{
            "description":"LookUp code that can be Fixed@Top, Place@Top , Historical Usefulness",
            "enum":[
                "FIXED_AT_TOP",
                "PLACE_AT_TOP",
                "HISTORICAL_USEFULNESS"
            ]
        },
        "priority":{
            "description":"<p>The priority assigned to the content.</p><p>The valid values are: PRIORITY_0 to PRIORITY_20. For example, PRIORITY_1 or PRIORITY_18 are valid values, but PRIORITY_21 is not.</p>",
            "enum":[
                "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"
            ]
        },
        "pending":{
            "description":"<p>The flag that indicates whether the document is pending for publication.</p>",
            "type":"boolean"
        },
        "lastModifier":{
            "description":"<p>The user or author who performed the last content modification. The following are the subfields that can be used with lastModifier query parameter: </p> <ul> <li>lastModifier.recordId : The unique identifier of the lastModifier object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=lastModifier.recordId eq '{id}'</code></li> <li>lastModifier.email : User's email.</li>  <li>lastModifier.firstName : User's firstName.</li>  <li>lastModifier.lastName : User's lastName.</li>  <li>lastModifier.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "articleStatus":{
            "description":"<p>The article status.</p> <ul> <p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p> <p>Example URIs for the articleStatus parameter are as follows:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li>    <br/>    <p>The following example URIs returns Content objects whose contentState is LATEST:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li> </br>       <p>The following example URI returns Content objects with no article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li>    </br>       <p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li>    </br>       <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>    <br/>    <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>  </ul>",
            "$ref":"#/definitions/ArticleStatusKey"
        },
        "reasonForEdit":{
            "description":"Reasons for editing or creating a content. This will only be used when creating or updating the document.",
            "type":"string"
        },
        "publishDate":{
            "description":"<p>The date when the document was first displayed to end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "replacementTokens":{
            "items":{
                "$ref":"#/definitions/ReplacementToken"
            },
            "description":"<p>The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.</p>",
            "type":"array"
        },
        "metaDataXml":{
            "description":"MetaDataXml of the Content object",
            "type":"string"
        },
        "eventStartDate":{
            "description":"<p>The date when the document's event begins.</p>",
            "format":"date-time",
            "type":"string"
        },
        "xml":{
            "description":"Xml of the Content object",
            "type":"string"
        },
        "ratingsAggregate":{
            "description":"<p>The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "$ref":"#/definitions/AggregateFormResults"
        },
        "metaDataResourcePath":{
            "description":"MetaDataResourcePath of the Content object",
            "type":"string"
        },
        "owner":{
            "description":"<p>The user or author who owns or is responsible for the document. The following are the subfields that can be used with owner query parameter: </p> <ul> <li>owner.recordId : The unique identifier of the owner object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=owner.recordId eq '{id}'</code></li> <li>owner.email : User's email.</li>  <li>owner.firstName : User's firstName.</li>  <li>owner.lastName : User's lastName.</li>  <li>owner.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "checkedOut":{
            "description":"<p>The date when an author has checked out or locked the document for editing.</p>",
            "type":"boolean"
        },
        "workflowStep":{
            "description":"<p>The step of the workflow in which the document version currently exist.</p>",
            "$ref":"#/definitions/WorkflowStepKey"
        },
        "locale":{
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>",
            "$ref":"#/definitions/LocaleKey"
        },
        "checkedOutBy":{
            "description":"<p>The user or author who performed the last content checkout. The following are the subfields that can be used with checkedOutBy query parameter: </p> <ul> <li>checkedOutBy.recordId : The unique identifier of the checkedOutBy object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=checkedOutBy.recordId eq '{id}'</code></li> <li>checkedOutBy.email : User's email.</li>  <li>checkedOutBy.firstName : User's firstName.</li>  <li>checkedOutBy.lastName : User's lastName.</li>  <li>checkedOutBy.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "dateAdded":{
            "description":"<p>The date when the content was added to the content type. For legacy systems, the create date is the date when the document was migrated from the legacy system to the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "isForEdit":{
            "description":"<p>The parameter to request editable content.",
            "type":"boolean"
        },
        "latestContent":{
            "description":"<p>Latest BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "basedLocale":{
            "description":"<p>The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.</p>",
            "$ref":"#/definitions/LocaleKey"
        },
        "creator":{
            "description":"<p>The user who originally authored or created the document. The following are the subfields that can be used with creator query parameter: </p> <ul> <li>creator.recordId : The unique identifier of the creator object. For example, to request an article with unique id, submit a call using the URI:<br />  <code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=creator.recordId eq '{id}'</code></li> <li>creator.email : User's email.</li>  <li>creator.firstName : User's firstName.</li>  <li>creator.lastName : User's lastName.</li>  <li>creator.login : User's login.</li>  </ul>",
            "$ref":"#/definitions/UserKey"
        },
        "version":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "resourcePath":{
            "description":"EXAMPLE URL : http://&lt;IM_REST_API_HOST&gt;/okcs/resources/{TENANTID}/content/draft/{CONTENTID}/{CONTENTTEXTID}/{FILENAME_WITH_EXTENSION}?login={USER_NAME}. If the user name is not passed then it will be defaulted to <b>'guest'</b> user.",
            "type":"string"
        },
        "title":{
            "description":"<p>The tittle of the document.</p>",
            "type":"string"
        },
        "displayStartDate":{
            "description":"<p>The date when the document will be available to display to end-users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "createDate":{
            "description":"<p>The date when the content was created. For legacy systems, the create date is the date when the document was created in those systems.</p>",
            "format":"date-time",
            "type":"string"
        },
        "published":{
            "description":"<p>The flag that indicates whether the document is published.</p>",
            "type":"boolean"
        },
        "publishedContent":{
            "description":"<p>Published BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "wfStepNotificationOverride":{
            "description":"<p>The date when the service sends notification to the author involved in the review. Once the workflow notification is given, the service updates the next review date.</p>",
            "format":"date-time",
            "type":"string"
        },
        "allTranslations":{
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
            "type":"array"
        },
        "schemaAttributes":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "userGroups":{
            "items":{
                "$ref":"#/definitions/UserGroupKey"
            },
            "description":"<p>The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone. </p>",
            "type":"array"
        },
        "views":{
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"<p>The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.</p>",
            "type":"array"
        },
        "publishedVersion":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "displayEndDate":{
            "description":"<p>The date when the service stops the display of the document to the end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "lastModifiedDate":{
            "description":"<p>The date when the content was last modified. For legacy systems, the lastModifiedDate date is the date when the document was last modified in those systems.</p>",
            "format":"date-time",
            "type":"string"
        },
        "versionId":{
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>",
            "type":"string"
        },
        "categories":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>The Category object or list of Category objects assigned to the Content.</p> <p>For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.</p> <p>The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.</p> <ul>  <b>Match Any</b>  <p>The service matches any of the category specified in the request if you pass the<code> contentType.refKey eq</code> parameter or <code>contentType.refKey in</code> parameter with the request.</p> <p>Example URIs for the category parameter are as follows:</p>   <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY</code></li>    <br/>    <p>The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY</code></li> <br/> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular</code> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the published Date.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the dateModified.</p></li>  </ul>  <ul> <b>Match  ALL</b> <p>The service matches all the categories specified in the request if you pass the<code> andcategories.refKey matchAll </code> parameter with the request.</code></p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY</code> <p>The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular</code> <p>The objects in the returned list are sorted by the view in descending order.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent</code> <p>The objects in the returned list are sorted by the published date descending order.</p></li> </ul>",
            "type":"array"
        },
        "answerId":{
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>",
            "type":"integer"
        },
        "rating":{
            "description":"<p>Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>.",
            "$ref":"#/definitions/DataForm"
        },
        "documentId":{
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>",
            "type":"string"
        }
    }
}

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

タイプ: array

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

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

ソースを表示

Array of: object ContentKey

タイトル: ContentKey

{
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
    "type":"array"
}

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

タイプ: object

タイトル: ArticleStatusKey

ソースを表示

links(optional): array links
name(optional): string

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

ArticleStatusオブジェクトの一意の識別子。
referenceKey(optional): string

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

{
    "title":"ArticleStatusKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ArticleStatus object.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ArticleStatus object. <br/>ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the ArticleStatus object. The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: object

タイトル: LocaleKey

ソースを表示

links(optional): array links
recordId(optional): string

ロケール・オブジェクトの一意の識別子。

{
    "title":"LocaleKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Locale object.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

ネストされたスキーマ : カテゴリ

タイプ: array

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

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

いずれかと一致

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

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

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

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

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
返されたリストのオブジェクトは、公開された日付の降順でソートされます。

ソースを表示

Array of: object CategoryKey

タイトル: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>The Category object or list of Category objects assigned to the Content.</p> <p>For example. If world is a category at level one, we may have Africa, Uk, America etc. at level two. You can specify requests for objects in a category hierarchically or non- hierarchically. If a content that is assigned Florida is requested using hierarchical request world, you get the result. Whereas, the same request done non- hierarchically gives no result.</p> <p>The category parameter lets you filter the result by first level category as well as hierarchical category in both single and multiple configurations.</p> <ul>  <b>Match Any</b>  <p>The service matches any of the category specified in the request if you pass the<code> contentType.refKey eq</code> parameter or <code>contentType.refKey in</code> parameter with the request.</p> <p>Example URIs for the category parameter are as follows:</p>   <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey eq 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey in ('WORLD')&mode=KEY</code></li>    <br/>    <p>The following example URIs returns Content objects which exist at the level of the specified category. This does not return the child Content objects.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey withNoChildren 'WORLD'&mode=KEY</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey inWithNoChildren ('WORLD')&mode=KEY</code></li> <br/> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request.</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentType.refKey in ('AGILE_CHANNEL', 'NEWS_CHANNEL') and categories.refKey inWithNoChildren ('USA', 'EUROPE')&mode=KEY&orderBy=mostPopular</code> <p>The following example URIs returns Content objects that match the multiple criterion specified in the request</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the published Date.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/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</code> <p>The objects in the returned list are sorted by the dateModified.</p></li>  </ul>  <ul> <b>Match  ALL</b> <p>The service matches all the categories specified in the request if you pass the<code> andcategories.refKey matchAll </code> parameter with the request.</code></p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY</code> <p>The request returns all Content objects in the world and movies category. The service returns a Content object in the category Africa because Africa is a child category for the category world.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'LATEST' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostPopular</code> <p>The objects in the returned list are sorted by the view in descending order.</p></li> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=contentState eq 'PUBLISHED' and contentType.refKey eq 'AGILE_CHANNEL' and categories.refKey matchAll ('WORLD', 'MOVIES')&mode=KEY&orderBy=mostRecent</code> <p>The objects in the returned list are sorted by the published date descending order.</p></li> </ul>",
    "type":"array"
}

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

タイプ: object

タイトル: UserKey

ソースを表示

email(optional): string

ユーザー・オブジェクトの電子メール
externalId(optional): integer

ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
externalType(optional): string

ExternalTypeは、外部システムからの対応するユーザーのタイプです。 ExternalIdとともに使用すると、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めることができます。
links(optional): array links
name(optional): string

ユーザーのフルネーム
recordId(optional): string

ユーザー・オブジェクトの一意のレコードID。

{
    "title":"UserKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the User object.",
            "type":"string"
        },
        "externalType":{
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"string"
        },
        "email":{
            "description":"Email of the User object",
            "type":"string"
        },
        "name":{
            "description":"User's full name",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"integer"
        }
    }
}

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

タイプ: object

タイトル: ContentTypeKey

ソースを表示

description(optional): string

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

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

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

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

ContentTypeオブジェクトの一意の識別子。
referenceKey(optional): string

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

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

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

{
    "title":"ContentTypeKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ContentType object.</p>",
            "type":"string"
        },
        "stripeCd":{
            "description":"<p>Lookup code that indicates the stripe code.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "description":{
            "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: object

タイトル: ContentKey

ソースを表示

allTranslations(optional): array allTranslations

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

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

アンサーとコンテンツ間のマッピングを可能にする一意の識別子。
articleStatus(optional): object ArticleStatusKey

タイトル: ArticleStatusKey
dateModified(optional): string(date-time)

Oracle Knowledge Repositoryでコンテンツが最後に変更された日付。
displayEndDate(optional): string(date-time)

サービスがエンド・ユーザーへのドキュメントの表示を停止する日付。
displayReviewDate(optional): string(date-time)

レビューを実行できる作成者によるレビューが文書に必要な日付。
displayStartDate(optional): string(date-time)

文書をエンドユーザーに表示できるようになる日付。
documentId(optional): string

コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。
latestContent(optional): object ContentKey

タイトル: ContentKey
links(optional): array links
locale(optional): object LocaleKey

タイトル: LocaleKey
publishedContent(optional): object ContentKey

タイトル: ContentKey
rating(optional): object DataForm

タイトル: DataForm
ratingsAggregate(optional): object AggregateFormResults

タイトル: AggregateFormResults
recordId(optional): string

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

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

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

ドキュメントのタイトル。
version(optional): string

コンテンツ・オブジェクトのバージョン
versionId(optional): string

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

{
    "title":"ContentKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "locale":{
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>",
            "$ref":"#/definitions/LocaleKey"
        },
        "allTranslations":{
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
            "type":"array"
        },
        "schemaAttributes":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "latestContent":{
            "description":"<p>Latest BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "version":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "displayReviewDate":{
            "description":"<p>The date when the document requires a review by an author capable of performing the review.</p>",
            "format":"date-time",
            "type":"string"
        },
        "title":{
            "description":"<p>The tittle of the document.</p>",
            "type":"string"
        },
        "ratingsAggregate":{
            "description":"<p>The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "$ref":"#/definitions/AggregateFormResults"
        },
        "displayStartDate":{
            "description":"<p>The date when the document will be available to display to end-users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "displayEndDate":{
            "description":"<p>The date when the service stops the display of the document to the end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "articleStatus":{
            "description":"<p>The article status.</p> <ul> <p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p> <p>Example URIs for the articleStatus parameter are as follows:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li>    <br/>    <p>The following example URIs returns Content objects whose contentState is LATEST:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li> </br>       <p>The following example URI returns Content objects with no article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li>    </br>       <p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li>    </br>       <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>    <br/>    <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>  </ul>",
            "$ref":"#/definitions/ArticleStatusKey"
        },
        "versionId":{
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>",
            "type":"string"
        },
        "answerId":{
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>",
            "type":"integer"
        },
        "rating":{
            "description":"<p>Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>.",
            "$ref":"#/definitions/DataForm"
        },
        "documentId":{
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>",
            "type":"string"
        },
        "publishedContent":{
            "description":"<p>Published BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: DataForm

ソースを表示

dateAdded(optional): string(date-time)

DataFormオブジェクトが作成または追加された日付
dateModified(optional): string(date-time)

DataFormオブジェクトが最後に変更された日付。
displayEndDate(optional): string(date-time)

DataFormオブジェクトのDisplayEndDate
displayStartDate(optional): string(date-time)

DataFormオブジェクトのDisplayStartDate
emailContent(optional): boolean

DataFormオブジェクトのEmailContent
links(optional): array links
name(optional): string

データ・フォームの名前。名前フィールドはソートにのみ使用できます。
questions(optional): array questions

質問と多数の関係
ratingType(optional): integer
5つ星評価かY/Nタイプの評価かを決定
- CUSTOM(0)
- YES(1)
- YES_NO(2)
- THREE_STARS(3)
- FIVE_STARS(4)
recordId(optional): string

DataFormオブジェクトの一意のレコードID。
referenceKey(optional): string

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

タイトル: UserKey
views(optional): array views

表示する関係が多すぎます

{
    "title":"DataForm",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataForm object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "displayStartDate":{
            "description":"DisplayStartDate of the DataForm object",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "emailContent":{
            "description":"EmailContent of the DataForm object",
            "type":"boolean"
        },
        "views":{
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"To Many Relationship to View",
            "type":"array"
        },
        "name":{
            "description":"The name of the data form.  The name field can only be used for sorting.",
            "type":"string"
        },
        "displayEndDate":{
            "description":"DisplayEndDate of the DataForm object",
            "format":"date-time",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the DataForm object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "ratingType":{
            "description":"Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>",
            "type":"integer"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/DataFormQuestion"
            },
            "description":"To Many Relationship to Question",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "user":{
            "description":"Relationship to User",
            "$ref":"#/definitions/UserKey"
        }
    }
}

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

タイプ: object

タイトル: AggregateFormResults

ソースを表示

links(optional): array links
questions(optional): array questions

AggregateQuestionResultとの関係が多すぎます
recordId(optional): string

AggregateFormResultsオブジェクトの一意のレコードID。
referenceKey(optional): string

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

AggregateFormResultsオブジェクトのTotalResponses

{
    "title":"AggregateFormResults",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateFormResults object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateFormResults object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateFormResults object. AggregateFormResults objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/AggregateQuestionResult"
            },
            "description":"To Many Relationship to AggregateQuestionResult",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object ReplacementToken

タイトル: ReplacementToken

{
    "items":{
        "$ref":"#/definitions/ReplacementToken"
    },
    "description":"<p>The object to create short, manageable terms (the tokenName). These tokens represent standardized, translatable, and sometimes complex content, such as integrated text, images, lists, and tables.</p>",
    "type":"array"
}

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

タイプ: array

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

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

ソースを表示

Array of: object SchemaAttribute

タイトル: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
    "type":"array"
}

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

タイプ: array

ソースを表示

Array of: object UserGroupKey

タイトル: UserGroupKey

{
    "items":{
        "$ref":"#/definitions/UserGroupKey"
    },
    "description":"<p>The user groups assigned to the content. Only the members of the assigned user group will have access to the content. Default value is Everyone. </p>",
    "type":"array"
}

ネストされたスキーマ : ビュー

タイプ: array

ソースを表示

Array of: object ViewKey

タイトル: ViewKey

{
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "description":"<p>The views assigned to the content. The user who has the view assigned to the content or the content type in which the content is saved can only access the content.</p>",
    "type":"array"
}

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

タイプ: object

タイトル: WorkflowStepKey

ソースを表示

links(optional): array links
name(optional): string

ワークフロー・ステップのローカライズされた名前
recordId(optional): string

WORKFLOWSTEP表からのGUID
referenceKey(optional): string

ワークフロー・ステップのローカライズされていない名前

{
    "title":"WorkflowStepKey",
    "properties":{
        "recordId":{
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized name of the workflow step",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the workflow step",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: 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"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: CategoryKey

ソースを表示

childrenCount(optional): integer
このフィールドには、カテゴリの直下の子の数が返されます。

このフィールドは、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
description(optional): string

カテゴリ・オブジェクトの説明
externalId(optional): integer

リポジトリ・データを外部システムと統合する際に使用される一意の識別子。
externalType(optional): string

リポジトリ・データを外部システムと統合する際に使用されるカテゴリのタイプ。有効なオプションは、PRODUCTおよびCATEGORYです。
inventoryOrgId(optional): integer

特定の製品の在庫組織ID。
links(optional): array links
name(optional): string

カテゴリの名前。
objectId(optional): string

カテゴリの階層位置
parents(optional): array 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
recordId(optional): string

カテゴリ・オブジェクトの一意のレコードID。
referenceKey(optional): string

カテゴリ・オブジェクトの参照キー。カテゴリ・オブジェクトは複数の言語をサポートしています。このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。
responseLocale(optional): string

これは、翻訳された名前が見つからない場合に名前がデフォルト・ロケールに変換される場合に移入されるカスタム・フィールドです。

{
    "title":"CategoryKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique record ID of the Category object.</p>",
            "type":"string"
        },
        "responseLocale":{
            "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>",
            "type":"string"
        },
        "childrenCount":{
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>",
            "type":"integer"
        },
        "externalType":{
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>",
            "type":"string"
        },
        "parents":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
            "type":"array"
        },
        "referenceKey":{
            "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "objectId":{
            "description":"The hierarchichal position of the category",
            "type":"string"
        },
        "description":{
            "description":"Description of the Category object",
            "type":"string"
        },
        "name":{
            "description":"<p>The name of the category.</p>",
            "type":"string"
        },
        "inventoryOrgId":{
            "description":"<p>The inventory organization id of the specific product.</p>",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>",
            "type":"integer"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

ネストされたスキーマ : 両親

タイプ: 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

ソースを表示

Array of: object CategoryKey

タイトル: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
    "type":"array"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

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

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

ソースを表示

Array of: object ContentKey

タイトル: ContentKey

{
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
    "type":"array"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

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

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

ソースを表示

Array of: object SchemaAttribute

タイトル: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
    "type":"array"
}

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

タイプ: object

タイトル: SchemaAttribute

ソースを表示

allowMultipleNodes(optional): boolean

このタイプの複数のノードが許可されるかどうかを示すフラグ@since 8.3
allowPreselectedUserGroupChange(optional): boolean

エディタによる事前選択済ユーザー・グループ制限の変更の有効化 @since 8.3
children(optional): array children

現在の要素の子ノードのリスト
counter(optional): integer

この属性には、ContentType DOC IDカウンタの現在の値が含まれます。この値は、コンテンツがContentTypeに追加された後に変更しないでください
counterPrefix(optional): string

この属性には、DOC IDカウンタの前面に追加されるプレフィクスが含まれます
dateAdded(optional): string(date-time)

この属性は、SchemaAttribute定義が最初に作成された時点のタイムスタンプを表します
dateModified(optional): string(date-time)

この属性は、SchemaAttribute定義が最後に変更された時点のタイムスタンプを表します
description(optional): string

属性のローカライズされたヘルプ・テキスト。このテキストはオーサリング・ビューに表示されます
enableAttributeLevelSearch(optional): boolean

このフィールドを属性レベル検索用に構成する必要があるかどうかを示すフラグ - 例: TITLE='xyz'。このフィールドは以前、検索可能@since 8.3と呼ばれていました
enableFullTextSearch(optional): boolean

このフィールドを全文索引に含めるかどうかを示すフラグ。このフィールドは、以前は索引付け可能@since 8.3と呼ばれていました
includeInMasterIdentifier(optional): boolean

このフィールドをドキュメントのマスター識別子に追加する必要があるかどうかを示すフラグ
isNode(optional): boolean

この要素がノードであるかどうかを示すフラグ @since 8.3
isRequired(optional): boolean

属性を必須フィールドにします @since 8.3
links(optional): array links
localizedAttributes(optional): array localizedAttributes

様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト
name(optional): string

属性のローカライズされた名前。これはスキーマ内で一意である必要はありません。
readOnly(optional): boolean

このフィールドが編集可能かどうかを示すフラグ
recordId(optional): string

SchemaAttributeオブジェクトの一意の識別子
referenceKey(optional): string

属性のローカライズされていない名前です。 SchemaAttributeのreferenceKeyは、そのスキーマ内で一意である必要はありません。ただし、そのxpathはスキーマ内で一意になります。
requireWorkflowApproval(optional): boolean

ワークフローが使用可能な場合、属性にはワークフロー承認が必要です
schemaAttributeUserGroupList(optional): array schemaAttributeUserGroupList

この属性を保護するために使用できるユーザー・グループのリスト。これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります
schemaAttrType(optional):

許可された値: [ "TEXT_AREA", "WYSIWYG_EDIT", "TEXT_FIELD", "FILE", "BOOLEAN", "LIST", "COUNTER", "DATE", "DATETIME", "TIME", "INTEGER", "FLOAT" ]

属性のタイプを表す列挙型 - テキスト・フィールド、リッチ・テキスト領域など
securedFileResource(optional): boolean

この属性(ファイル・タイプのみ)をセキュアとしてマークする必要があるかどうかを示すフラグ - つまり、コンテンツXMLファイル付近の~secureフォルダに格納されます
secureWithUserGroups(optional): boolean

選択したユーザー・グループに属性を制限
securityRegex(optional): string

セキュリティ攻撃に対してフィールドを検証するために使用する正規表現。
sortOrder(optional): integer

編集フォーム内のスキーマ属性の表示順序
textHeight(optional): string

テキスト領域およびリッチ・テキスト・フィールドのテキストの高さを指定
textWidth(optional): string

テキスト・フィールドの最大長を指定
userGroupSelectionRequired(optional): boolean

属性にはユーザー・グループが必要です
wysiwygType(optional):

許可された値: [ "BASIC", "MEDIUM", "FULL" ]

WYSIWYGリッチ・テキスト・フィールドのタイプ - たとえば、FULL、BASIC、MEDIUM @since 8.3です
xpath(optional): string

スキーマ内のこの属性のXPATH。これはスキーマ内で一意です。

{
    "title":"SchemaAttribute",
    "properties":{
        "recordId":{
            "description":"Unique identifier for the SchemaAttribute object",
            "type":"string"
        },
        "textHeight":{
            "description":"Specifies the text height for text areas and rich text fields",
            "type":"string"
        },
        "dateModified":{
            "description":"This attribute represents the timestamp when the SchemaAttribute definition was last modified",
            "format":"date-time",
            "type":"string"
        },
        "wysiwygType":{
            "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM          @since 8.3",
            "enum":[
                "BASIC",
                "MEDIUM",
                "FULL"
            ]
        },
        "includeInMasterIdentifier":{
            "description":"Flag indicating whether this field should be appended to the master identifier of the document",
            "type":"boolean"
        },
        "allowMultipleNodes":{
            "description":"Flag indicating if multiple nodes are allowed of this type          @since 8.3",
            "type":"boolean"
        },
        "dateAdded":{
            "description":"This attribute represents the timestamp when the SchemaAttribute definition was first created",
            "format":"date-time",
            "type":"string"
        },
        "children":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"List of child nodes of the current element",
            "type":"array"
        },
        "securedFileResource":{
            "description":"Flag indicating if this attribute (file types only) should be marked as secure - i.e. stored in the ~secure folder near the content XML file",
            "type":"boolean"
        },
        "xpath":{
            "description":"The XPATH of this attribute within the schema. This is unique within the Schema.",
            "type":"string"
        },
        "description":{
            "description":"Localized help text for the attribute. This text is displayed in the authoring view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the attribute. This need NOT be unique within the Schema.",
            "type":"string"
        },
        "secureWithUserGroups":{
            "description":"Restrict attribute to selected user groups",
            "type":"boolean"
        },
        "userGroupSelectionRequired":{
            "description":"User groups are required for attribute",
            "type":"boolean"
        },
        "securityRegex":{
            "description":"The regular expression used to validate the field against security attacks.",
            "type":"string"
        },
        "sortOrder":{
            "description":"Display order of the schema attributes within the edit form",
            "type":"integer"
        },
        "counter":{
            "description":"This attribute contains the current value of the ContentType DOC ID counter. This value should not be changed after content is added to the ContentType",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "counterPrefix":{
            "description":"This attribute contains the prefix that is appended to the front of the DOC ID counter",
            "type":"string"
        },
        "textWidth":{
            "description":"Specifies the max length for text fields",
            "type":"string"
        },
        "allowPreselectedUserGroupChange":{
            "description":"Enable editors to modify preselected user group restrictions          @since 8.3",
            "type":"boolean"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
            "type":"array"
        },
        "isNode":{
            "description":"Flag indicating if this element is a node          @since 8.3",
            "type":"boolean"
        },
        "readOnly":{
            "description":"Flag indicating whether this field is editable",
            "type":"boolean"
        },
        "enableFullTextSearch":{
            "description":"Flag indicating whether this field should be included in the full text index. This field was previously           called indexable          @since 8.3",
            "type":"boolean"
        },
        "isRequired":{
            "description":"Make attribute a required field          @since 8.3",
            "type":"boolean"
        },
        "referenceKey":{
            "description":"Non localized name of the attribute. SchemaAttribute's referenceKey need NOT be unique within its Schema.  But its xpath will be unique within its Schema.",
            "type":"string"
        },
        "schemaAttributeUserGroupList":{
            "items":{
                "$ref":"#/definitions/SchemaAttributeUserGroup"
            },
            "description":"List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType",
            "type":"array"
        },
        "requireWorkflowApproval":{
            "description":"Attribute requires workflow approval if workflow is enabled",
            "type":"boolean"
        },
        "schemaAttrType":{
            "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
            "enum":[
                "TEXT_AREA",
                "WYSIWYG_EDIT",
                "TEXT_FIELD",
                "FILE",
                "BOOLEAN",
                "LIST",
                "COUNTER",
                "DATE",
                "DATETIME",
                "TIME",
                "INTEGER",
                "FLOAT"
            ]
        },
        "enableAttributeLevelSearch":{
            "description":"Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This field          was previously called searchable          @since 8.3",
            "type":"boolean"
        }
    }
}

ネストされたスキーマ : 子供

タイプ: array

現在の要素の子ノードのリスト

ソースを表示

Array of: object SchemaAttribute

タイトル: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"List of child nodes of the current element",
    "type":"array"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト

ソースを表示

Array of: object LocalizedAttributes

タイトル: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
    "type":"array"
}

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

タイプ: array

ソースを表示

Array of: object SchemaAttributeUserGroup

タイトル: SchemaAttributeUserGroup

{
    "items":{
        "$ref":"#/definitions/SchemaAttributeUserGroup"
    },
    "description":"List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType",
    "type":"array"
}

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

タイプ: object

タイトル: LocalizedAttributes

ソースを表示

description(optional): string

上のロケールでローカライズされた説明
localeId(optional): string

ロケールのRecordId - 通常、これはlocaleCode (en_USなど)であり、実際のGUIDではありません。
name(optional): string

上のロケールでローカライズされた名前

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

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

タイプ: object

タイトル: SchemaAttributeUserGroup

ソースを表示

defaultValue(optional): boolean

ユーザー・グループをデフォルトで選択する必要があるかどうかを示すフラグ
recordId(optional): string

XMLSCHEMAATTRIBUTEUSERGROUP表からのGUID
userGroup(optional): object UserGroupKey

タイトル: UserGroupKey

{
    "title":"SchemaAttributeUserGroup",
    "properties":{
        "recordId":{
            "description":"GUID from the XMLSCHEMAATTRIBUTEUSERGROUP table",
            "type":"string"
        },
        "userGroup":{
            "description":"Reference to the user group associated with this schema attribute",
            "$ref":"#/definitions/UserGroupKey"
        },
        "defaultValue":{
            "description":"Flag indiacting whether the user group should be selected by default",
            "type":"boolean"
        }
    }
}

ネストされたスキーマ : 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"
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

ネストされたスキーマ : 質問

タイプ: array

質問と多数の関係

ソースを表示

Array of: object DataFormQuestion

タイトル: DataFormQuestion

{
    "items":{
        "$ref":"#/definitions/DataFormQuestion"
    },
    "description":"To Many Relationship to Question",
    "type":"array"
}

ネストされたスキーマ : ビュー

タイプ: array

表示する関係が多すぎます

ソースを表示

Array of: object ViewKey

タイトル: ViewKey

{
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "description":"To Many Relationship to View",
    "type":"array"
}

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

タイプ: object

タイトル: DataFormQuestion

ソースを表示

answers(optional): array answers

回答との関連性が多すぎます
dataForm(optional): object DataFormKey

タイトル: DataFormKey
dateAdded(optional): string(date-time)

DataFormQuestionオブジェクトが作成または追加された日付
dateModified(optional): string(date-time)

DataFormQuestionオブジェクトが最後に変更された日付。
isMasterIdentifier(optional): boolean

DataFormQuestionオブジェクトのIsMasterIdentifier
links(optional): array links
name(optional): string

DataFormQuestionオブジェクトの名前
recordId(optional): string

DataFormQuestionオブジェクトの一意のレコードID。
referenceKey(optional): string

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

DataFormQuestionオブジェクトの必須
sortOrder(optional): integer

DataFormQuestionオブジェクトのSortOrder
specialTypeIndicator(optional): integer

DataFormQuestionオブジェクトのSpecialTypeIndicator

{
    "title":"DataFormQuestion",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormQuestion object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormQuestion object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "isMasterIdentifier":{
            "description":"IsMasterIdentifier of the DataFormQuestion object",
            "type":"boolean"
        },
        "specialTypeIndicator":{
            "description":"SpecialTypeIndicator of the DataFormQuestion object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "sortOrder":{
            "description":"SortOrder of the DataFormQuestion object",
            "type":"integer"
        },
        "name":{
            "description":"Name of the DataFormQuestion object",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/DataFormAnswer"
            },
            "description":"To Many Relationship to Answer",
            "type":"array"
        },
        "dataForm":{
            "description":"Relationship to Rating",
            "$ref":"#/definitions/DataFormKey"
        },
        "dateAdded":{
            "description":"The date when the DataFormQuestion object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "required":{
            "description":"Required of the DataFormQuestion object",
            "type":"boolean"
        }
    }
}

ネストされたスキーマ : 答え

タイプ: array

回答との関連性が多すぎます

ソースを表示

Array of: object DataFormAnswer

タイトル: DataFormAnswer

{
    "items":{
        "$ref":"#/definitions/DataFormAnswer"
    },
    "description":"To Many Relationship to Answer",
    "type":"array"
}

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

タイプ: object

タイトル: DataFormKey

ソースを表示

links(optional): array links
recordId(optional): string

DataFormオブジェクトの一意のレコードID。
referenceKey(optional): string

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

{
    "title":"DataFormKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: DataFormAnswer

ソースを表示

dataFormQuestion(optional): object DataFormQuestionKey

タイトル: DataFormQuestionKey
dateAdded(optional): string(date-time)

DataFormAnswerオブジェクトが作成または追加された日付
dateModified(optional): string(date-time)

DataFormAnswerオブジェクトが最後に変更された日付。
defaultAnswer(optional): boolean

DataFormAnswerオブジェクトのDefaultAnswer
links(optional): array links
name(optional): string

DataFormAnswerオブジェクトの名前
numberValue(optional): integer

DataFormAnswerオブジェクトのNumberValue
recordId(optional): string

DataFormAnswerオブジェクトの一意のレコードID。
referenceKey(optional): string

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

DataFormAnswerオブジェクトのSortOrder

{
    "title":"DataFormAnswer",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormAnswer object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormAnswer object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormAnswer object. DataFormAnswer objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "sortOrder":{
            "description":"SortOrder of the DataFormAnswer object",
            "type":"integer"
        },
        "numberValue":{
            "description":"NumberValue of the DataFormAnswer object",
            "type":"integer"
        },
        "name":{
            "description":"Name of the DataFormAnswer object",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the DataFormAnswer object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "defaultAnswer":{
            "description":"DefaultAnswer of the DataFormAnswer object",
            "type":"boolean"
        },
        "dataFormQuestion":{
            "description":"Relationship to Question",
            "$ref":"#/definitions/DataFormQuestionKey"
        }
    }
}

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

タイプ: object

タイトル: DataFormQuestionKey

ソースを表示

links(optional): array links
recordId(optional): string

DataFormQuestionオブジェクトの一意のレコードID。
referenceKey(optional): string

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

{
    "title":"DataFormQuestionKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormQuestion object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: object

タイトル: ViewKey

ソースを表示

links(optional): array links
name(optional): string

ビューのローカライズ名
recordId(optional): string

ビュー定義を含むSITE表のGUID
referenceKey(optional): string

ビューのローカライズされていない参照キー
stripeCD(optional): string

ビューのストライプ

{
    "title":"ViewKey",
    "properties":{
        "recordId":{
            "description":"GUID of the SITE table containing the view definition",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized reference key for the view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the view",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe of a view</p>",
            "type":"string"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

ネストされたスキーマ : 質問

タイプ: array

AggregateQuestionResultとの関係が多すぎます

ソースを表示

Array of: object AggregateQuestionResult

タイトル: AggregateQuestionResult

{
    "items":{
        "$ref":"#/definitions/AggregateQuestionResult"
    },
    "description":"To Many Relationship to AggregateQuestionResult",
    "type":"array"
}

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

タイプ: object

タイトル: AggregateQuestionResult

ソースを表示

answers(optional): array answers

AggregateAnswerResultとの関係が多すぎます
averageResponse(optional): number

AggregateQuestionResultオブジェクトのAverageResponse
name(optional): string

質問のローカライズされた表示名
recordId(optional): string

AggregateQuestionResultオブジェクトの一意のレコードID。
referenceKey(optional): string

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

AggregateQuestionResultオブジェクトのTotalResponses

{
    "title":"AggregateQuestionResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateQuestionResult object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateQuestionResult object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateQuestionResult object. AggregateQuestionResult objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "name":{
            "description":"Localized display name for the Question",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/AggregateAnswerResult"
            },
            "description":"To Many Relationship to AggregateAnswerResult",
            "type":"array"
        },
        "averageResponse":{
            "description":"AverageResponse of the AggregateQuestionResult object",
            "type":"number"
        }
    }
}

ネストされたスキーマ : 答え

タイプ: array

AggregateAnswerResultとの関係が多すぎます

ソースを表示

Array of: object AggregateAnswerResult

タイトル: AggregateAnswerResult

{
    "items":{
        "$ref":"#/definitions/AggregateAnswerResult"
    },
    "description":"To Many Relationship to AggregateAnswerResult",
    "type":"array"
}

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

タイプ: object

タイトル: AggregateAnswerResult

ソースを表示

name(optional): string

回答のローカライズされた表示名
recordId(optional): string

AggregateAnswerResultオブジェクトの一意のレコードID。
referenceKey(optional): string

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

AggregateAnswerResultオブジェクトのTotalResponses

{
    "title":"AggregateAnswerResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateAnswerResult object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateAnswerResult object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateAnswerResult object. AggregateAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "name":{
            "description":"Localized display name for the Answer",
            "type":"string"
        }
    }
}

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

タイプ: object

タイトル: ReplacementToken

ソースを表示

dateAdded(optional): string(date-time)

指定したロケールの置換トークンに追加された日付。
dateModified(optional): string(date-time)

指定したロケールの置換トークンの変更日。
links(optional): array links
recordId(optional): string

置換トークンのレコードID。
replacementText(optional): string

「HTML」書式付き置換テキスト。
replacementTextNonFormatted(optional): string

非HTML形式の置換テキスト。
tokenName(optional): string

置換トークンの名前。
tokenType(optional): string

トークンのトークン・タイプ。このトークンを作成/編集するために使用されたテキスト・エディタの種類を指定するために使用: リッチtext('RICH_TEXT')またはプレーンtext('PLAIN_TEXT')。

{
    "title":"ReplacementToken",
    "properties":{
        "recordId":{
            "description":"The replacement token's record Id.",
            "type":"string"
        },
        "tokenName":{
            "description":"The replacement token's name.",
            "type":"string"
        },
        "replacementText":{
            "description":"The HTML formatted replacement text.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date modified for the replacement token for the specified locale.",
            "format":"date-time",
            "type":"string"
        },
        "tokenType":{
            "description":"The token type of the token. Used to specify what kind of text editor was used to create/edit this token:  rich text('RICH_TEXT') or plain text('PLAIN_TEXT').",
            "type":"string"
        },
        "replacementTextNonFormatted":{
            "description":"The non-HTML formatted replacement text.",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date added for the replacement token for the specified locale.",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

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

タイプ: array

ソースを表示

Array of: object instanceLink

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

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

トップに戻る

例

次の例は、リクエストで指定されたコンテンツ・ビジネス・オブジェクトをインポートする方法を示しています:

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

リクエスト本文の例

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

{
"content" :{
  "isForEdit": true,
  "views": [
    {
      "recordId": "BBA181DFB52148779A416184A191B2AF",
      "referenceKey": "SERVICE",
      "name": "Service"
    }
  ],
  "locale": {
    "recordId": "en_US"
  },
  "contentType": {
    "recordId": "98055D055BA8467B8097FB0B52923FD2",
    "referenceKey": "FAQ",
    "name": "FAQ"
  },

  "published": false,
  "recordId": "42346CE6A4E04813A857E9C776AD3CF8",
  "versionId": "1A87AFC4F7C94D479AF5C6F26807C3AB",
  "documentId": "FAQ15",
  "version": "1.0",
  "xml":"<FAQ><QUESTION><![CDATA[Questions for me ...]]></QUESTION><ANSWER><![CDATA[Answers for me ... ]]></ANSWER><SUMMARY><![CDATA[Summary in me]]></SUMMARY></FAQ>"
 },
  "contentModificationQualifier" : {
    "publish" : false,
    "bypassWorkflowAndPublish" : false
  }
}

レスポンス本文の例

次に、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": "42346CE6A4E04813A857E9C776AD3CF8",
  "versionId": "961B13A6ABD2479C819810E4372BE327",
  "documentId": "FAQ15",
  "title": "Summary in me",
  "version": "2.0",
  "answerId": 1001006,
  "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-26T14:13:26+0530",
  "links": [
    {
      "rel": "canonical",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content/42346CE6A4E04813A857E9C776AD3CF8",
      "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-26T14:11:49+0530",
  "lastModifiedDate": "2018-11-26T14:13:26+0530",
  "dateAdded": "2018-11-26T14:13:26+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[Questions for me ...]]></QUESTION><ANSWER><![CDATA[Answers for me ...]]></ANSWER><SUMMARY><![CDATA[Summary in me]]></SUMMARY></FAQ>",
  "resourcePath": "$STAGING_RESOURCE_HOST_URL/fusion/content/draft/42346CE6A4E04813A857E9C776AD3CF8/961B13A6ABD2479C819810E4372BE327/"
}

「トップに戻る」