機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

ロケール内のすべてのバージョンのコンテンツを公開

post

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

このメソッドは、指定したコンテンツ翻訳のすべてのバージョンをロケールで指定されたとおりに公開します。

コンテンツ・バージョンが公開されると、ライブまたは公開保留中に公開できます。 ライブで公開するには、コンテンツ・オブジェクトの現在の日付と時間がdisplayStartDateフィールドとdisplayEndDateフィールドの範囲内にある必要があります。 コンテンツ・オブジェクトがライブで公開されると、エンド・ユーザーが使用できるようになります。 公開を保留するには、コンテンツ・オブジェクトのdisplayStartDateフィールドを将来の日付に設定する必要があります。 その将来、コンテンツはライブで公開され、エンド・ユーザーが使用できるようになります。 ワークフロー・プロセスに残っているコンテンツ・オブジェクトのバージョンは公開されません。

レスポンス・エラー

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

• OKDOM-GEN0001

  このエラーは、idパラメータまたはlocaleIdパラメータの値が無効な場合に発生します。

リクエスト

パス・パラメータ

• id: string
  コンテンツ識別子
• localeCode: string
  ロケール・コード識別子

トップに戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

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

本文( )

ルート・スキーマ : ResultList ActionResult ContentKey

タイプ: object

タイトル: ResultList ActionResult ContentKey

ソースを表示

• count(optional): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(optional): boolean
  サーバーで使用可能なリソースが現在のページで返されたサブセットよりも多い場合にtrueに設定されるブール値。
• items(optional): array items
• limit(optional): integer
  サーバーが使用する実際のページング・サイズ。
• links(optional): array links
• offset(optional): integer
  現在のページで使用される相殺値。
• totalResults(optional): integer
  現在の範囲内のインスタンスと、リクエストを満たすサーバー上のインスタンスの両方を含む、リソース・インスタンスの合計数。

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

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

タイプ: array

ソースを表示

• Array of: object ActionResult ContentKey
  タイトル: ActionResult ContentKey

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

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

タイプ: array

ソースを表示

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

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

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

タイプ: object

タイトル: ActionResult ContentKey

ソースを表示

• errors(optional): array KMError Collection
  タイトル: KMError Collection

  KMErrorsのコレクション
• message(optional): string
  成功と失敗のメッセージが保持されます。
• operation(optional): string
  PUBLISH_ACTION、UNPUBLISH_ACTIONなどのように実行される操作。
• result(optional): object ContentKey
  タイトル: ContentKey
• status(optional):
  許可された値: [ "COMPLETED", "FAILED", "COMPLETED_WITH_WARNINGS" ]

  アクションが正常に完了したかどうか。
• warningMessage(optional): string
  ただ、意欲的なメッセージだけ。 操作は成功しましたが、警告があります。

{
    "title":"ActionResult ContentKey",
    "properties":{
        "message":{
            "description":"This will hold a success and failure message.",
            "type":"string"
        },
        "operation":{
            "description":"The operation performed like PUBLISH_ACTION, UNPUBLISH_ACTION, etc.",
            "type":"string"
        },
        "result":{
            "$ref":"#/definitions/ContentKey"
        },
        "errors":{
            "description":"List of errors",
            "$ref":"#/definitions/KMErrorCollection"
        },
        "status":{
            "description":"Whether the Action completed successfully or not!",
            "enum":[
                "COMPLETED",
                "FAILED",
                "COMPLETED_WITH_WARNINGS"
            ]
        },
        "warningMessage":{
            "description":"Only meant for Waring Kind of messages. Like operation was successful but with warnings.",
            "type":"string"
        }
    },
    "type":"object"
}

ネストされたスキーマ : KMErrorコレクション

タイプ: array

タイトル: KMError Collection

KMErrorsのコレクション

ソースを表示

• Array of: object KMError
  タイトル: KMError

{
    "title":"KMError Collection",
    "items":{
        "$ref":"#/definitions/KMError"
    },
    "description":"Collection of KMErrors",
    "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"
        }
    }
}

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

タイプ: object

タイトル: KMError

ソースを表示

• errorCode(optional): string
  このエラーのOracle Knowledge定義コード。
• errorPath(optional): string
  このエラーを適用するフィールドのXPath。
• title(optional): string
  エラー・メッセージのタイトル
• type(optional):
  許可された値: [ "VALIDATION", "AUTHENTICATION", "AUTHORIZATION", "APPLICATION" ]

  エラー・タイプ。

{
    "title":"KMError",
    "properties":{
        "title":{
            "description":"The error message title",
            "type":"string"
        },
        "errorCode":{
            "description":"The Oracle Knowledge defined code for this error.",
            "type":"string"
        },
        "type":{
            "description":"The error type.",
            "enum":[
                "VALIDATION",
                "AUTHENTICATION",
                "AUTHORIZATION",
                "APPLICATION"
            ]
        },
        "errorPath":{
            "description":"The XPath of the field to which this error applies.",
            "type":"string"
        }
    },
    "type":"object"
}

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

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

タイプ: array

ソースを表示

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

{
    "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"
        }
    }
}

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

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

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

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

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

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

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

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

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

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

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

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

トップに戻る

例

次の例は、ロケールで指定されたコンテンツ翻訳のすべてのバージョンを公開する方法を示しています:

curl -X POST "https://<IM_REST_API_HOST>/km/api/latest/content/{id}/publishAllVersionInThisLocale/{localeCode}" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

レスポンス本文の例

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

{
  "items": [
    {
      "result": {
        "recordId": "CA5811F397DC47578EA6DF343408D9BA",
        "versionId": "D2C011D0A5114D998C86F07943A2D137",
        "documentId": "FAQ12",
        "title": "Q query  Testing",
        "version": "1.0",
        "answerId": 1001002,
        "locale": {
          "recordId": "en_US"
        },
        "dateModified": "2018-11-26T13:29:35+0530"
      },
      "status": "COMPLETED",
      "operation": "PUBLISH_ACTION",
      "warningMessage": null,
      "message": "Content was Published for versionID D2C011D0A5114D998C86F07943A2D137",
      "errors": []
    }
  ],
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content/CA5811F397DC47578EA6DF343408D9BA/publishAllVersionInThisLocale/en_US?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 1
}

「トップに戻る」