機械翻訳について

ジャンプ先

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

記事を作成

post

/articles

リクエスト

問合せパラメータ

• fields: string
  このパラメータは、レスポンスで返されるフィールドをフィルタ処理します。レスポンス・スキーマを参照して、使用可能な値を確認します。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースおよびルート・フィールドのフィールドの書式 : ?fields=Attribute1;Child:Attribute1,Attribute2
• onlyData: boolean
  リンクがレスポンスで返されないようにします。デフォルトはfalseです。

  デフォルト値: false

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

• application/json
• multipart/form-data

リクエスト本文 - multipart/form-data ()

ルート・スキーマ : スキーマ

タイプ: object

BOモードのドキュメント: ContentBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• basedLocale: basedLocale
• basedOnVersion: string
  タイトル: Based On Version

  読取り専用: true

  最大長: 50

  この記事バージョンがローカリゼーションである場合、このフィールドにはローカリゼーションが作成された記事のバージョンが含まれている可能性があります。
• categories: array Categories
  タイトル: Categories

  記事に関連付けられたカテゴリのリスト。
• checkedOut: boolean
  タイトル: Checked Out

  読取り専用: true

  デフォルト値: false

  作成者がドキュメントを編集のためにチェックアウトまたはロックした日時。
• checkedOutBy: checkedOutBy
• contentBody(required): object Content Body
  タイトル: Content Body

  記事の内容。
• contentType(required): contentType
• createDate: string (date)
  タイトル: Create Date

  読取り専用: true

  この記事が最初に作成された日時。
• 作成者: 創造者
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この記事バージョンが作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• isForEdit: boolean
  タイトル: Is For Edit

  読取り専用: true

  デフォルト値: false

  リクエストの目的が記事の編集可能なバージョンを取得することだったかどうかを示します。 デフォルト値はfalseです。
• lastModifiedDate: string (date)
  タイトル: Last Modified Date

  読取り専用: true

  この記事が最後に変更された日時。
• lastModifier: lastModifier
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• 所有者: 持ち主
• pending: boolean
  タイトル: Pending

  読取り専用: true

  デフォルト値: false

  この記事バージョンが将来稼働するようにスケジュールされているかどうかを示します。 ほとんどの記事バージョンでは、値はfalseです。
• products: array Products
  タイトル: Products

  記事に関連付けられた製品のリスト。
• publishDate: string (date)
  タイトル: Publish Date

  読取り専用: true

  この記事バージョンが公開された日時。
• published: boolean
  タイトル: Published

  読取り専用: true

  デフォルト値: false

  この記事バージョンが公開されているかどうかを示します。 公開済バージョン以外のすべてのバージョンがある場合、デフォルト値はfalseです。
• publishedContent: publishedContent
• publishedVersion: string
  タイトル: Published Version

  読取り専用: true

  最大長: 50

  この記事にリクエストされたロケールで公開済バージョンがある場合、このフィールドには公開済記事バージョンのバージョン番号が含まれます。
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• reasonForEdit: string
  タイトル: Reason For Edit

  最大長: 2000

  記事バージョンを編集または作成する事由です。
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• sourceMetadata: sourceMetadata
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• userGroups: array User Groups
  タイトル: User Groups

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

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。
• views: array Views
  タイトル: Views

  読取り専用: true

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

{
    "description":"Documentation for BO mode: ContentBO",
    "required":[
        "locale",
        "contentType",
        "contentBody"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        },
        "basedLocale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"Based Locale",
                    "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
                    "readOnly":false
                }
            ]
        },
        "basedOnVersion":{
            "title":"Based On Version",
            "description":"If this article version is a localization, this field may contain the version of the article the localization was created from.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "checkedOut":{
            "title":"Checked Out",
            "description":"The date and time when an author has checked out or locked the document for editing.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "checkedOutBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Checked Out By",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "contentType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "createDate":{
            "format":"date",
            "title":"Create Date",
            "description":"The date and time when this article was originally created.",
            "type":"string",
            "readOnly":true
        },
        "creator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this article version was created.",
            "type":"string",
            "readOnly":true
        },
        "lastModifiedDate":{
            "format":"date",
            "title":"Last Modified Date",
            "description":"The date and time when this article was last modified. ",
            "type":"string",
            "readOnly":true
        },
        "lastModifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Modifier",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "owner":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "pending":{
            "title":"Pending",
            "description":"Indicates whether this article version is scheduled to go live in the future. The value is false for most article versions.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishDate":{
            "format":"date",
            "title":"Publish Date",
            "description":"The date and time when this article version was published.",
            "type":"string",
            "readOnly":true
        },
        "published":{
            "title":"Published",
            "description":"Indicates whether this article version is published. Default value is false for all versions other than the published version, if there is one.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishedVersion":{
            "title":"Published Version",
            "description":"If this article has a published version in the requested locale, this fields will contain the version number of the published article version.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "workflowStep":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepDataBO"
                },
                {
                    "title":"Workflow Step",
                    "description":"The step of the workflow in which the document version currently exist.",
                    "readOnly":true
                }
            ]
        },
        "contentBody":{
            "title":"Content Body",
            "description":"Contents of the article.",
            "type":"object",
            "readOnly":false
        },
        "reasonForEdit":{
            "title":"Reason For Edit",
            "description":"Reasons for editing or creating an article version.",
            "maxLength":2000,
            "type":"string",
            "readOnly":false
        },
        "categories":{
            "title":"Categories",
            "description":"The list of categories associated with the article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryItemKeyBO"
            },
            "readOnly":false
        },
        "isForEdit":{
            "title":"Is For Edit",
            "description":"Indicates whether the purpose of the request was to get an editable version of an article. Default value is false.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "products":{
            "title":"Products",
            "description":"The list of products associated with the article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductItemKeyBO"
            },
            "readOnly":false
        },
        "sourceMetadata":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentHistoryMetadataBO"
                },
                {
                    "title":"sourceMetadata",
                    "description":"Metadata used to provide context to the action which created or modified this content.",
                    "readOnly":false
                }
            ]
        },
        "userGroups":{
            "title":"User Groups",
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserGroupKeyBO"
            },
            "readOnly":false
        },
        "views":{
            "title":"Views",
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewKeyBO"
            },
            "readOnly":true
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Based Locale

  ドキュメントのローカライズされたバージョンの作成に使用されるソース・ロケール。 このフィールドは、コンテンツにローカライズされたバージョンがある場合にのみ表示されます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"Based Locale",
            "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Categories

記事に関連付けられたカテゴリのリスト。

ソースを表示

• Array of: object CategoryItemKeyBO
  BOモードのドキュメント: CategoryItemKeyBO

{
    "title":"Categories",
    "description":"The list of categories associated with the article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CategoryItemKeyBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Checked Out By

  読取り専用: true

  最後のコンテンツ・チェックアウトを実行したユーザーまたは作成者。 次に、checkedOutBy問合せパラメータで使用できるサブフィールドを示します:

  • checkedOutBy.recordId : checkedOutByオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : ユーザーの名。
  • checkedOutBy.lastName : ユーザーの姓。
  • checkedOutBy.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Checked Out By",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

タイプ: object

タイトル: Content Body

記事の内容。

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type

  コンテンツの分類および保存先となるチャネル。 次に、contentType問合せパラメータで使用できるサブフィールドを示します:

  • contentType.recordId : ContentTypeオブジェクトの一意の識別子。
  • contentType.referenceKey : ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。 コンテンツ・タイプのFAQの記事をリクエストする例については、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 創造者

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Creator

  読取り専用: true

  最初にドキュメントを作成または作成したユーザー。 作成者問合せパラメータで使用できるサブフィールドは次のとおりです:

  • creator.recordId : 作成者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : ユーザーの名。
  • creator.lastName : ユーザーの姓。
  • creator.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Modifier

  読取り専用: true

  最後のコンテンツ変更を実行したユーザーまたは作成者。 次に、lastModifier問合せパラメータで使用できるサブフィールドを示します:

  • lastModifier.recordId : lastModifierオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : ユーザーの名。
  • lastModifier.lastName : ユーザーの姓。
  • lastModifier.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Modifier",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 持ち主

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Owner

  読取り専用: true

  ドキュメントを所有または担当するユーザーまたは作成者。 次に、オーナー問合せパラメータで使用できるサブフィールドを示します:

  • owner.recordId : 所有者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
  • owner.email : ユーザーのeメール。
  • owner.firstName : ユーザーの名。
  • owner.lastName : ユーザーの姓。
  • owner.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 製品

タイプ: array

タイトル: Products

記事に関連付けられた製品のリスト。

ソースを表示

• Array of: object ProductItemKeyBO
  BOモードのドキュメント: ProductItemKeyBO

{
    "title":"Products",
    "description":"The list of products associated with the article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductItemKeyBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentHistoryMetadataBO
  コンテンツ履歴Metadata BO
• タイトル: sourceMetadata

  このコンテンツを作成または変更したアクションのコンテキストを提供するために使用されるMetadata。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentHistoryMetadataBO"
        },
        {
            "title":"sourceMetadata",
            "description":"Metadata used to provide context to the action which created or modified this content.",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : ユーザー・グループ

タイプ: array

タイトル: User Groups

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

ソースを表示

• Array of: object UserGroupKeyBO
  BOモードのドキュメント: UserGroupKeyBO

{
    "title":"User Groups",
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserGroupKeyBO"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Views

読取り専用: true

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

ソースを表示

• Array of: object ViewKeyBO
  BOモードのドキュメント: ViewKeyBO

{
    "title":"Views",
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepDataBO
  BOモードのドキュメント: WorkflowStepDataBO
• タイトル: Workflow Step

  読取り専用: true

  ドキュメント・バージョンが現在存在しているワークフローのステップ。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepDataBO"
        },
        {
            "title":"Workflow Step",
            "description":"The step of the workflow in which the document version currently exist.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: ContentDataBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• basedLocale: basedLocale
• basedOnVersion: string
  タイトル: Based On Version

  読取り専用: true

  最大長: 50

  この記事バージョンがローカリゼーションである場合、このフィールドにはローカリゼーションが作成された記事のバージョンが含まれている可能性があります。
• checkedOut: boolean
  タイトル: Checked Out

  読取り専用: true

  デフォルト値: false

  作成者がドキュメントを編集のためにチェックアウトまたはロックした日時。
• checkedOutBy: checkedOutBy
• contentType(required): contentType
• createDate: string (date)
  タイトル: Create Date

  読取り専用: true

  この記事が最初に作成された日時。
• 作成者: 創造者
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この記事バージョンが作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• lastModifiedDate: string (date)
  タイトル: Last Modified Date

  読取り専用: true

  この記事が最後に変更された日時。
• lastModifier: lastModifier
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• 所有者: 持ち主
• pending: boolean
  タイトル: Pending

  読取り専用: true

  デフォルト値: false

  この記事バージョンが将来稼働するようにスケジュールされているかどうかを示します。 ほとんどの記事バージョンでは、値はfalseです。
• publishDate: string (date)
  タイトル: Publish Date

  読取り専用: true

  この記事バージョンが公開された日時。
• published: boolean
  タイトル: Published

  読取り専用: true

  デフォルト値: false

  この記事バージョンが公開されているかどうかを示します。 公開済バージョン以外のすべてのバージョンがある場合、デフォルト値はfalseです。
• publishedContent: publishedContent
• publishedVersion: string
  タイトル: Published Version

  読取り専用: true

  最大長: 50

  この記事にリクエストされたロケールで公開済バージョンがある場合、このフィールドには公開済記事バージョンのバージョン番号が含まれます。
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• version: string
  タイトル: Version

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。
• workflowStep: workflowStep

{
    "description":"Documentation for BO mode: ContentDataBO",
    "required":[
        "locale",
        "contentType"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        },
        "basedLocale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"Based Locale",
                    "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
                    "readOnly":false
                }
            ]
        },
        "basedOnVersion":{
            "title":"Based On Version",
            "description":"If this article version is a localization, this field may contain the version of the article the localization was created from.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "checkedOut":{
            "title":"Checked Out",
            "description":"The date and time when an author has checked out or locked the document for editing.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "checkedOutBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Checked Out By",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "contentType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "createDate":{
            "format":"date",
            "title":"Create Date",
            "description":"The date and time when this article was originally created.",
            "type":"string",
            "readOnly":true
        },
        "creator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this article version was created.",
            "type":"string",
            "readOnly":true
        },
        "lastModifiedDate":{
            "format":"date",
            "title":"Last Modified Date",
            "description":"The date and time when this article was last modified. ",
            "type":"string",
            "readOnly":true
        },
        "lastModifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Modifier",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "owner":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "pending":{
            "title":"Pending",
            "description":"Indicates whether this article version is scheduled to go live in the future. The value is false for most article versions.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishDate":{
            "format":"date",
            "title":"Publish Date",
            "description":"The date and time when this article version was published.",
            "type":"string",
            "readOnly":true
        },
        "published":{
            "title":"Published",
            "description":"Indicates whether this article version is published. Default value is false for all versions other than the published version, if there is one.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishedVersion":{
            "title":"Published Version",
            "description":"If this article has a published version in the requested locale, this fields will contain the version number of the published article version.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "workflowStep":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepDataBO"
                },
                {
                    "title":"Workflow Step",
                    "description":"The step of the workflow in which the document version currently exist.",
                    "readOnly":true
                }
            ]
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Based Locale

  ドキュメントのローカライズされたバージョンの作成に使用されるソース・ロケール。 このフィールドは、コンテンツにローカライズされたバージョンがある場合にのみ表示されます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"Based Locale",
            "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Checked Out By

  読取り専用: true

  最後のコンテンツ・チェックアウトを実行したユーザーまたは作成者。 次に、checkedOutBy問合せパラメータで使用できるサブフィールドを示します:

  • checkedOutBy.recordId : checkedOutByオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : ユーザーの名。
  • checkedOutBy.lastName : ユーザーの姓。
  • checkedOutBy.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Checked Out By",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type

  コンテンツの分類および保存先となるチャネル。 次に、contentType問合せパラメータで使用できるサブフィールドを示します:

  • contentType.recordId : ContentTypeオブジェクトの一意の識別子。
  • contentType.referenceKey : ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。 コンテンツ・タイプのFAQの記事をリクエストする例については、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 創造者

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Creator

  読取り専用: true

  最初にドキュメントを作成または作成したユーザー。 作成者問合せパラメータで使用できるサブフィールドは次のとおりです:

  • creator.recordId : 作成者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : ユーザーの名。
  • creator.lastName : ユーザーの姓。
  • creator.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Modifier

  読取り専用: true

  最後のコンテンツ変更を実行したユーザーまたは作成者。 次に、lastModifier問合せパラメータで使用できるサブフィールドを示します:

  • lastModifier.recordId : lastModifierオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : ユーザーの名。
  • lastModifier.lastName : ユーザーの姓。
  • lastModifier.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Modifier",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 持ち主

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Owner

  読取り専用: true

  ドキュメントを所有または担当するユーザーまたは作成者。 次に、オーナー問合せパラメータで使用できるサブフィールドを示します:

  • owner.recordId : 所有者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
  • owner.email : ユーザーのeメール。
  • owner.firstName : ユーザーの名。
  • owner.lastName : ユーザーの姓。
  • owner.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepDataBO
  BOモードのドキュメント: WorkflowStepDataBO
• タイトル: Workflow Step

  読取り専用: true

  ドキュメント・バージョンが現在存在しているワークフローのステップ。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepDataBO"
        },
        {
            "title":"Workflow Step",
            "description":"The step of the workflow in which the document version currently exist.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: ContentKeyBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• publishedContent: publishedContent
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• version: string
  タイトル: Version

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。

{
    "description":"Documentation for BO mode: ContentKeyBO",
    "required":[
        "locale"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: ArticleStatusKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  このリソースに関連するコレクション・リンク
• name: string
  タイトル: Name

  読取り専用: true

  最小長: 1

  最大長: 255

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

  ArticleStatusオブジェクトの一意の識別子。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

{
    "description":"Documentation for BO mode: ArticleStatusKeyBO",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the ArticleStatus object. The name field can only be used for sorting.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":true,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ArticleStatus object.",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the ArticleStatus object. ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

このリソースに関連するコレクション・リンク

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"The collection links related to this resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ソースを表示

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string"
        },
        "sinceVersion":{
            "type":"string"
        }
    }
}

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

タイプ: object

ソースを表示

• autosaveType(required): autosaveType
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この自動保存が作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この自動保存が最後に変更された日時。
• documentId: string
  タイトル: Document Id

  読取り専用: true

  コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。
• locale: object LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• recordId: string
• title: string
  最大長: 4000

{
    "required":[
        "autosaveType"
    ],
    "type":"object",
    "properties":{
        "autosaveType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveType"
                },
                {
                    "nullable":false
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this autosave was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time this autosave was last modified.",
            "type":"string",
            "readOnly":true
        },
        "documentId":{
            "title":"Document Id",
            "description":"The unique identifier of a document that indicates the content type in which the content is saved.",
            "type":"string",
            "readOnly":true
        },
        "locale":{
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        "recordId":{
            "type":"string"
        },
        "title":{
            "maxLength":4000,
            "type":"string"
        }
    }
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "ALL", "CREATED", "EDITED", "TRANSLATED" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveType"
        },
        {
            "nullable":false
        }
    ]
}

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

タイプ: object

BOモードのドキュメント : LocaleKeyBO:

ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• localeDesc: string
  タイトル: Locale Desc

  読取り専用: true

  最大長: 100

  Localeオブジェクトが表す言語と国に関する説明。
• recordId: string
  タイトル: Record Id

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

{
    "description":"Documentation for BO mode: LocaleKeyBO: <p>Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)</p>",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "localeDesc":{
            "title":"Locale Desc",
            "description":"The description about the language and country that the Locale object represents.",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the Locale object.",
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ContentExternalAssociationBOのドキュメント

ソースを表示

• alternateId: string
  タイトル: Alternate Id

  外部関連付けの代替識別子
• alternateIdType: string
  タイトル: Alternate Id Type

  外部呼出しの代替タイプ
• objectId(required): string
  タイトル: Object Id

  最小長: 1

  最大長: 50

  外部関連付けの一意の識別子。
• properties: object Properties
  タイトル: Properties

  追加プロパティの許可: additionalProperties

  外部関連付けのプロパティ
• type(required): string
  タイトル: Object Type

  最小長: 1

  最大長: 100

  外部関連付けのタイプ

{
    "description":"Documentation for ContentExternalAssociationBO",
    "required":[
        "objectId",
        "type"
    ],
    "type":"object",
    "properties":{
        "alternateId":{
            "title":"Alternate Id",
            "description":"The alternate identifier of the external association",
            "type":"string"
        },
        "alternateIdType":{
            "title":"Alternate Id Type",
            "description":"The alternate type of the external assocation",
            "type":"string"
        },
        "objectId":{
            "title":"Object Id",
            "description":"The unique identifier of the external association.",
            "maxLength":50,
            "minLength":1,
            "type":"string",
            "nullable":false
        },
        "properties":{
            "title":"Properties",
            "description":"The properties of the external association",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "type":{
            "title":"Object Type",
            "description":"The type of the external association",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "nullable":false
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

タイトル: Properties

追加プロパティの許可

ソースを表示

• 文字列

{
    "title":"Properties",
    "description":"The properties of the external association",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

外部関連付けのプロパティ

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

タイプ: object

BOモードのドキュメント: DataFormBO

ソースを表示

• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このDataFormオブジェクトが作成された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このDataFormオブジェクトが最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  サービスがエンド・ユーザーへのデータ・フォームの表示を停止する日付
• displayStartDate: string (date)
  タイトル: Display Start Date

  データ・フォームをエンドユーザーに表示できるようになる日付
• emailContent: boolean
  タイトル: Email Content

  DataFormオブジェクトのemailContentフィールド
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

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

  質問と多数の関係
• ratingType: integer (int32)
  タイトル: Rating Type

  5つ星評価かY/Nタイプの評価かを決定

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  DataFormオブジェクトの参照キー
• ユーザー: ユーザー
• views: array Views
  タイトル: Views

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

{
    "description":"Documentation for BO mode: DataFormBO",
    "required":[
        "recordId",
        "referenceKey",
        "dateAdded",
        "dateModified"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataForm object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataForm object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this DataForm object was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this DataForm object was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date when the service stops the display of the data form to the end users",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date when the data form will be available to display to end-users",
            "type":"string",
            "readOnly":false
        },
        "emailContent":{
            "title":"Email Content",
            "description":"The emailContent field of the DataForm object",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The name of the data form.  The name field can only be used for sorting.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "ratingType":{
            "format":"int32",
            "title":"Rating Type",
            "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",
            "readOnly":false
        },
        "questions":{
            "title":"Questions",
            "description":"To Many Relationship to Question",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataFormQuestionBO"
            },
            "readOnly":false
        },
        "user":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"User",
                    "description":"Relationship to User",
                    "readOnly":false
                }
            ]
        },
        "views":{
            "title":"Views",
            "description":"To Many Relationship to View",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewKeyBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Questions

質問と多数の関係

ソースを表示

• Array of: object DataFormQuestionBO
  BOモードのドキュメント: QuestionBO

{
    "title":"Questions",
    "description":"To Many Relationship to Question",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataFormQuestionBO"
    },
    "readOnly":false
}

ネストされたスキーマ : ユーザー

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: User

  ユーザーとの関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"User",
            "description":"Relationship to User",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Views

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

ソースを表示

• Array of: object ViewKeyBO
  BOモードのドキュメント: ViewKeyBO

{
    "title":"Views",
    "description":"To Many Relationship to View",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewKeyBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: QuestionBO

ソースを表示

• answers: array Answers
  タイトル: Answers

  回答との関連性が多すぎます
• dataForm: dataForm
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  DataFormQuestionオブジェクトが作成された日時
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  DataFormQuestionオブジェクトが最後に変更された日時
• isMasterIdentifier: boolean
  タイトル: Is Master Identifier

  DataFormQuestionオブジェクトのisMasterIdentifierフィールド
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  DataFormQuestionオブジェクトのローカライズされた名前
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormQuestionオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormQuestionオブジェクトの参照キー
• required: boolean
  タイトル: Required

  この質問が必須かどうかを示すフラグ
• sortOrder: integer (int32)
  タイトル: Sort Order

  この質問のソート順
• specialTypeIndicator: integer (int32)
  タイトル: Special Type Indicator

  DataFormQuestionオブジェクトのspecialTypeIndicatorフィールド

{
    "description":"Documentation for BO mode: QuestionBO",
    "required":[
        "recordId",
        "dateAdded",
        "dateModified",
        "name"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormQuestion object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormQuestion object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time the DataFormQuestion object was created",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time the DataFormQuestion object was last modified",
            "type":"string",
            "readOnly":true
        },
        "isMasterIdentifier":{
            "title":"Is Master Identifier",
            "description":"The isMasterIdentifier field of the DataFormQuestion object",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the DataFormQuestion object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "required":{
            "title":"Required",
            "description":"The flag that indicates whether or not this question is required",
            "type":"boolean",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The sort order of this question",
            "type":"integer",
            "readOnly":false
        },
        "specialTypeIndicator":{
            "format":"int32",
            "title":"Special Type Indicator",
            "description":"The specialTypeIndicator field of the DataFormQuestion object",
            "type":"integer",
            "readOnly":false
        },
        "answers":{
            "title":"Answers",
            "description":"To Many Relationship to Answer",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataFormAnswerBO"
            },
            "readOnly":false
        },
        "dataForm":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormKeyBO"
                },
                {
                    "title":"Data Form",
                    "description":"Relationship to Rating",
                    "readOnly":false
                }
            ]
        }
    }
}

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

タイプ: array

タイトル: Answers

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

ソースを表示

• Array of: object DataFormAnswerBO
  BOモードのドキュメント: AnswerBO

{
    "title":"Answers",
    "description":"To Many Relationship to Answer",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataFormAnswerBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 DataFormKeyBO
  BOモードのドキュメント: DataFormKeyBO
• タイトル: Data Form

  評点との関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormKeyBO"
        },
        {
            "title":"Data Form",
            "description":"Relationship to Rating",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AnswerBO

ソースを表示

• dataFormQuestion: dataFormQuestion
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このDataFormAnswerオブジェクトが作成された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このDataFormAnswerオブジェクトが最後に変更された日時。
• defaultAnswer: boolean
  タイトル: Default Answer

  この回答がデフォルトの回答かどうかを示すフラグ
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  DataFormAnswerオブジェクトのローカライズされた名前
• numberValue: integer (int32)
  タイトル: Number Value

  回答の数値
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormAnswerオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormAnswerオブジェクトの参照キー
• sortOrder: integer (int32)
  タイトル: Sort Order

  回答のソート順

{
    "description":"Documentation for BO mode: AnswerBO",
    "required":[
        "recordId",
        "dateAdded",
        "dateModified",
        "name"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormAnswer object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormAnswer object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this DataFormAnswer object was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this DataFormAnswer object was last modified.",
            "type":"string",
            "readOnly":true
        },
        "defaultAnswer":{
            "title":"Default Answer",
            "description":"The flag that indicates whether or not this answer is the default answer",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the DataFormAnswer object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "numberValue":{
            "format":"int32",
            "title":"Number Value",
            "description":"The numeric value of the answer",
            "type":"integer",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The sort order of the answer",
            "type":"integer",
            "readOnly":false
        },
        "dataFormQuestion":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormQuestionKeyBO"
                },
                {
                    "title":"Data Form Question",
                    "description":"Relationship to Question",
                    "readOnly":false
                }
            ]
        }
    }
}

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

すべて一致

ソースを表示

• 「オブジェクト」 DataFormQuestionKeyBO
  BOモードのドキュメント: QuestionKeyBO
• タイトル: Data Form Question

  質問との関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormQuestionKeyBO"
        },
        {
            "title":"Data Form Question",
            "description":"Relationship to Question",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: QuestionKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormQuestionオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormQuestionオブジェクトの参照キー

{
    "description":"Documentation for BO mode: QuestionKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormQuestion object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormQuestion object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: DataFormKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  DataFormオブジェクトの参照キー

{
    "description":"Documentation for BO mode: DataFormKeyBO",
    "required":[
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataForm object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataForm object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: UserKeyBO

ソースを表示

• canAssignTask: boolean
  タイトル: Can Assign tasks

  このユーザーがタスクを他のユーザーに割り当てることができるかどうかを返します。
• contentTypePrivileges: array Content Type Privileges
  タイトル: Content Type Privileges

  このフィールドは、ユーザーが所有するすべてのcontenttype権限のリストを返します
• email: string
  タイトル: Email

  最大長: 100

  ユーザーの電子メール・アドレス
• externalId: integer (int64)
  タイトル: External Id

  読取り専用: true

  ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
• functionalPrivileges: object Functional Privileges of user
  タイトル: Functional Privileges of user

  追加プロパティの許可: additionalProperties

  このフィールドは、ユーザーが所有するすべての権限のリストを返します
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• login: string
  タイトル: Login

  最大長: 100

  ユーザーのログイン
• name: string
  タイトル: Name

  読取り専用: true

  最大長: 100

  ユーザーのフルネーム
• recordId(required): integer (int64)
  タイトル: Record Id

  読取り専用: true

  ユーザーの一意の識別子

{
    "description":"Documentation for BO mode: UserKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "canAssignTask":{
            "title":"Can Assign tasks",
            "description":"Returns whether this user can assign tasks to other users.",
            "type":"boolean",
            "readOnly":false
        },
        "contentTypePrivileges":{
            "title":"Content Type Privileges",
            "description":"This field will return list of all contenttype privileges user have",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeContentTypeBO"
            },
            "readOnly":false
        },
        "email":{
            "title":"Email",
            "description":"The user's e-mail address",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "externalId":{
            "format":"int64",
            "title":"External Id",
            "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",
            "readOnly":true
        },
        "functionalPrivileges":{
            "title":"Functional Privileges of user ",
            "description":"This field will return list of all fucntional privileges user have",
            "type":"object",
            "additionalProperties":{
                "type":"boolean"
            },
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "login":{
            "title":"Login",
            "description":"The user's login",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"User's full name",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "format":"int64",
            "title":"Record Id",
            "description":"The unique identifier of the user",
            "type":"integer",
            "readOnly":true
        }
    }
}

ネストされたスキーマ : コンテンツ・タイプ権限

タイプ: array

タイトル: Content Type Privileges

このフィールドは、ユーザーが所有するすべてのcontenttype権限のリストを返します

ソースを表示

• Array of: object CompositeContentTypeBO
  ContentTypeBOおよびそのフラット化されたリレーションの複合。 行にさらに内容を追加できることに注意してください

{
    "title":"Content Type Privileges",
    "description":"This field will return list of all contenttype privileges user have",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeContentTypeBO"
    },
    "readOnly":false
}

ネストされたスキーマ : ユーザーの機能権限

タイプ: object

タイトル: Functional Privileges of user

追加プロパティの許可

ソースを表示

• ブール

{
    "title":"Functional Privileges of user ",
    "description":"This field will return list of all fucntional privileges user have",
    "type":"object",
    "additionalProperties":{
        "type":"boolean"
    },
    "readOnly":false
}

このフィールドは、ユーザーが所有するすべての権限のリストを返します

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ContentTypeBOおよびそのフラット化されたリレーションの複合。 行にさらに内容を追加できることに注意してください

ソースを表示

• compositeWorkflowSteps(required): array WorkflowSteps Composite BO
  タイトル: WorkflowSteps Composite BO

  このコンテンツ・タイプにマップされたWorkflowStepsおよびそのコンテンツに対するユーザー権限
• contentTypeKeyBO(required): contentTypeKeyBO
• hasContentTypeAccess: boolean
  タイトル: Has Content Type Access

  ContentTypeBO権限がユーザーに対して有効かどうかを検証
• listOfPrivilege(required): array List Of Privilege
  タイトル: List Of Privilege

  ContentTypeの権限のリスト

{
    "description":"Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line",
    "required":[
        "compositeWorkflowSteps",
        "contentTypeKeyBO",
        "listOfPrivilege"
    ],
    "type":"object",
    "properties":{
        "compositeWorkflowSteps":{
            "title":"WorkflowSteps Composite BO",
            "description":"WorkflowSteps mapped to this content type and user privileges on that",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeWorkflowStepBO"
            },
            "readOnly":false,
            "nullable":false
        },
        "contentTypeKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type Key BO",
                    "description":"ContentBO object being created or updated",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "hasContentTypeAccess":{
            "title":"Has Content Type Access",
            "description":"Verifies if ContentTypeBO privileges are valid for user",
            "type":"boolean",
            "readOnly":false
        },
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the ContentType",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":false
        }
    }
}

ネストされたスキーマ : WorkflowStepsコンポジットBO

タイプ: array

タイトル: WorkflowSteps Composite BO

このコンテンツ・タイプにマップされたWorkflowStepsおよびそのコンテンツに対するユーザー権限

ソースを表示

• Array of: object CompositeWorkflowStepBO
  このステップに対するユーザー権限を持つWorkflowStepBOのコンポジット。

{
    "title":"WorkflowSteps Composite BO",
    "description":"WorkflowSteps mapped to this content type and user privileges on that",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeWorkflowStepBO"
    },
    "readOnly":false,
    "nullable":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type Key BO

  作成または更新されるContentBOオブジェクト

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type Key BO",
            "description":"ContentBO object being created or updated",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 権限のリスト

タイプ: array

タイトル: List Of Privilege

ContentTypeの権限のリスト

ソースを表示

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the ContentType",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false,
    "nullable":false
}

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

タイプ: object

このステップに対するユーザー権限を持つWorkflowStepBOのコンポジット。

ソースを表示

• listOfPrivilege(required): array List Of Privilege
  タイトル: List Of Privilege

  WorkflowStepの権限のリスト
• WorkflowStepKeyBO(required): WorkflowStepKeyBO

{
    "description":"Composite of WorkflowStepBO with user privileges on this step.",
    "required":[
        "listOfPrivilege",
        "WorkflowStepKeyBO"
    ],
    "type":"object",
    "properties":{
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the WorkflowStep",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":false
        },
        "WorkflowStepKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepKeyBO"
                },
                {
                    "title":"WorkflowStep Key BO",
                    "description":"WorkflowStep object being fetched",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        }
    }
}

ネストされたスキーマ : 権限のリスト

タイプ: array

タイトル: List Of Privilege

WorkflowStepの権限のリスト

ソースを表示

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the WorkflowStep",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false,
    "nullable":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepKeyBO
  BOモードのドキュメント: WorkflowStepKeyBO
• タイトル: WorkflowStep Key BO

  フェッチされるWorkflowStepオブジェクト

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepKeyBO"
        },
        {
            "title":"WorkflowStep Key BO",
            "description":"WorkflowStep object being fetched",
            "readOnly":false,
            "nullable":false
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: WorkflowStepKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ワークフロー・ステップのローカライズされた名前
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  WORKFLOWSTEP表からのGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

  ワークフロー・ステップのローカライズされていない名前
• workflowId(required): string
  タイトル: WorkflowRecord Id

  読取り専用: true

  WORKFLOW表からのGUID

{
    "description":"Documentation for BO mode: WorkflowStepKeyBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the workflow step",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: ContentTypeKeyBO

ソースを表示

• description: string
  タイトル: Description

  最大長: 255

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

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  ContentTypeオブジェクトの名前。 名前フィールドはソートにのみ使用できます。 コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。
• recordId: string
  タイトル: Record Id

  読取り専用: true

  ContentTypeオブジェクトの一意の識別子。
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

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

  最大長: 30

  ストライプ・コードを示す参照コード。
• usageCode: string
  タイトル: Usage Code

  読取り専用: true

  最大長: 30

  製品使用コードを示す参照コードです。
• ワークフロー: ワークフロー

{
    "description":"Documentation for BO mode: ContentTypeKeyBO",
    "required":[
        "name",
        "referenceKey",
        "stripeCd"
    ],
    "type":"object",
    "properties":{
        "description":{
            "title":"Description",
            "description":"The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The name for the ContentType object.  The name field can only be used for sorting. Content Types support multiple languages. This field identifies the object associated with the language specified by the user. ",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ContentType object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"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.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe Cd",
            "description":"Lookup code that indicates the stripe code.",
            "maxLength":30,
            "type":"string",
            "readOnly":false
        },
        "usageCode":{
            "title":"Usage Code",
            "description":"Lookup code that indicates the product usage code.",
            "maxLength":30,
            "type":"string",
            "readOnly":true
        },
        "workflow":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowKeyBO"
                },
                {
                    "title":"Workflow",
                    "description":"The workflow definition that the author can use while content authoring in a content type.",
                    "readOnly":false
                }
            ]
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ワークフロー

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowKeyBO
• タイトル: Workflow

  コンテンツ・タイプでのコンテンツ・オーサリング中に作成者が使用できるワークフロー定義。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowKeyBO"
        },
        {
            "title":"Workflow",
            "description":"The workflow definition that the author can use while content authoring in a content type.",
            "readOnly":false
        }
    ]
}

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

タイプ: object

ソースを表示

• enabled: boolean
• links: array links
• name: string
  最大長: 255
• recordId: string
• referenceKey: string
  最小長: 0

  最大長: 100
• workflowVersion: integer (int32)

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "name":{
            "maxLength":255,
            "type":"string"
        },
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "workflowVersion":{
            "format":"int32",
            "type":"integer"
        }
    }
}

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

タイプ: array

ソースを表示

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

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

タイプ: object

BOモードのドキュメント: ViewKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ビューのローカライズ名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  ビュー定義を含むSITE表のGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  ビューのローカライズされていない参照キー
• stripeCd: string
  タイトル: Stripe CD

  最大長: 30

  ビューのストライプ

{
    "description":"Documentation for BO mode: ViewKeyBO",
    "required":[
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the view",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID of the SITE table containing the view definition",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized reference key for the view",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe of a view",
            "maxLength":30,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: AggregateFormResultsBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• questions: array Questions
  タイトル: Questions

  AggregateQuestionResultとの関係が多すぎます
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateFormResultsオブジェクトの一意のレコードID。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

  AggregateFormResultsオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateFormResultsBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateFormResults object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateFormResults object",
            "type":"integer",
            "readOnly":false
        },
        "questions":{
            "title":"Questions",
            "description":"To Many Relationship to AggregateQuestionResult",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AggregateQuestionResultBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Questions

AggregateQuestionResultとの関係が多すぎます

ソースを表示

• Array of: object AggregateQuestionResultBO
  BOモードのドキュメント: AggregateQuestionResultBO

{
    "title":"Questions",
    "description":"To Many Relationship to AggregateQuestionResult",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AggregateQuestionResultBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AggregateQuestionResultBO

ソースを表示

• answers: array Answers
  タイトル: Answers

  AggregateAnswerResultとの関係が多すぎます
• averageResponse: number (double)
  タイトル: Average Response

  AggregateQuestionResultオブジェクトのAverageResponse
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  質問のローカライズされた表示名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateQuestionResultオブジェクトの一意のレコードID。
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

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

  AggregateQuestionResultオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateQuestionResultBO",
    "required":[
        "name",
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "description":"Localized display name for the Question",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateQuestionResult object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "averageResponse":{
            "format":"double",
            "title":"Average Response",
            "description":"AverageResponse of the AggregateQuestionResult object",
            "type":"number",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateQuestionResult object",
            "type":"integer",
            "readOnly":false
        },
        "answers":{
            "title":"Answers",
            "description":"To Many Relationship to AggregateAnswerResult",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AggregateAnswerResultBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Answers

AggregateAnswerResultとの関係が多すぎます

ソースを表示

• Array of: object AggregateAnswerResultBO
  BOモードのドキュメント: AggregateAnswerResultBO

{
    "title":"Answers",
    "description":"To Many Relationship to AggregateAnswerResult",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AggregateAnswerResultBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AggregateAnswerResultBO

ソースを表示

• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  回答のローカライズされた表示名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateAnswerResultオブジェクトの一意のレコードID。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

  AggregateAnswerResultオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateAnswerResultBO",
    "required":[
        "name",
        "recordId"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "description":"Localized display name for the Answer",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateAnswerResult object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateAnswerResult object",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

コンテンツ・レビュー情報ビジネス・オブジェクト

ソースを表示

• lastUpdateDate: string (date)
  タイトル: Last Update Date

  読取り専用: true

  文書がレビュー済としてマークされた日付。
• lastUpdatedBy: lastUpdatedBy
• 状態: 国家

{
    "description":"Content Review Information BO",
    "type":"object",
    "properties":{
        "lastUpdateDate":{
            "format":"date",
            "title":"Last Update Date",
            "description":"The date when the document was marked reviewed.",
            "type":"string",
            "readOnly":true
        },
        "lastUpdatedBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Updated By",
                    "description":"The user or author who marked document reviewed.",
                    "readOnly":true
                }
            ]
        },
        "state":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewState"
                },
                {
                    "title":"State",
                    "description":" review state for document.",
                    "readOnly":true
                }
            ]
        }
    }
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Updated By

  読取り専用: true

  レビュー済文書をマークしたユーザーまたは作成者。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Updated By",
            "description":"The user or author who marked document reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 国家

すべて一致

ソースを表示

• 文字列
  許可された値: [ "REVIEWED" ]
• タイトル: State

  読取り専用: true

  ドキュメントのレビュー状態。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewState"
        },
        {
            "title":"State",
            "description":" review state for document.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: SchemaAttributeBO

ソースを表示

• allowMultipleNodes: boolean
  タイトル: Allow Multiple Nodes

  このタイプの複数のノードが許可されるかどうかを示すフラグ@since 8.3
• allowPreselectedUserGroupChange: boolean
  タイトル: Allow Preselected User Group Change

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

  現在の要素の子ノードのリスト
• counter: integer (int32)
  タイトル: Counter

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

  最大長: 50

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

  読取り専用: true

  このSchemaAttribute定義が最初に作成された日時
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  このSchemaAttribute定義が最後に変更された日時
• description: string
  タイトル: Description

  最大長: 1000

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

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

  このフィールドを全文索引に含めるかどうかを示すフラグ。 このフィールドは、以前は索引可能と呼ばれていました@since 8.3
• includeInMasterIdentifier: boolean
  タイトル: Include In Master Identifier

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

  この要素がノードであるかどうかを示すフラグ@since 8.3
• isRequired: boolean
  タイトル: Is Required

  属性を必須フィールドにします@since 8.3
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• localizedAttributes: array Localized Attributes
  タイトル: Localized Attributes

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

  最小長: 1

  最大長: 255

  属性のローカライズされた名前。 これはスキーマ内で一意である必要はありません。
• readOnly: boolean
  タイトル: Read Only

  このフィールドが編集可能かどうかを示すフラグ
• recordId: string
  タイトル: Record Id

  読取り専用: true

  SchemaAttributeオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

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

  ワークフローが使用可能な場合、属性にはワークフロー承認が必要です
• schemaAttributeUserGroupList: array Schema Attribute User Group List
  タイトル: Schema Attribute User Group List

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

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

  選択したユーザー・グループに属性を制限
• securityRegex: string
  タイトル: Security Regex

  最大長: 100

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

  編集フォーム内のスキーマ属性の表示順序
• textHeight: string
  タイトル: Text Height

  最大長: 10

  テキスト領域およびリッチ・テキスト・フィールドのテキストの高さを指定
• textWidth: string
  タイトル: Text Width

  最大長: 10

  テキスト・フィールドの最大長を指定
• userGroupSelectionRequired: boolean
  タイトル: User Group Selection Required

  属性にはユーザー・グループが必要です
• wysiwygType: wysiwygType
• xpath: string
  タイトル: Xpath

  最大長: 2000

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

{
    "description":"Documentation for BO mode: SchemaAttributeBO",
    "required":[
        "name",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the attribute. This need NOT be unique within the Schema.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"Unique identifier for the SchemaAttribute object",
            "type":"string",
            "readOnly":true
        },
        "xpath":{
            "title":"Xpath",
            "description":"The XPATH of this attribute within the schema. This is unique within the Schema.",
            "maxLength":2000,
            "type":"string",
            "readOnly":false
        },
        "allowMultipleNodes":{
            "title":"Allow Multiple Nodes",
            "description":"Flag indicating if multiple nodes are allowed of this type@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "allowPreselectedUserGroupChange":{
            "title":"Allow Preselected User Group Change",
            "description":"Enable editors to modify preselected user group restrictions@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "counter":{
            "format":"int32",
            "title":"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",
            "readOnly":false
        },
        "counterPrefix":{
            "title":"Counter Prefix",
            "description":"This attribute contains the prefix that is appended to the front of the DOC ID counter",
            "maxLength":50,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this SchemaAttribute definition was first created",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this SchemaAttribute definition was last modified",
            "type":"string",
            "readOnly":true
        },
        "description":{
            "title":"Description",
            "description":"Localized help text for the attribute. This text is displayed in the authoring view",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        },
        "enableAttributeLevelSearch":{
            "title":"Enable Attribute Level Search",
            "description":"Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This fieldwas previously called searchable@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "enableFullTextSearch":{
            "title":"Enable Full Text Search",
            "description":"Flag indicating whether this field should be included in the full text index. This field was previouslycalled indexable@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "includeInMasterIdentifier":{
            "title":"Include In Master Identifier",
            "description":"Flag indicating whether this field should be appended to the master identifier of the document",
            "type":"boolean",
            "readOnly":false
        },
        "isNode":{
            "title":"Is Node",
            "description":"Flag indicating if this element is a node@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "isRequired":{
            "title":"Is Required",
            "description":"Make attribute a required field@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "readOnly":{
            "title":"Read Only",
            "description":"Flag indicating whether this field is editable",
            "type":"boolean",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "requireWorkflowApproval":{
            "title":"Require Workflow Approval",
            "description":"Attribute requires workflow approval if workflow is enabled",
            "type":"boolean",
            "readOnly":false
        },
        "schemaAttrType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SchemaAttributeTypeEnum"
                },
                {
                    "title":"Schema Attr Type",
                    "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
                    "readOnly":false
                }
            ]
        },
        "secureWithUserGroups":{
            "title":"Secure With User Groups",
            "description":"Restrict attribute to selected user groups",
            "type":"boolean",
            "readOnly":false
        },
        "securedFileResource":{
            "title":"Secured File Resource",
            "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",
            "readOnly":false
        },
        "securityRegex":{
            "title":"Security Regex",
            "description":"The regular expression used to validate the field against security attacks.",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"Display order of the schema attributes within the edit form",
            "type":"integer",
            "readOnly":false
        },
        "textHeight":{
            "title":"Text Height",
            "description":"Specifies the text height for text areas and rich text fields",
            "maxLength":10,
            "type":"string",
            "readOnly":false
        },
        "textWidth":{
            "title":"Text Width",
            "description":"Specifies the max length for text fields",
            "maxLength":10,
            "type":"string",
            "readOnly":false
        },
        "userGroupSelectionRequired":{
            "title":"User Group Selection Required",
            "description":"User groups are required for attribute",
            "type":"boolean",
            "readOnly":false
        },
        "wysiwygType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WysiwygTypeEnum"
                },
                {
                    "title":"Wysiwyg Type",
                    "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM@since 8.3",
                    "readOnly":false
                }
            ]
        },
        "children":{
            "title":"Children",
            "description":"List of child nodes of the current element",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":false
        },
        "localizedAttributes":{
            "title":"Localized Attributes",
            "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocalizedAttributesBO"
            },
            "readOnly":false
        },
        "schemaAttributeUserGroupList":{
            "title":"Schema Attribute User Group List",
            "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",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeUserGroupBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Children

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

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Children",
    "description":"List of child nodes of the current element",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

ネストされたスキーマ : ローカライズされた属性

タイプ: array

タイトル: Localized Attributes

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

ソースを表示

• Array of: object LocalizedAttributesBO

{
    "title":"Localized Attributes",
    "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LocalizedAttributesBO"
    },
    "readOnly":false
}

ネストされたスキーマ : スキーマ属性ユーザー・グループ・リスト

タイプ: array

タイトル: Schema Attribute User Group List

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

ソースを表示

• Array of: object SchemaAttributeUserGroupBO

{
    "title":"Schema Attribute User Group List",
    "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",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeUserGroupBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "BOOLEAN", "COUNTER", "DATE", "DATETIME", "FILE", "FLOAT", "INTEGER", "LIST", "TEXT_AREA", "TEXT_FIELD", "TIME", "WYSIWYG_EDIT" ]
• タイトル: Schema Attr Type

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SchemaAttributeTypeEnum"
        },
        {
            "title":"Schema Attr Type",
            "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "BASIC", "FULL", "MEDIUM" ]
• タイトル: Wysiwyg Type

  WYSIWYGリッチ・テキスト・フィールドのタイプ - i.e. FULL, BASIC, MEDIUM@since 8.3

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WysiwygTypeEnum"
        },
        {
            "title":"Wysiwyg Type",
            "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM@since 8.3",
            "readOnly":false
        }
    ]
}

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

タイプ: object

ソースを表示

• description: string
  タイトル: Description

  最大長: 1000

  上のロケールでローカライズされた説明
• localeId(required): string
  タイトル: Locale Id

  読取り専用: true

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

  最小長: 1

  最大長: 255

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

{
    "description":"",
    "required":[
        "localeId",
        "name"
    ],
    "type":"object",
    "properties":{
        "description":{
            "title":"Description",
            "description":"Localized description in the above Locale",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        },
        "localeId":{
            "title":"Locale Id",
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string",
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized Name in the above Locale",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        }
    }
}

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

タイプ: object

ソースを表示

• defaultValue: boolean
• recordId: string
• userGroup: object UserGroupKeyBO
  BOモードのドキュメント: UserGroupKeyBO

{
    "type":"object",
    "properties":{
        "defaultValue":{
            "type":"boolean"
        },
        "recordId":{
            "type":"string"
        },
        "userGroup":{
            "$ref":"#/components/schemas/UserGroupKeyBO"
        }
    }
}

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

タイプ: object

BOモードのドキュメント: UserGroupKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  このリソースに関連するコレクション・リンク
• name: string
  タイトル: Name

  読取り専用: true

  最大長: 255

  ユーザー・グループのローカライズされた名前。 名前フィールドはソートにのみ使用できます。
• recordId: string
  タイトル: Record Id

  userGroupsリソースを表すTAG表の一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  ユーザー・グループのローカライズされていない名前
• stripeCd: string
  タイトル: Stripe CD

  読取り専用: true

  最大長: 30

  UserGroupのストライプ

{
    "description":"Documentation for BO mode: UserGroupKeyBO",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the user group.  The name field can only be used for sorting.",
            "maxLength":255,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier from the TAG table that represent a userGroups resource",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The non localized name of the user group",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe for UserGroup",
            "maxLength":30,
            "type":"string",
            "readOnly":true
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

このリソースに関連するコレクション・リンク

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"The collection links related to this resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: WorkflowStepDataBO

ソースを表示

• allowDocumentEditing: boolean
  タイトル: Allow Document Editing

  このステップでドキュメントの編集を許可するかどうかを示すフラグ
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このワークフロー・ステップが追加された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このワークフロー・ステップが最後に変更された日時。
• defaultStepDurationInMinutes: integer (int32)
  タイトル: Default Workflow Step Due date in minutes

  委託期限超過になる前にワークフロー・ステップ・タスクがキューにとどまる時間(分)
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ワークフロー・ステップのローカライズされた名前
• onlyAssigneeCanAppove: boolean
  タイトル: Can only assignee approve step

  ワークフロー・ステップ・タスク割当先のみがこのステップを承認できるかどうかを示すフラグ
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  WORKFLOWSTEP表からのGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

  ワークフロー・ステップのローカライズされていない名前
• sortOrder: integer (int32)
  タイトル: Sort Order

  ワークフロー内のワークフロー・ステップの順序
• workflowId(required): string
  タイトル: WorkflowRecord Id

  読取り専用: true

  WORKFLOW表からのGUID

{
    "description":"Documentation for BO mode: WorkflowStepDataBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId",
        "dateAdded",
        "dateModified"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the workflow step",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        },
        "allowDocumentEditing":{
            "title":"Allow Document Editing",
            "description":"Flag indicating whether this step allows document editing",
            "type":"boolean",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this work flow step was added.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this work flow step was last modified.",
            "type":"string",
            "readOnly":true
        },
        "defaultStepDurationInMinutes":{
            "format":"int32",
            "title":"Default Workflow Step Due date in minutes",
            "description":"Time in minutes that the workflow step task will stay in queue before being consdiered overdue",
            "type":"integer",
            "readOnly":false
        },
        "onlyAssigneeCanAppove":{
            "title":"Can only assignee approve step",
            "description":"Flag indicating whether this step can only be approved by workflow step task assignee",
            "type":"boolean",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The order of the workflow steps within the workflow",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: CategoryItemKeyBO

ソースを表示

• categoryId(required): integer (int64)
  タイトル: Category Id

  カテゴリの一意の識別子。

{
    "description":"Documentation for BO mode: CategoryItemKeyBO",
    "required":[
        "categoryId"
    ],
    "type":"object",
    "properties":{
        "categoryId":{
            "format":"int64",
            "title":"Category Id",
            "description":"The unique identifier of the category.",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

BOモードのドキュメント: ProductItemKeyBO

ソースを表示

• inventoryItemId: integer (int64)
  タイトル: Inventory Item Id

  製品の一意の識別子。
• organizationId: integer (int64)
  タイトル: Organization Id

  特定のカテゴリの在庫組織ID。
• productGroupId: integer (int64)
  タイトル: Product Group Id

  製品グループの一意の識別子。

{
    "description":"Documentation for BO mode: ProductItemKeyBO",
    "type":"object",
    "properties":{
        "inventoryItemId":{
            "format":"int64",
            "title":"Inventory Item Id",
            "description":"The unique identifier of the product.",
            "type":"integer",
            "readOnly":false
        },
        "organizationId":{
            "format":"int64",
            "title":"Organization Id",
            "description":"The inventory organization id of the specific category.",
            "type":"integer",
            "readOnly":false
        },
        "productGroupId":{
            "format":"int64",
            "title":"Product Group Id",
            "description":"The unique identifier of the product group.",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

コンテンツ履歴Metadata BO

ソースを表示

• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、コンテンツの外部関連付けを返します。
• operation: string
  タイトル: Operation

  このメタデータがコンテキストを提供しているアクション。
• sourceDocId: string
  タイトル: Source Doc Id

  読取り専用: true

  コピーされる記事のdocId。
• sourceLocaleId: string
  タイトル: Source Locale Id

  読取り専用: true

  コピーまたは復元する記事のロケール。
• sourceVersion: string
  タイトル: Source Version

  読取り専用: true

  コピーまたは復元する記事のバージョン。
• sourceVersionId: string
  タイトル: Source Version Id

  コピーされるアクチクルのversionId。

{
    "description":"Content History Metadata BO",
    "type":"object",
    "properties":{
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "operation":{
            "title":"Operation",
            "description":"The action this metadata is providing context for.",
            "type":"string",
            "readOnly":false
        },
        "sourceDocId":{
            "title":"Source Doc Id",
            "description":"docId of the article being copied.",
            "type":"string",
            "readOnly":true
        },
        "sourceLocaleId":{
            "title":"Source Locale Id",
            "description":"The locale of the article being copied or reverted to.",
            "type":"string",
            "readOnly":true
        },
        "sourceVersion":{
            "title":"Source Version",
            "description":"The version of the article being copied or reverted to.",
            "type":"string",
            "readOnly":true
        },
        "sourceVersionId":{
            "title":"Source Version Id",
            "description":"The versionId of the acticle being copied.",
            "type":"string",
            "readOnly":false
        }
    }
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、コンテンツの外部関連付けを返します。

リクエスト本文 - application/json ()

ルート・スキーマ : スキーマ

タイプ: object

BOモードのドキュメント: ContentBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• basedLocale: basedLocale
• basedOnVersion: string
  タイトル: Based On Version

  読取り専用: true

  最大長: 50

  この記事バージョンがローカリゼーションである場合、このフィールドにはローカリゼーションが作成された記事のバージョンが含まれている可能性があります。
• categories: array Categories
  タイトル: Categories

  記事に関連付けられたカテゴリのリスト。
• checkedOut: boolean
  タイトル: Checked Out

  読取り専用: true

  デフォルト値: false

  作成者がドキュメントを編集のためにチェックアウトまたはロックした日時。
• checkedOutBy: checkedOutBy
• contentBody(required): object Content Body
  タイトル: Content Body

  記事の内容。
• contentType(required): contentType
• createDate: string (date)
  タイトル: Create Date

  読取り専用: true

  この記事が最初に作成された日時。
• 作成者: 創造者
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この記事バージョンが作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• isForEdit: boolean
  タイトル: Is For Edit

  読取り専用: true

  デフォルト値: false

  リクエストの目的が記事の編集可能なバージョンを取得することだったかどうかを示します。 デフォルト値はfalseです。
• lastModifiedDate: string (date)
  タイトル: Last Modified Date

  読取り専用: true

  この記事が最後に変更された日時。
• lastModifier: lastModifier
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• 所有者: 持ち主
• pending: boolean
  タイトル: Pending

  読取り専用: true

  デフォルト値: false

  この記事バージョンが将来稼働するようにスケジュールされているかどうかを示します。 ほとんどの記事バージョンでは、値はfalseです。
• products: array Products
  タイトル: Products

  記事に関連付けられた製品のリスト。
• publishDate: string (date)
  タイトル: Publish Date

  読取り専用: true

  この記事バージョンが公開された日時。
• published: boolean
  タイトル: Published

  読取り専用: true

  デフォルト値: false

  この記事バージョンが公開されているかどうかを示します。 公開済バージョン以外のすべてのバージョンがある場合、デフォルト値はfalseです。
• publishedContent: publishedContent
• publishedVersion: string
  タイトル: Published Version

  読取り専用: true

  最大長: 50

  この記事にリクエストされたロケールで公開済バージョンがある場合、このフィールドには公開済記事バージョンのバージョン番号が含まれます。
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• reasonForEdit: string
  タイトル: Reason For Edit

  最大長: 2000

  記事バージョンを編集または作成する事由です。
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• sourceMetadata: sourceMetadata
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• userGroups: array User Groups
  タイトル: User Groups

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

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。
• views: array Views
  タイトル: Views

  読取り専用: true

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

{
    "description":"Documentation for BO mode: ContentBO",
    "required":[
        "locale",
        "contentType",
        "contentBody"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        },
        "basedLocale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"Based Locale",
                    "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
                    "readOnly":false
                }
            ]
        },
        "basedOnVersion":{
            "title":"Based On Version",
            "description":"If this article version is a localization, this field may contain the version of the article the localization was created from.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "checkedOut":{
            "title":"Checked Out",
            "description":"The date and time when an author has checked out or locked the document for editing.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "checkedOutBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Checked Out By",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "contentType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "createDate":{
            "format":"date",
            "title":"Create Date",
            "description":"The date and time when this article was originally created.",
            "type":"string",
            "readOnly":true
        },
        "creator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this article version was created.",
            "type":"string",
            "readOnly":true
        },
        "lastModifiedDate":{
            "format":"date",
            "title":"Last Modified Date",
            "description":"The date and time when this article was last modified. ",
            "type":"string",
            "readOnly":true
        },
        "lastModifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Modifier",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "owner":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "pending":{
            "title":"Pending",
            "description":"Indicates whether this article version is scheduled to go live in the future. The value is false for most article versions.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishDate":{
            "format":"date",
            "title":"Publish Date",
            "description":"The date and time when this article version was published.",
            "type":"string",
            "readOnly":true
        },
        "published":{
            "title":"Published",
            "description":"Indicates whether this article version is published. Default value is false for all versions other than the published version, if there is one.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishedVersion":{
            "title":"Published Version",
            "description":"If this article has a published version in the requested locale, this fields will contain the version number of the published article version.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "workflowStep":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepDataBO"
                },
                {
                    "title":"Workflow Step",
                    "description":"The step of the workflow in which the document version currently exist.",
                    "readOnly":true
                }
            ]
        },
        "contentBody":{
            "title":"Content Body",
            "description":"Contents of the article.",
            "type":"object",
            "readOnly":false
        },
        "reasonForEdit":{
            "title":"Reason For Edit",
            "description":"Reasons for editing or creating an article version.",
            "maxLength":2000,
            "type":"string",
            "readOnly":false
        },
        "categories":{
            "title":"Categories",
            "description":"The list of categories associated with the article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryItemKeyBO"
            },
            "readOnly":false
        },
        "isForEdit":{
            "title":"Is For Edit",
            "description":"Indicates whether the purpose of the request was to get an editable version of an article. Default value is false.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "products":{
            "title":"Products",
            "description":"The list of products associated with the article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductItemKeyBO"
            },
            "readOnly":false
        },
        "sourceMetadata":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentHistoryMetadataBO"
                },
                {
                    "title":"sourceMetadata",
                    "description":"Metadata used to provide context to the action which created or modified this content.",
                    "readOnly":false
                }
            ]
        },
        "userGroups":{
            "title":"User Groups",
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserGroupKeyBO"
            },
            "readOnly":false
        },
        "views":{
            "title":"Views",
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewKeyBO"
            },
            "readOnly":true
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Based Locale

  ドキュメントのローカライズされたバージョンの作成に使用されるソース・ロケール。 このフィールドは、コンテンツにローカライズされたバージョンがある場合にのみ表示されます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"Based Locale",
            "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Categories

記事に関連付けられたカテゴリのリスト。

ソースを表示

• Array of: object CategoryItemKeyBO
  BOモードのドキュメント: CategoryItemKeyBO

{
    "title":"Categories",
    "description":"The list of categories associated with the article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CategoryItemKeyBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Checked Out By

  読取り専用: true

  最後のコンテンツ・チェックアウトを実行したユーザーまたは作成者。 次に、checkedOutBy問合せパラメータで使用できるサブフィールドを示します:

  • checkedOutBy.recordId : checkedOutByオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : ユーザーの名。
  • checkedOutBy.lastName : ユーザーの姓。
  • checkedOutBy.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Checked Out By",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

タイプ: object

タイトル: Content Body

記事の内容。

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type

  コンテンツの分類および保存先となるチャネル。 次に、contentType問合せパラメータで使用できるサブフィールドを示します:

  • contentType.recordId : ContentTypeオブジェクトの一意の識別子。
  • contentType.referenceKey : ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。 コンテンツ・タイプのFAQの記事をリクエストする例については、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 創造者

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Creator

  読取り専用: true

  最初にドキュメントを作成または作成したユーザー。 作成者問合せパラメータで使用できるサブフィールドは次のとおりです:

  • creator.recordId : 作成者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : ユーザーの名。
  • creator.lastName : ユーザーの姓。
  • creator.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Modifier

  読取り専用: true

  最後のコンテンツ変更を実行したユーザーまたは作成者。 次に、lastModifier問合せパラメータで使用できるサブフィールドを示します:

  • lastModifier.recordId : lastModifierオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : ユーザーの名。
  • lastModifier.lastName : ユーザーの姓。
  • lastModifier.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Modifier",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 持ち主

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Owner

  読取り専用: true

  ドキュメントを所有または担当するユーザーまたは作成者。 次に、オーナー問合せパラメータで使用できるサブフィールドを示します:

  • owner.recordId : 所有者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
  • owner.email : ユーザーのeメール。
  • owner.firstName : ユーザーの名。
  • owner.lastName : ユーザーの姓。
  • owner.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 製品

タイプ: array

タイトル: Products

記事に関連付けられた製品のリスト。

ソースを表示

• Array of: object ProductItemKeyBO
  BOモードのドキュメント: ProductItemKeyBO

{
    "title":"Products",
    "description":"The list of products associated with the article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductItemKeyBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentHistoryMetadataBO
  コンテンツ履歴Metadata BO
• タイトル: sourceMetadata

  このコンテンツを作成または変更したアクションのコンテキストを提供するために使用されるMetadata。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentHistoryMetadataBO"
        },
        {
            "title":"sourceMetadata",
            "description":"Metadata used to provide context to the action which created or modified this content.",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : ユーザー・グループ

タイプ: array

タイトル: User Groups

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

ソースを表示

• Array of: object UserGroupKeyBO
  BOモードのドキュメント: UserGroupKeyBO

{
    "title":"User Groups",
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserGroupKeyBO"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Views

読取り専用: true

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

ソースを表示

• Array of: object ViewKeyBO
  BOモードのドキュメント: ViewKeyBO

{
    "title":"Views",
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepDataBO
  BOモードのドキュメント: WorkflowStepDataBO
• タイトル: Workflow Step

  読取り専用: true

  ドキュメント・バージョンが現在存在しているワークフローのステップ。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepDataBO"
        },
        {
            "title":"Workflow Step",
            "description":"The step of the workflow in which the document version currently exist.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: ContentDataBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• basedLocale: basedLocale
• basedOnVersion: string
  タイトル: Based On Version

  読取り専用: true

  最大長: 50

  この記事バージョンがローカリゼーションである場合、このフィールドにはローカリゼーションが作成された記事のバージョンが含まれている可能性があります。
• checkedOut: boolean
  タイトル: Checked Out

  読取り専用: true

  デフォルト値: false

  作成者がドキュメントを編集のためにチェックアウトまたはロックした日時。
• checkedOutBy: checkedOutBy
• contentType(required): contentType
• createDate: string (date)
  タイトル: Create Date

  読取り専用: true

  この記事が最初に作成された日時。
• 作成者: 創造者
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この記事バージョンが作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• lastModifiedDate: string (date)
  タイトル: Last Modified Date

  読取り専用: true

  この記事が最後に変更された日時。
• lastModifier: lastModifier
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• 所有者: 持ち主
• pending: boolean
  タイトル: Pending

  読取り専用: true

  デフォルト値: false

  この記事バージョンが将来稼働するようにスケジュールされているかどうかを示します。 ほとんどの記事バージョンでは、値はfalseです。
• publishDate: string (date)
  タイトル: Publish Date

  読取り専用: true

  この記事バージョンが公開された日時。
• published: boolean
  タイトル: Published

  読取り専用: true

  デフォルト値: false

  この記事バージョンが公開されているかどうかを示します。 公開済バージョン以外のすべてのバージョンがある場合、デフォルト値はfalseです。
• publishedContent: publishedContent
• publishedVersion: string
  タイトル: Published Version

  読取り専用: true

  最大長: 50

  この記事にリクエストされたロケールで公開済バージョンがある場合、このフィールドには公開済記事バージョンのバージョン番号が含まれます。
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• version: string
  タイトル: Version

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。
• workflowStep: workflowStep

{
    "description":"Documentation for BO mode: ContentDataBO",
    "required":[
        "locale",
        "contentType"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        },
        "basedLocale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"Based Locale",
                    "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
                    "readOnly":false
                }
            ]
        },
        "basedOnVersion":{
            "title":"Based On Version",
            "description":"If this article version is a localization, this field may contain the version of the article the localization was created from.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "checkedOut":{
            "title":"Checked Out",
            "description":"The date and time when an author has checked out or locked the document for editing.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "checkedOutBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Checked Out By",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "contentType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "createDate":{
            "format":"date",
            "title":"Create Date",
            "description":"The date and time when this article was originally created.",
            "type":"string",
            "readOnly":true
        },
        "creator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this article version was created.",
            "type":"string",
            "readOnly":true
        },
        "lastModifiedDate":{
            "format":"date",
            "title":"Last Modified Date",
            "description":"The date and time when this article was last modified. ",
            "type":"string",
            "readOnly":true
        },
        "lastModifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Modifier",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "owner":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "pending":{
            "title":"Pending",
            "description":"Indicates whether this article version is scheduled to go live in the future. The value is false for most article versions.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishDate":{
            "format":"date",
            "title":"Publish Date",
            "description":"The date and time when this article version was published.",
            "type":"string",
            "readOnly":true
        },
        "published":{
            "title":"Published",
            "description":"Indicates whether this article version is published. Default value is false for all versions other than the published version, if there is one.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishedVersion":{
            "title":"Published Version",
            "description":"If this article has a published version in the requested locale, this fields will contain the version number of the published article version.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "workflowStep":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepDataBO"
                },
                {
                    "title":"Workflow Step",
                    "description":"The step of the workflow in which the document version currently exist.",
                    "readOnly":true
                }
            ]
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Based Locale

  ドキュメントのローカライズされたバージョンの作成に使用されるソース・ロケール。 このフィールドは、コンテンツにローカライズされたバージョンがある場合にのみ表示されます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"Based Locale",
            "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Checked Out By

  読取り専用: true

  最後のコンテンツ・チェックアウトを実行したユーザーまたは作成者。 次に、checkedOutBy問合せパラメータで使用できるサブフィールドを示します:

  • checkedOutBy.recordId : checkedOutByオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : ユーザーの名。
  • checkedOutBy.lastName : ユーザーの姓。
  • checkedOutBy.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Checked Out By",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type

  コンテンツの分類および保存先となるチャネル。 次に、contentType問合せパラメータで使用できるサブフィールドを示します:

  • contentType.recordId : ContentTypeオブジェクトの一意の識別子。
  • contentType.referenceKey : ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。 コンテンツ・タイプのFAQの記事をリクエストする例については、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 創造者

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Creator

  読取り専用: true

  最初にドキュメントを作成または作成したユーザー。 作成者問合せパラメータで使用できるサブフィールドは次のとおりです:

  • creator.recordId : 作成者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : ユーザーの名。
  • creator.lastName : ユーザーの姓。
  • creator.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Modifier

  読取り専用: true

  最後のコンテンツ変更を実行したユーザーまたは作成者。 次に、lastModifier問合せパラメータで使用できるサブフィールドを示します:

  • lastModifier.recordId : lastModifierオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : ユーザーの名。
  • lastModifier.lastName : ユーザーの姓。
  • lastModifier.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Modifier",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 持ち主

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Owner

  読取り専用: true

  ドキュメントを所有または担当するユーザーまたは作成者。 次に、オーナー問合せパラメータで使用できるサブフィールドを示します:

  • owner.recordId : 所有者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
  • owner.email : ユーザーのeメール。
  • owner.firstName : ユーザーの名。
  • owner.lastName : ユーザーの姓。
  • owner.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepDataBO
  BOモードのドキュメント: WorkflowStepDataBO
• タイトル: Workflow Step

  読取り専用: true

  ドキュメント・バージョンが現在存在しているワークフローのステップ。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepDataBO"
        },
        {
            "title":"Workflow Step",
            "description":"The step of the workflow in which the document version currently exist.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: ContentKeyBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• publishedContent: publishedContent
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• version: string
  タイトル: Version

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。

{
    "description":"Documentation for BO mode: ContentKeyBO",
    "required":[
        "locale"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: ArticleStatusKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  このリソースに関連するコレクション・リンク
• name: string
  タイトル: Name

  読取り専用: true

  最小長: 1

  最大長: 255

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

  ArticleStatusオブジェクトの一意の識別子。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

{
    "description":"Documentation for BO mode: ArticleStatusKeyBO",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the ArticleStatus object. The name field can only be used for sorting.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":true,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ArticleStatus object.",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the ArticleStatus object. ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

このリソースに関連するコレクション・リンク

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"The collection links related to this resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ソースを表示

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string"
        },
        "sinceVersion":{
            "type":"string"
        }
    }
}

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

タイプ: object

ソースを表示

• autosaveType(required): autosaveType
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この自動保存が作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この自動保存が最後に変更された日時。
• documentId: string
  タイトル: Document Id

  読取り専用: true

  コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。
• locale: object LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• recordId: string
• title: string
  最大長: 4000

{
    "required":[
        "autosaveType"
    ],
    "type":"object",
    "properties":{
        "autosaveType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveType"
                },
                {
                    "nullable":false
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this autosave was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time this autosave was last modified.",
            "type":"string",
            "readOnly":true
        },
        "documentId":{
            "title":"Document Id",
            "description":"The unique identifier of a document that indicates the content type in which the content is saved.",
            "type":"string",
            "readOnly":true
        },
        "locale":{
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        "recordId":{
            "type":"string"
        },
        "title":{
            "maxLength":4000,
            "type":"string"
        }
    }
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "ALL", "CREATED", "EDITED", "TRANSLATED" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveType"
        },
        {
            "nullable":false
        }
    ]
}

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

タイプ: object

BOモードのドキュメント : LocaleKeyBO:

ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• localeDesc: string
  タイトル: Locale Desc

  読取り専用: true

  最大長: 100

  Localeオブジェクトが表す言語と国に関する説明。
• recordId: string
  タイトル: Record Id

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

{
    "description":"Documentation for BO mode: LocaleKeyBO: <p>Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)</p>",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "localeDesc":{
            "title":"Locale Desc",
            "description":"The description about the language and country that the Locale object represents.",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the Locale object.",
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ContentExternalAssociationBOのドキュメント

ソースを表示

• alternateId: string
  タイトル: Alternate Id

  外部関連付けの代替識別子
• alternateIdType: string
  タイトル: Alternate Id Type

  外部呼出しの代替タイプ
• objectId(required): string
  タイトル: Object Id

  最小長: 1

  最大長: 50

  外部関連付けの一意の識別子。
• properties: object Properties
  タイトル: Properties

  追加プロパティの許可: additionalProperties

  外部関連付けのプロパティ
• type(required): string
  タイトル: Object Type

  最小長: 1

  最大長: 100

  外部関連付けのタイプ

{
    "description":"Documentation for ContentExternalAssociationBO",
    "required":[
        "objectId",
        "type"
    ],
    "type":"object",
    "properties":{
        "alternateId":{
            "title":"Alternate Id",
            "description":"The alternate identifier of the external association",
            "type":"string"
        },
        "alternateIdType":{
            "title":"Alternate Id Type",
            "description":"The alternate type of the external assocation",
            "type":"string"
        },
        "objectId":{
            "title":"Object Id",
            "description":"The unique identifier of the external association.",
            "maxLength":50,
            "minLength":1,
            "type":"string",
            "nullable":false
        },
        "properties":{
            "title":"Properties",
            "description":"The properties of the external association",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "type":{
            "title":"Object Type",
            "description":"The type of the external association",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "nullable":false
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

タイトル: Properties

追加プロパティの許可

ソースを表示

• 文字列

{
    "title":"Properties",
    "description":"The properties of the external association",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

外部関連付けのプロパティ

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

タイプ: object

BOモードのドキュメント: DataFormBO

ソースを表示

• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このDataFormオブジェクトが作成された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このDataFormオブジェクトが最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  サービスがエンド・ユーザーへのデータ・フォームの表示を停止する日付
• displayStartDate: string (date)
  タイトル: Display Start Date

  データ・フォームをエンドユーザーに表示できるようになる日付
• emailContent: boolean
  タイトル: Email Content

  DataFormオブジェクトのemailContentフィールド
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

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

  質問と多数の関係
• ratingType: integer (int32)
  タイトル: Rating Type

  5つ星評価かY/Nタイプの評価かを決定

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  DataFormオブジェクトの参照キー
• ユーザー: ユーザー
• views: array Views
  タイトル: Views

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

{
    "description":"Documentation for BO mode: DataFormBO",
    "required":[
        "recordId",
        "referenceKey",
        "dateAdded",
        "dateModified"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataForm object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataForm object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this DataForm object was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this DataForm object was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date when the service stops the display of the data form to the end users",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date when the data form will be available to display to end-users",
            "type":"string",
            "readOnly":false
        },
        "emailContent":{
            "title":"Email Content",
            "description":"The emailContent field of the DataForm object",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The name of the data form.  The name field can only be used for sorting.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "ratingType":{
            "format":"int32",
            "title":"Rating Type",
            "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",
            "readOnly":false
        },
        "questions":{
            "title":"Questions",
            "description":"To Many Relationship to Question",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataFormQuestionBO"
            },
            "readOnly":false
        },
        "user":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"User",
                    "description":"Relationship to User",
                    "readOnly":false
                }
            ]
        },
        "views":{
            "title":"Views",
            "description":"To Many Relationship to View",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewKeyBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Questions

質問と多数の関係

ソースを表示

• Array of: object DataFormQuestionBO
  BOモードのドキュメント: QuestionBO

{
    "title":"Questions",
    "description":"To Many Relationship to Question",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataFormQuestionBO"
    },
    "readOnly":false
}

ネストされたスキーマ : ユーザー

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: User

  ユーザーとの関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"User",
            "description":"Relationship to User",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Views

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

ソースを表示

• Array of: object ViewKeyBO
  BOモードのドキュメント: ViewKeyBO

{
    "title":"Views",
    "description":"To Many Relationship to View",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewKeyBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: QuestionBO

ソースを表示

• answers: array Answers
  タイトル: Answers

  回答との関連性が多すぎます
• dataForm: dataForm
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  DataFormQuestionオブジェクトが作成された日時
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  DataFormQuestionオブジェクトが最後に変更された日時
• isMasterIdentifier: boolean
  タイトル: Is Master Identifier

  DataFormQuestionオブジェクトのisMasterIdentifierフィールド
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  DataFormQuestionオブジェクトのローカライズされた名前
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormQuestionオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormQuestionオブジェクトの参照キー
• required: boolean
  タイトル: Required

  この質問が必須かどうかを示すフラグ
• sortOrder: integer (int32)
  タイトル: Sort Order

  この質問のソート順
• specialTypeIndicator: integer (int32)
  タイトル: Special Type Indicator

  DataFormQuestionオブジェクトのspecialTypeIndicatorフィールド

{
    "description":"Documentation for BO mode: QuestionBO",
    "required":[
        "recordId",
        "dateAdded",
        "dateModified",
        "name"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormQuestion object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormQuestion object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time the DataFormQuestion object was created",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time the DataFormQuestion object was last modified",
            "type":"string",
            "readOnly":true
        },
        "isMasterIdentifier":{
            "title":"Is Master Identifier",
            "description":"The isMasterIdentifier field of the DataFormQuestion object",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the DataFormQuestion object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "required":{
            "title":"Required",
            "description":"The flag that indicates whether or not this question is required",
            "type":"boolean",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The sort order of this question",
            "type":"integer",
            "readOnly":false
        },
        "specialTypeIndicator":{
            "format":"int32",
            "title":"Special Type Indicator",
            "description":"The specialTypeIndicator field of the DataFormQuestion object",
            "type":"integer",
            "readOnly":false
        },
        "answers":{
            "title":"Answers",
            "description":"To Many Relationship to Answer",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataFormAnswerBO"
            },
            "readOnly":false
        },
        "dataForm":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormKeyBO"
                },
                {
                    "title":"Data Form",
                    "description":"Relationship to Rating",
                    "readOnly":false
                }
            ]
        }
    }
}

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

タイプ: array

タイトル: Answers

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

ソースを表示

• Array of: object DataFormAnswerBO
  BOモードのドキュメント: AnswerBO

{
    "title":"Answers",
    "description":"To Many Relationship to Answer",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataFormAnswerBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 DataFormKeyBO
  BOモードのドキュメント: DataFormKeyBO
• タイトル: Data Form

  評点との関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormKeyBO"
        },
        {
            "title":"Data Form",
            "description":"Relationship to Rating",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AnswerBO

ソースを表示

• dataFormQuestion: dataFormQuestion
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このDataFormAnswerオブジェクトが作成された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このDataFormAnswerオブジェクトが最後に変更された日時。
• defaultAnswer: boolean
  タイトル: Default Answer

  この回答がデフォルトの回答かどうかを示すフラグ
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  DataFormAnswerオブジェクトのローカライズされた名前
• numberValue: integer (int32)
  タイトル: Number Value

  回答の数値
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormAnswerオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormAnswerオブジェクトの参照キー
• sortOrder: integer (int32)
  タイトル: Sort Order

  回答のソート順

{
    "description":"Documentation for BO mode: AnswerBO",
    "required":[
        "recordId",
        "dateAdded",
        "dateModified",
        "name"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormAnswer object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormAnswer object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this DataFormAnswer object was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this DataFormAnswer object was last modified.",
            "type":"string",
            "readOnly":true
        },
        "defaultAnswer":{
            "title":"Default Answer",
            "description":"The flag that indicates whether or not this answer is the default answer",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the DataFormAnswer object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "numberValue":{
            "format":"int32",
            "title":"Number Value",
            "description":"The numeric value of the answer",
            "type":"integer",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The sort order of the answer",
            "type":"integer",
            "readOnly":false
        },
        "dataFormQuestion":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormQuestionKeyBO"
                },
                {
                    "title":"Data Form Question",
                    "description":"Relationship to Question",
                    "readOnly":false
                }
            ]
        }
    }
}

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

すべて一致

ソースを表示

• 「オブジェクト」 DataFormQuestionKeyBO
  BOモードのドキュメント: QuestionKeyBO
• タイトル: Data Form Question

  質問との関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormQuestionKeyBO"
        },
        {
            "title":"Data Form Question",
            "description":"Relationship to Question",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: QuestionKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormQuestionオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormQuestionオブジェクトの参照キー

{
    "description":"Documentation for BO mode: QuestionKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormQuestion object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormQuestion object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: DataFormKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  DataFormオブジェクトの参照キー

{
    "description":"Documentation for BO mode: DataFormKeyBO",
    "required":[
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataForm object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataForm object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: UserKeyBO

ソースを表示

• canAssignTask: boolean
  タイトル: Can Assign tasks

  このユーザーがタスクを他のユーザーに割り当てることができるかどうかを返します。
• contentTypePrivileges: array Content Type Privileges
  タイトル: Content Type Privileges

  このフィールドは、ユーザーが所有するすべてのcontenttype権限のリストを返します
• email: string
  タイトル: Email

  最大長: 100

  ユーザーの電子メール・アドレス
• externalId: integer (int64)
  タイトル: External Id

  読取り専用: true

  ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
• functionalPrivileges: object Functional Privileges of user
  タイトル: Functional Privileges of user

  追加プロパティの許可: additionalProperties

  このフィールドは、ユーザーが所有するすべての権限のリストを返します
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• login: string
  タイトル: Login

  最大長: 100

  ユーザーのログイン
• name: string
  タイトル: Name

  読取り専用: true

  最大長: 100

  ユーザーのフルネーム
• recordId(required): integer (int64)
  タイトル: Record Id

  読取り専用: true

  ユーザーの一意の識別子

{
    "description":"Documentation for BO mode: UserKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "canAssignTask":{
            "title":"Can Assign tasks",
            "description":"Returns whether this user can assign tasks to other users.",
            "type":"boolean",
            "readOnly":false
        },
        "contentTypePrivileges":{
            "title":"Content Type Privileges",
            "description":"This field will return list of all contenttype privileges user have",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeContentTypeBO"
            },
            "readOnly":false
        },
        "email":{
            "title":"Email",
            "description":"The user's e-mail address",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "externalId":{
            "format":"int64",
            "title":"External Id",
            "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",
            "readOnly":true
        },
        "functionalPrivileges":{
            "title":"Functional Privileges of user ",
            "description":"This field will return list of all fucntional privileges user have",
            "type":"object",
            "additionalProperties":{
                "type":"boolean"
            },
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "login":{
            "title":"Login",
            "description":"The user's login",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"User's full name",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "format":"int64",
            "title":"Record Id",
            "description":"The unique identifier of the user",
            "type":"integer",
            "readOnly":true
        }
    }
}

ネストされたスキーマ : コンテンツ・タイプ権限

タイプ: array

タイトル: Content Type Privileges

このフィールドは、ユーザーが所有するすべてのcontenttype権限のリストを返します

ソースを表示

• Array of: object CompositeContentTypeBO
  ContentTypeBOおよびそのフラット化されたリレーションの複合。 行にさらに内容を追加できることに注意してください

{
    "title":"Content Type Privileges",
    "description":"This field will return list of all contenttype privileges user have",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeContentTypeBO"
    },
    "readOnly":false
}

ネストされたスキーマ : ユーザーの機能権限

タイプ: object

タイトル: Functional Privileges of user

追加プロパティの許可

ソースを表示

• ブール

{
    "title":"Functional Privileges of user ",
    "description":"This field will return list of all fucntional privileges user have",
    "type":"object",
    "additionalProperties":{
        "type":"boolean"
    },
    "readOnly":false
}

このフィールドは、ユーザーが所有するすべての権限のリストを返します

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ContentTypeBOおよびそのフラット化されたリレーションの複合。 行にさらに内容を追加できることに注意してください

ソースを表示

• compositeWorkflowSteps(required): array WorkflowSteps Composite BO
  タイトル: WorkflowSteps Composite BO

  このコンテンツ・タイプにマップされたWorkflowStepsおよびそのコンテンツに対するユーザー権限
• contentTypeKeyBO(required): contentTypeKeyBO
• hasContentTypeAccess: boolean
  タイトル: Has Content Type Access

  ContentTypeBO権限がユーザーに対して有効かどうかを検証
• listOfPrivilege(required): array List Of Privilege
  タイトル: List Of Privilege

  ContentTypeの権限のリスト

{
    "description":"Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line",
    "required":[
        "compositeWorkflowSteps",
        "contentTypeKeyBO",
        "listOfPrivilege"
    ],
    "type":"object",
    "properties":{
        "compositeWorkflowSteps":{
            "title":"WorkflowSteps Composite BO",
            "description":"WorkflowSteps mapped to this content type and user privileges on that",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeWorkflowStepBO"
            },
            "readOnly":false,
            "nullable":false
        },
        "contentTypeKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type Key BO",
                    "description":"ContentBO object being created or updated",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "hasContentTypeAccess":{
            "title":"Has Content Type Access",
            "description":"Verifies if ContentTypeBO privileges are valid for user",
            "type":"boolean",
            "readOnly":false
        },
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the ContentType",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":false
        }
    }
}

ネストされたスキーマ : WorkflowStepsコンポジットBO

タイプ: array

タイトル: WorkflowSteps Composite BO

このコンテンツ・タイプにマップされたWorkflowStepsおよびそのコンテンツに対するユーザー権限

ソースを表示

• Array of: object CompositeWorkflowStepBO
  このステップに対するユーザー権限を持つWorkflowStepBOのコンポジット。

{
    "title":"WorkflowSteps Composite BO",
    "description":"WorkflowSteps mapped to this content type and user privileges on that",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeWorkflowStepBO"
    },
    "readOnly":false,
    "nullable":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type Key BO

  作成または更新されるContentBOオブジェクト

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type Key BO",
            "description":"ContentBO object being created or updated",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 権限のリスト

タイプ: array

タイトル: List Of Privilege

ContentTypeの権限のリスト

ソースを表示

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the ContentType",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false,
    "nullable":false
}

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

タイプ: object

このステップに対するユーザー権限を持つWorkflowStepBOのコンポジット。

ソースを表示

• listOfPrivilege(required): array List Of Privilege
  タイトル: List Of Privilege

  WorkflowStepの権限のリスト
• WorkflowStepKeyBO(required): WorkflowStepKeyBO

{
    "description":"Composite of WorkflowStepBO with user privileges on this step.",
    "required":[
        "listOfPrivilege",
        "WorkflowStepKeyBO"
    ],
    "type":"object",
    "properties":{
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the WorkflowStep",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":false
        },
        "WorkflowStepKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepKeyBO"
                },
                {
                    "title":"WorkflowStep Key BO",
                    "description":"WorkflowStep object being fetched",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        }
    }
}

ネストされたスキーマ : 権限のリスト

タイプ: array

タイトル: List Of Privilege

WorkflowStepの権限のリスト

ソースを表示

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the WorkflowStep",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false,
    "nullable":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepKeyBO
  BOモードのドキュメント: WorkflowStepKeyBO
• タイトル: WorkflowStep Key BO

  フェッチされるWorkflowStepオブジェクト

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepKeyBO"
        },
        {
            "title":"WorkflowStep Key BO",
            "description":"WorkflowStep object being fetched",
            "readOnly":false,
            "nullable":false
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: WorkflowStepKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ワークフロー・ステップのローカライズされた名前
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  WORKFLOWSTEP表からのGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

  ワークフロー・ステップのローカライズされていない名前
• workflowId(required): string
  タイトル: WorkflowRecord Id

  読取り専用: true

  WORKFLOW表からのGUID

{
    "description":"Documentation for BO mode: WorkflowStepKeyBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the workflow step",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: ContentTypeKeyBO

ソースを表示

• description: string
  タイトル: Description

  最大長: 255

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

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  ContentTypeオブジェクトの名前。 名前フィールドはソートにのみ使用できます。 コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。
• recordId: string
  タイトル: Record Id

  読取り専用: true

  ContentTypeオブジェクトの一意の識別子。
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

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

  最大長: 30

  ストライプ・コードを示す参照コード。
• usageCode: string
  タイトル: Usage Code

  読取り専用: true

  最大長: 30

  製品使用コードを示す参照コードです。
• ワークフロー: ワークフロー

{
    "description":"Documentation for BO mode: ContentTypeKeyBO",
    "required":[
        "name",
        "referenceKey",
        "stripeCd"
    ],
    "type":"object",
    "properties":{
        "description":{
            "title":"Description",
            "description":"The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The name for the ContentType object.  The name field can only be used for sorting. Content Types support multiple languages. This field identifies the object associated with the language specified by the user. ",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ContentType object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"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.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe Cd",
            "description":"Lookup code that indicates the stripe code.",
            "maxLength":30,
            "type":"string",
            "readOnly":false
        },
        "usageCode":{
            "title":"Usage Code",
            "description":"Lookup code that indicates the product usage code.",
            "maxLength":30,
            "type":"string",
            "readOnly":true
        },
        "workflow":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowKeyBO"
                },
                {
                    "title":"Workflow",
                    "description":"The workflow definition that the author can use while content authoring in a content type.",
                    "readOnly":false
                }
            ]
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ワークフロー

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowKeyBO
• タイトル: Workflow

  コンテンツ・タイプでのコンテンツ・オーサリング中に作成者が使用できるワークフロー定義。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowKeyBO"
        },
        {
            "title":"Workflow",
            "description":"The workflow definition that the author can use while content authoring in a content type.",
            "readOnly":false
        }
    ]
}

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

タイプ: object

ソースを表示

• enabled: boolean
• links: array links
• name: string
  最大長: 255
• recordId: string
• referenceKey: string
  最小長: 0

  最大長: 100
• workflowVersion: integer (int32)

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "name":{
            "maxLength":255,
            "type":"string"
        },
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "workflowVersion":{
            "format":"int32",
            "type":"integer"
        }
    }
}

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

タイプ: array

ソースを表示

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

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

タイプ: object

BOモードのドキュメント: ViewKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ビューのローカライズ名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  ビュー定義を含むSITE表のGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  ビューのローカライズされていない参照キー
• stripeCd: string
  タイトル: Stripe CD

  最大長: 30

  ビューのストライプ

{
    "description":"Documentation for BO mode: ViewKeyBO",
    "required":[
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the view",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID of the SITE table containing the view definition",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized reference key for the view",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe of a view",
            "maxLength":30,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: AggregateFormResultsBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• questions: array Questions
  タイトル: Questions

  AggregateQuestionResultとの関係が多すぎます
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateFormResultsオブジェクトの一意のレコードID。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

  AggregateFormResultsオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateFormResultsBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateFormResults object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateFormResults object",
            "type":"integer",
            "readOnly":false
        },
        "questions":{
            "title":"Questions",
            "description":"To Many Relationship to AggregateQuestionResult",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AggregateQuestionResultBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Questions

AggregateQuestionResultとの関係が多すぎます

ソースを表示

• Array of: object AggregateQuestionResultBO
  BOモードのドキュメント: AggregateQuestionResultBO

{
    "title":"Questions",
    "description":"To Many Relationship to AggregateQuestionResult",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AggregateQuestionResultBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AggregateQuestionResultBO

ソースを表示

• answers: array Answers
  タイトル: Answers

  AggregateAnswerResultとの関係が多すぎます
• averageResponse: number (double)
  タイトル: Average Response

  AggregateQuestionResultオブジェクトのAverageResponse
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  質問のローカライズされた表示名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateQuestionResultオブジェクトの一意のレコードID。
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

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

  AggregateQuestionResultオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateQuestionResultBO",
    "required":[
        "name",
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "description":"Localized display name for the Question",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateQuestionResult object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "averageResponse":{
            "format":"double",
            "title":"Average Response",
            "description":"AverageResponse of the AggregateQuestionResult object",
            "type":"number",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateQuestionResult object",
            "type":"integer",
            "readOnly":false
        },
        "answers":{
            "title":"Answers",
            "description":"To Many Relationship to AggregateAnswerResult",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AggregateAnswerResultBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Answers

AggregateAnswerResultとの関係が多すぎます

ソースを表示

• Array of: object AggregateAnswerResultBO
  BOモードのドキュメント: AggregateAnswerResultBO

{
    "title":"Answers",
    "description":"To Many Relationship to AggregateAnswerResult",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AggregateAnswerResultBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AggregateAnswerResultBO

ソースを表示

• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  回答のローカライズされた表示名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateAnswerResultオブジェクトの一意のレコードID。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

  AggregateAnswerResultオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateAnswerResultBO",
    "required":[
        "name",
        "recordId"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "description":"Localized display name for the Answer",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateAnswerResult object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateAnswerResult object",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

コンテンツ・レビュー情報ビジネス・オブジェクト

ソースを表示

• lastUpdateDate: string (date)
  タイトル: Last Update Date

  読取り専用: true

  文書がレビュー済としてマークされた日付。
• lastUpdatedBy: lastUpdatedBy
• 状態: 国家

{
    "description":"Content Review Information BO",
    "type":"object",
    "properties":{
        "lastUpdateDate":{
            "format":"date",
            "title":"Last Update Date",
            "description":"The date when the document was marked reviewed.",
            "type":"string",
            "readOnly":true
        },
        "lastUpdatedBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Updated By",
                    "description":"The user or author who marked document reviewed.",
                    "readOnly":true
                }
            ]
        },
        "state":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewState"
                },
                {
                    "title":"State",
                    "description":" review state for document.",
                    "readOnly":true
                }
            ]
        }
    }
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Updated By

  読取り専用: true

  レビュー済文書をマークしたユーザーまたは作成者。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Updated By",
            "description":"The user or author who marked document reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 国家

すべて一致

ソースを表示

• 文字列
  許可された値: [ "REVIEWED" ]
• タイトル: State

  読取り専用: true

  ドキュメントのレビュー状態。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewState"
        },
        {
            "title":"State",
            "description":" review state for document.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: SchemaAttributeBO

ソースを表示

• allowMultipleNodes: boolean
  タイトル: Allow Multiple Nodes

  このタイプの複数のノードが許可されるかどうかを示すフラグ@since 8.3
• allowPreselectedUserGroupChange: boolean
  タイトル: Allow Preselected User Group Change

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

  現在の要素の子ノードのリスト
• counter: integer (int32)
  タイトル: Counter

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

  最大長: 50

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

  読取り専用: true

  このSchemaAttribute定義が最初に作成された日時
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  このSchemaAttribute定義が最後に変更された日時
• description: string
  タイトル: Description

  最大長: 1000

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

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

  このフィールドを全文索引に含めるかどうかを示すフラグ。 このフィールドは、以前は索引可能と呼ばれていました@since 8.3
• includeInMasterIdentifier: boolean
  タイトル: Include In Master Identifier

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

  この要素がノードであるかどうかを示すフラグ@since 8.3
• isRequired: boolean
  タイトル: Is Required

  属性を必須フィールドにします@since 8.3
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• localizedAttributes: array Localized Attributes
  タイトル: Localized Attributes

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

  最小長: 1

  最大長: 255

  属性のローカライズされた名前。 これはスキーマ内で一意である必要はありません。
• readOnly: boolean
  タイトル: Read Only

  このフィールドが編集可能かどうかを示すフラグ
• recordId: string
  タイトル: Record Id

  読取り専用: true

  SchemaAttributeオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

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

  ワークフローが使用可能な場合、属性にはワークフロー承認が必要です
• schemaAttributeUserGroupList: array Schema Attribute User Group List
  タイトル: Schema Attribute User Group List

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

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

  選択したユーザー・グループに属性を制限
• securityRegex: string
  タイトル: Security Regex

  最大長: 100

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

  編集フォーム内のスキーマ属性の表示順序
• textHeight: string
  タイトル: Text Height

  最大長: 10

  テキスト領域およびリッチ・テキスト・フィールドのテキストの高さを指定
• textWidth: string
  タイトル: Text Width

  最大長: 10

  テキスト・フィールドの最大長を指定
• userGroupSelectionRequired: boolean
  タイトル: User Group Selection Required

  属性にはユーザー・グループが必要です
• wysiwygType: wysiwygType
• xpath: string
  タイトル: Xpath

  最大長: 2000

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

{
    "description":"Documentation for BO mode: SchemaAttributeBO",
    "required":[
        "name",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the attribute. This need NOT be unique within the Schema.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"Unique identifier for the SchemaAttribute object",
            "type":"string",
            "readOnly":true
        },
        "xpath":{
            "title":"Xpath",
            "description":"The XPATH of this attribute within the schema. This is unique within the Schema.",
            "maxLength":2000,
            "type":"string",
            "readOnly":false
        },
        "allowMultipleNodes":{
            "title":"Allow Multiple Nodes",
            "description":"Flag indicating if multiple nodes are allowed of this type@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "allowPreselectedUserGroupChange":{
            "title":"Allow Preselected User Group Change",
            "description":"Enable editors to modify preselected user group restrictions@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "counter":{
            "format":"int32",
            "title":"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",
            "readOnly":false
        },
        "counterPrefix":{
            "title":"Counter Prefix",
            "description":"This attribute contains the prefix that is appended to the front of the DOC ID counter",
            "maxLength":50,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this SchemaAttribute definition was first created",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this SchemaAttribute definition was last modified",
            "type":"string",
            "readOnly":true
        },
        "description":{
            "title":"Description",
            "description":"Localized help text for the attribute. This text is displayed in the authoring view",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        },
        "enableAttributeLevelSearch":{
            "title":"Enable Attribute Level Search",
            "description":"Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This fieldwas previously called searchable@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "enableFullTextSearch":{
            "title":"Enable Full Text Search",
            "description":"Flag indicating whether this field should be included in the full text index. This field was previouslycalled indexable@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "includeInMasterIdentifier":{
            "title":"Include In Master Identifier",
            "description":"Flag indicating whether this field should be appended to the master identifier of the document",
            "type":"boolean",
            "readOnly":false
        },
        "isNode":{
            "title":"Is Node",
            "description":"Flag indicating if this element is a node@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "isRequired":{
            "title":"Is Required",
            "description":"Make attribute a required field@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "readOnly":{
            "title":"Read Only",
            "description":"Flag indicating whether this field is editable",
            "type":"boolean",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "requireWorkflowApproval":{
            "title":"Require Workflow Approval",
            "description":"Attribute requires workflow approval if workflow is enabled",
            "type":"boolean",
            "readOnly":false
        },
        "schemaAttrType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SchemaAttributeTypeEnum"
                },
                {
                    "title":"Schema Attr Type",
                    "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
                    "readOnly":false
                }
            ]
        },
        "secureWithUserGroups":{
            "title":"Secure With User Groups",
            "description":"Restrict attribute to selected user groups",
            "type":"boolean",
            "readOnly":false
        },
        "securedFileResource":{
            "title":"Secured File Resource",
            "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",
            "readOnly":false
        },
        "securityRegex":{
            "title":"Security Regex",
            "description":"The regular expression used to validate the field against security attacks.",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"Display order of the schema attributes within the edit form",
            "type":"integer",
            "readOnly":false
        },
        "textHeight":{
            "title":"Text Height",
            "description":"Specifies the text height for text areas and rich text fields",
            "maxLength":10,
            "type":"string",
            "readOnly":false
        },
        "textWidth":{
            "title":"Text Width",
            "description":"Specifies the max length for text fields",
            "maxLength":10,
            "type":"string",
            "readOnly":false
        },
        "userGroupSelectionRequired":{
            "title":"User Group Selection Required",
            "description":"User groups are required for attribute",
            "type":"boolean",
            "readOnly":false
        },
        "wysiwygType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WysiwygTypeEnum"
                },
                {
                    "title":"Wysiwyg Type",
                    "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM@since 8.3",
                    "readOnly":false
                }
            ]
        },
        "children":{
            "title":"Children",
            "description":"List of child nodes of the current element",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":false
        },
        "localizedAttributes":{
            "title":"Localized Attributes",
            "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocalizedAttributesBO"
            },
            "readOnly":false
        },
        "schemaAttributeUserGroupList":{
            "title":"Schema Attribute User Group List",
            "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",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeUserGroupBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Children

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

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Children",
    "description":"List of child nodes of the current element",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

ネストされたスキーマ : ローカライズされた属性

タイプ: array

タイトル: Localized Attributes

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

ソースを表示

• Array of: object LocalizedAttributesBO

{
    "title":"Localized Attributes",
    "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LocalizedAttributesBO"
    },
    "readOnly":false
}

ネストされたスキーマ : スキーマ属性ユーザー・グループ・リスト

タイプ: array

タイトル: Schema Attribute User Group List

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

ソースを表示

• Array of: object SchemaAttributeUserGroupBO

{
    "title":"Schema Attribute User Group List",
    "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",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeUserGroupBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "BOOLEAN", "COUNTER", "DATE", "DATETIME", "FILE", "FLOAT", "INTEGER", "LIST", "TEXT_AREA", "TEXT_FIELD", "TIME", "WYSIWYG_EDIT" ]
• タイトル: Schema Attr Type

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SchemaAttributeTypeEnum"
        },
        {
            "title":"Schema Attr Type",
            "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "BASIC", "FULL", "MEDIUM" ]
• タイトル: Wysiwyg Type

  WYSIWYGリッチ・テキスト・フィールドのタイプ - i.e. FULL, BASIC, MEDIUM@since 8.3

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WysiwygTypeEnum"
        },
        {
            "title":"Wysiwyg Type",
            "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM@since 8.3",
            "readOnly":false
        }
    ]
}

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

タイプ: object

ソースを表示

• description: string
  タイトル: Description

  最大長: 1000

  上のロケールでローカライズされた説明
• localeId(required): string
  タイトル: Locale Id

  読取り専用: true

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

  最小長: 1

  最大長: 255

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

{
    "description":"",
    "required":[
        "localeId",
        "name"
    ],
    "type":"object",
    "properties":{
        "description":{
            "title":"Description",
            "description":"Localized description in the above Locale",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        },
        "localeId":{
            "title":"Locale Id",
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string",
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized Name in the above Locale",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        }
    }
}

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

タイプ: object

ソースを表示

• defaultValue: boolean
• recordId: string
• userGroup: object UserGroupKeyBO
  BOモードのドキュメント: UserGroupKeyBO

{
    "type":"object",
    "properties":{
        "defaultValue":{
            "type":"boolean"
        },
        "recordId":{
            "type":"string"
        },
        "userGroup":{
            "$ref":"#/components/schemas/UserGroupKeyBO"
        }
    }
}

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

タイプ: object

BOモードのドキュメント: UserGroupKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  このリソースに関連するコレクション・リンク
• name: string
  タイトル: Name

  読取り専用: true

  最大長: 255

  ユーザー・グループのローカライズされた名前。 名前フィールドはソートにのみ使用できます。
• recordId: string
  タイトル: Record Id

  userGroupsリソースを表すTAG表の一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  ユーザー・グループのローカライズされていない名前
• stripeCd: string
  タイトル: Stripe CD

  読取り専用: true

  最大長: 30

  UserGroupのストライプ

{
    "description":"Documentation for BO mode: UserGroupKeyBO",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the user group.  The name field can only be used for sorting.",
            "maxLength":255,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier from the TAG table that represent a userGroups resource",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The non localized name of the user group",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe for UserGroup",
            "maxLength":30,
            "type":"string",
            "readOnly":true
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

このリソースに関連するコレクション・リンク

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"The collection links related to this resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: WorkflowStepDataBO

ソースを表示

• allowDocumentEditing: boolean
  タイトル: Allow Document Editing

  このステップでドキュメントの編集を許可するかどうかを示すフラグ
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このワークフロー・ステップが追加された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このワークフロー・ステップが最後に変更された日時。
• defaultStepDurationInMinutes: integer (int32)
  タイトル: Default Workflow Step Due date in minutes

  委託期限超過になる前にワークフロー・ステップ・タスクがキューにとどまる時間(分)
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ワークフロー・ステップのローカライズされた名前
• onlyAssigneeCanAppove: boolean
  タイトル: Can only assignee approve step

  ワークフロー・ステップ・タスク割当先のみがこのステップを承認できるかどうかを示すフラグ
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  WORKFLOWSTEP表からのGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

  ワークフロー・ステップのローカライズされていない名前
• sortOrder: integer (int32)
  タイトル: Sort Order

  ワークフロー内のワークフロー・ステップの順序
• workflowId(required): string
  タイトル: WorkflowRecord Id

  読取り専用: true

  WORKFLOW表からのGUID

{
    "description":"Documentation for BO mode: WorkflowStepDataBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId",
        "dateAdded",
        "dateModified"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the workflow step",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        },
        "allowDocumentEditing":{
            "title":"Allow Document Editing",
            "description":"Flag indicating whether this step allows document editing",
            "type":"boolean",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this work flow step was added.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this work flow step was last modified.",
            "type":"string",
            "readOnly":true
        },
        "defaultStepDurationInMinutes":{
            "format":"int32",
            "title":"Default Workflow Step Due date in minutes",
            "description":"Time in minutes that the workflow step task will stay in queue before being consdiered overdue",
            "type":"integer",
            "readOnly":false
        },
        "onlyAssigneeCanAppove":{
            "title":"Can only assignee approve step",
            "description":"Flag indicating whether this step can only be approved by workflow step task assignee",
            "type":"boolean",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The order of the workflow steps within the workflow",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: CategoryItemKeyBO

ソースを表示

• categoryId(required): integer (int64)
  タイトル: Category Id

  カテゴリの一意の識別子。

{
    "description":"Documentation for BO mode: CategoryItemKeyBO",
    "required":[
        "categoryId"
    ],
    "type":"object",
    "properties":{
        "categoryId":{
            "format":"int64",
            "title":"Category Id",
            "description":"The unique identifier of the category.",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

BOモードのドキュメント: ProductItemKeyBO

ソースを表示

• inventoryItemId: integer (int64)
  タイトル: Inventory Item Id

  製品の一意の識別子。
• organizationId: integer (int64)
  タイトル: Organization Id

  特定のカテゴリの在庫組織ID。
• productGroupId: integer (int64)
  タイトル: Product Group Id

  製品グループの一意の識別子。

{
    "description":"Documentation for BO mode: ProductItemKeyBO",
    "type":"object",
    "properties":{
        "inventoryItemId":{
            "format":"int64",
            "title":"Inventory Item Id",
            "description":"The unique identifier of the product.",
            "type":"integer",
            "readOnly":false
        },
        "organizationId":{
            "format":"int64",
            "title":"Organization Id",
            "description":"The inventory organization id of the specific category.",
            "type":"integer",
            "readOnly":false
        },
        "productGroupId":{
            "format":"int64",
            "title":"Product Group Id",
            "description":"The unique identifier of the product group.",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

コンテンツ履歴Metadata BO

ソースを表示

• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、コンテンツの外部関連付けを返します。
• operation: string
  タイトル: Operation

  このメタデータがコンテキストを提供しているアクション。
• sourceDocId: string
  タイトル: Source Doc Id

  読取り専用: true

  コピーされる記事のdocId。
• sourceLocaleId: string
  タイトル: Source Locale Id

  読取り専用: true

  コピーまたは復元する記事のロケール。
• sourceVersion: string
  タイトル: Source Version

  読取り専用: true

  コピーまたは復元する記事のバージョン。
• sourceVersionId: string
  タイトル: Source Version Id

  コピーされるアクチクルのversionId。

{
    "description":"Content History Metadata BO",
    "type":"object",
    "properties":{
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "operation":{
            "title":"Operation",
            "description":"The action this metadata is providing context for.",
            "type":"string",
            "readOnly":false
        },
        "sourceDocId":{
            "title":"Source Doc Id",
            "description":"docId of the article being copied.",
            "type":"string",
            "readOnly":true
        },
        "sourceLocaleId":{
            "title":"Source Locale Id",
            "description":"The locale of the article being copied or reverted to.",
            "type":"string",
            "readOnly":true
        },
        "sourceVersion":{
            "title":"Source Version",
            "description":"The version of the article being copied or reverted to.",
            "type":"string",
            "readOnly":true
        },
        "sourceVersionId":{
            "title":"Source Version Id",
            "description":"The versionId of the acticle being copied.",
            "type":"string",
            "readOnly":false
        }
    }
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、コンテンツの外部関連付けを返します。

トップに戻る

レスポンス

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

• application/json

200 レスポンス

OK

201 レスポンス

CREATED

本文( )

ルート・スキーマ : スキーマ

タイプ: object

BOモードのドキュメント: ContentBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• basedLocale: basedLocale
• basedOnVersion: string
  タイトル: Based On Version

  読取り専用: true

  最大長: 50

  この記事バージョンがローカリゼーションである場合、このフィールドにはローカリゼーションが作成された記事のバージョンが含まれている可能性があります。
• categories: array Categories
  タイトル: Categories

  記事に関連付けられたカテゴリのリスト。
• checkedOut: boolean
  タイトル: Checked Out

  読取り専用: true

  デフォルト値: false

  作成者がドキュメントを編集のためにチェックアウトまたはロックした日時。
• checkedOutBy: checkedOutBy
• contentBody(required): object Content Body
  タイトル: Content Body

  記事の内容。
• contentType(required): contentType
• createDate: string (date)
  タイトル: Create Date

  読取り専用: true

  この記事が最初に作成された日時。
• 作成者: 創造者
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この記事バージョンが作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• isForEdit: boolean
  タイトル: Is For Edit

  読取り専用: true

  デフォルト値: false

  リクエストの目的が記事の編集可能なバージョンを取得することだったかどうかを示します。 デフォルト値はfalseです。
• lastModifiedDate: string (date)
  タイトル: Last Modified Date

  読取り専用: true

  この記事が最後に変更された日時。
• lastModifier: lastModifier
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• 所有者: 持ち主
• pending: boolean
  タイトル: Pending

  読取り専用: true

  デフォルト値: false

  この記事バージョンが将来稼働するようにスケジュールされているかどうかを示します。 ほとんどの記事バージョンでは、値はfalseです。
• products: array Products
  タイトル: Products

  記事に関連付けられた製品のリスト。
• publishDate: string (date)
  タイトル: Publish Date

  読取り専用: true

  この記事バージョンが公開された日時。
• published: boolean
  タイトル: Published

  読取り専用: true

  デフォルト値: false

  この記事バージョンが公開されているかどうかを示します。 公開済バージョン以外のすべてのバージョンがある場合、デフォルト値はfalseです。
• publishedContent: publishedContent
• publishedVersion: string
  タイトル: Published Version

  読取り専用: true

  最大長: 50

  この記事にリクエストされたロケールで公開済バージョンがある場合、このフィールドには公開済記事バージョンのバージョン番号が含まれます。
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• reasonForEdit: string
  タイトル: Reason For Edit

  最大長: 2000

  記事バージョンを編集または作成する事由です。
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• sourceMetadata: sourceMetadata
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• userGroups: array User Groups
  タイトル: User Groups

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

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。
• views: array Views
  タイトル: Views

  読取り専用: true

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

{
    "description":"Documentation for BO mode: ContentBO",
    "required":[
        "locale",
        "contentType",
        "contentBody"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        },
        "basedLocale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"Based Locale",
                    "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
                    "readOnly":false
                }
            ]
        },
        "basedOnVersion":{
            "title":"Based On Version",
            "description":"If this article version is a localization, this field may contain the version of the article the localization was created from.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "checkedOut":{
            "title":"Checked Out",
            "description":"The date and time when an author has checked out or locked the document for editing.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "checkedOutBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Checked Out By",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "contentType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "createDate":{
            "format":"date",
            "title":"Create Date",
            "description":"The date and time when this article was originally created.",
            "type":"string",
            "readOnly":true
        },
        "creator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this article version was created.",
            "type":"string",
            "readOnly":true
        },
        "lastModifiedDate":{
            "format":"date",
            "title":"Last Modified Date",
            "description":"The date and time when this article was last modified. ",
            "type":"string",
            "readOnly":true
        },
        "lastModifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Modifier",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "owner":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "pending":{
            "title":"Pending",
            "description":"Indicates whether this article version is scheduled to go live in the future. The value is false for most article versions.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishDate":{
            "format":"date",
            "title":"Publish Date",
            "description":"The date and time when this article version was published.",
            "type":"string",
            "readOnly":true
        },
        "published":{
            "title":"Published",
            "description":"Indicates whether this article version is published. Default value is false for all versions other than the published version, if there is one.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishedVersion":{
            "title":"Published Version",
            "description":"If this article has a published version in the requested locale, this fields will contain the version number of the published article version.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "workflowStep":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepDataBO"
                },
                {
                    "title":"Workflow Step",
                    "description":"The step of the workflow in which the document version currently exist.",
                    "readOnly":true
                }
            ]
        },
        "contentBody":{
            "title":"Content Body",
            "description":"Contents of the article.",
            "type":"object",
            "readOnly":false
        },
        "reasonForEdit":{
            "title":"Reason For Edit",
            "description":"Reasons for editing or creating an article version.",
            "maxLength":2000,
            "type":"string",
            "readOnly":false
        },
        "categories":{
            "title":"Categories",
            "description":"The list of categories associated with the article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryItemKeyBO"
            },
            "readOnly":false
        },
        "isForEdit":{
            "title":"Is For Edit",
            "description":"Indicates whether the purpose of the request was to get an editable version of an article. Default value is false.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "products":{
            "title":"Products",
            "description":"The list of products associated with the article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductItemKeyBO"
            },
            "readOnly":false
        },
        "sourceMetadata":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentHistoryMetadataBO"
                },
                {
                    "title":"sourceMetadata",
                    "description":"Metadata used to provide context to the action which created or modified this content.",
                    "readOnly":false
                }
            ]
        },
        "userGroups":{
            "title":"User Groups",
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserGroupKeyBO"
            },
            "readOnly":false
        },
        "views":{
            "title":"Views",
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewKeyBO"
            },
            "readOnly":true
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Based Locale

  ドキュメントのローカライズされたバージョンの作成に使用されるソース・ロケール。 このフィールドは、コンテンツにローカライズされたバージョンがある場合にのみ表示されます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"Based Locale",
            "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Categories

記事に関連付けられたカテゴリのリスト。

ソースを表示

• Array of: object CategoryItemKeyBO
  BOモードのドキュメント: CategoryItemKeyBO

{
    "title":"Categories",
    "description":"The list of categories associated with the article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CategoryItemKeyBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Checked Out By

  読取り専用: true

  最後のコンテンツ・チェックアウトを実行したユーザーまたは作成者。 次に、checkedOutBy問合せパラメータで使用できるサブフィールドを示します:

  • checkedOutBy.recordId : checkedOutByオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : ユーザーの名。
  • checkedOutBy.lastName : ユーザーの姓。
  • checkedOutBy.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Checked Out By",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

タイプ: object

タイトル: Content Body

記事の内容。

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type

  コンテンツの分類および保存先となるチャネル。 次に、contentType問合せパラメータで使用できるサブフィールドを示します:

  • contentType.recordId : ContentTypeオブジェクトの一意の識別子。
  • contentType.referenceKey : ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。 コンテンツ・タイプのFAQの記事をリクエストする例については、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 創造者

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Creator

  読取り専用: true

  最初にドキュメントを作成または作成したユーザー。 作成者問合せパラメータで使用できるサブフィールドは次のとおりです:

  • creator.recordId : 作成者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : ユーザーの名。
  • creator.lastName : ユーザーの姓。
  • creator.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Modifier

  読取り専用: true

  最後のコンテンツ変更を実行したユーザーまたは作成者。 次に、lastModifier問合せパラメータで使用できるサブフィールドを示します:

  • lastModifier.recordId : lastModifierオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : ユーザーの名。
  • lastModifier.lastName : ユーザーの姓。
  • lastModifier.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Modifier",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 持ち主

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Owner

  読取り専用: true

  ドキュメントを所有または担当するユーザーまたは作成者。 次に、オーナー問合せパラメータで使用できるサブフィールドを示します:

  • owner.recordId : 所有者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
  • owner.email : ユーザーのeメール。
  • owner.firstName : ユーザーの名。
  • owner.lastName : ユーザーの姓。
  • owner.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 製品

タイプ: array

タイトル: Products

記事に関連付けられた製品のリスト。

ソースを表示

• Array of: object ProductItemKeyBO
  BOモードのドキュメント: ProductItemKeyBO

{
    "title":"Products",
    "description":"The list of products associated with the article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductItemKeyBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentHistoryMetadataBO
  コンテンツ履歴Metadata BO
• タイトル: sourceMetadata

  このコンテンツを作成または変更したアクションのコンテキストを提供するために使用されるMetadata。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentHistoryMetadataBO"
        },
        {
            "title":"sourceMetadata",
            "description":"Metadata used to provide context to the action which created or modified this content.",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : ユーザー・グループ

タイプ: array

タイトル: User Groups

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

ソースを表示

• Array of: object UserGroupKeyBO
  BOモードのドキュメント: UserGroupKeyBO

{
    "title":"User Groups",
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UserGroupKeyBO"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Views

読取り専用: true

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

ソースを表示

• Array of: object ViewKeyBO
  BOモードのドキュメント: ViewKeyBO

{
    "title":"Views",
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepDataBO
  BOモードのドキュメント: WorkflowStepDataBO
• タイトル: Workflow Step

  読取り専用: true

  ドキュメント・バージョンが現在存在しているワークフローのステップ。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepDataBO"
        },
        {
            "title":"Workflow Step",
            "description":"The step of the workflow in which the document version currently exist.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: ContentDataBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• basedLocale: basedLocale
• basedOnVersion: string
  タイトル: Based On Version

  読取り専用: true

  最大長: 50

  この記事バージョンがローカリゼーションである場合、このフィールドにはローカリゼーションが作成された記事のバージョンが含まれている可能性があります。
• checkedOut: boolean
  タイトル: Checked Out

  読取り専用: true

  デフォルト値: false

  作成者がドキュメントを編集のためにチェックアウトまたはロックした日時。
• checkedOutBy: checkedOutBy
• contentType(required): contentType
• createDate: string (date)
  タイトル: Create Date

  読取り専用: true

  この記事が最初に作成された日時。
• 作成者: 創造者
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この記事バージョンが作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• lastModifiedDate: string (date)
  タイトル: Last Modified Date

  読取り専用: true

  この記事が最後に変更された日時。
• lastModifier: lastModifier
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• 所有者: 持ち主
• pending: boolean
  タイトル: Pending

  読取り専用: true

  デフォルト値: false

  この記事バージョンが将来稼働するようにスケジュールされているかどうかを示します。 ほとんどの記事バージョンでは、値はfalseです。
• publishDate: string (date)
  タイトル: Publish Date

  読取り専用: true

  この記事バージョンが公開された日時。
• published: boolean
  タイトル: Published

  読取り専用: true

  デフォルト値: false

  この記事バージョンが公開されているかどうかを示します。 公開済バージョン以外のすべてのバージョンがある場合、デフォルト値はfalseです。
• publishedContent: publishedContent
• publishedVersion: string
  タイトル: Published Version

  読取り専用: true

  最大長: 50

  この記事にリクエストされたロケールで公開済バージョンがある場合、このフィールドには公開済記事バージョンのバージョン番号が含まれます。
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• version: string
  タイトル: Version

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。
• workflowStep: workflowStep

{
    "description":"Documentation for BO mode: ContentDataBO",
    "required":[
        "locale",
        "contentType"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        },
        "basedLocale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"Based Locale",
                    "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
                    "readOnly":false
                }
            ]
        },
        "basedOnVersion":{
            "title":"Based On Version",
            "description":"If this article version is a localization, this field may contain the version of the article the localization was created from.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "checkedOut":{
            "title":"Checked Out",
            "description":"The date and time when an author has checked out or locked the document for editing.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "checkedOutBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Checked Out By",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "contentType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "createDate":{
            "format":"date",
            "title":"Create Date",
            "description":"The date and time when this article was originally created.",
            "type":"string",
            "readOnly":true
        },
        "creator":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this article version was created.",
            "type":"string",
            "readOnly":true
        },
        "lastModifiedDate":{
            "format":"date",
            "title":"Last Modified Date",
            "description":"The date and time when this article was last modified. ",
            "type":"string",
            "readOnly":true
        },
        "lastModifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Modifier",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "owner":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":true
                }
            ]
        },
        "pending":{
            "title":"Pending",
            "description":"Indicates whether this article version is scheduled to go live in the future. The value is false for most article versions.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishDate":{
            "format":"date",
            "title":"Publish Date",
            "description":"The date and time when this article version was published.",
            "type":"string",
            "readOnly":true
        },
        "published":{
            "title":"Published",
            "description":"Indicates whether this article version is published. Default value is false for all versions other than the published version, if there is one.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "publishedVersion":{
            "title":"Published Version",
            "description":"If this article has a published version in the requested locale, this fields will contain the version number of the published article version.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "workflowStep":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepDataBO"
                },
                {
                    "title":"Workflow Step",
                    "description":"The step of the workflow in which the document version currently exist.",
                    "readOnly":true
                }
            ]
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Based Locale

  ドキュメントのローカライズされたバージョンの作成に使用されるソース・ロケール。 このフィールドは、コンテンツにローカライズされたバージョンがある場合にのみ表示されます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"Based Locale",
            "description":"The source locale used to create the localized version of the document. This field is seen only if the content has a localized version.",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Checked Out By

  読取り専用: true

  最後のコンテンツ・チェックアウトを実行したユーザーまたは作成者。 次に、checkedOutBy問合せパラメータで使用できるサブフィールドを示します:

  • checkedOutBy.recordId : checkedOutByオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
  • checkedOutBy.email : User's email.
  • checkedOutBy.firstName : ユーザーの名。
  • checkedOutBy.lastName : ユーザーの姓。
  • checkedOutBy.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Checked Out By",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type

  コンテンツの分類および保存先となるチャネル。 次に、contentType問合せパラメータで使用できるサブフィールドを示します:

  • contentType.recordId : ContentTypeオブジェクトの一意の識別子。
  • contentType.referenceKey : ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。 コンテンツ・タイプのFAQの記事をリクエストする例については、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
  • contentType.allowRecommendations : このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 創造者

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Creator

  読取り専用: true

  最初にドキュメントを作成または作成したユーザー。 作成者問合せパラメータで使用できるサブフィールドは次のとおりです:

  • creator.recordId : 作成者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
  • creator.email : User's email.
  • creator.firstName : ユーザーの名。
  • creator.lastName : ユーザーの姓。
  • creator.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Modifier

  読取り専用: true

  最後のコンテンツ変更を実行したユーザーまたは作成者。 次に、lastModifier問合せパラメータで使用できるサブフィールドを示します:

  • lastModifier.recordId : lastModifierオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
  • lastModifier.email : User's email.
  • lastModifier.firstName : ユーザーの名。
  • lastModifier.lastName : ユーザーの姓。
  • lastModifier.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Modifier",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 持ち主

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Owner

  読取り専用: true

  ドキュメントを所有または担当するユーザーまたは作成者。 次に、オーナー問合せパラメータで使用できるサブフィールドを示します:

  • owner.recordId : 所有者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
  • owner.email : ユーザーのeメール。
  • owner.firstName : ユーザーの名。
  • owner.lastName : ユーザーの姓。
  • owner.login : User's login.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepDataBO
  BOモードのドキュメント: WorkflowStepDataBO
• タイトル: Workflow Step

  読取り専用: true

  ドキュメント・バージョンが現在存在しているワークフローのステップ。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepDataBO"
        },
        {
            "title":"Workflow Step",
            "description":"The step of the workflow in which the document version currently exist.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: ContentKeyBO

ソースを表示

• allTranslations: array All Translations
  タイトル: All Translations

  読取り専用: true

  記事の翻訳があれば、そのコレクションが含まれています。
• allVersions: array All Versions
  タイトル: All Versions

  読取り専用: true

  記事のすべてのバージョンのコレクションが含まれます。
• answerId: integer (int64)
  タイトル: Answer ID

  読取り専用: true

  ロケール内の記事の一意の識別子。
• articleStatus: articleStatus
• autoCheckIn: boolean
  タイトル: Auto Check In

  読取り専用: true

  デフォルト値: false

  保存後に記事を自動的にチェックインする必要があるかどうかを示します。
• 自動保存: 自動保存
• autosaveList: array Autosave List
  タイトル: Autosave List

  読取り専用: true

  記事に存在する自動保存のコレクション(ある場合)が含まれます。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この記事が最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  記事がエンド・ユーザーに表示されないようにする日時。
• displayReviewDate: string (date)
  タイトル: Display Review Date

  レビューを実行できる作者によるレビューが記事に必要な日時。
• displayStartDate: string (date)
  タイトル: Display Start Date

  記事がエンド・ユーザーに表示されるようになる日時。
• documentId: string
  タイトル: Document ID

  読取り専用: true

  人間に最も使用可能な記事の一意の識別子。
• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。
• latestContent: latestContent
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• locale(required): ロケール
• publishedContent: publishedContent
• 評価: 評価
• ratingsAggregate: ratingsAggregate
• recordId: string
  タイトル: Record ID

  読取り専用: true

  記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
• reviewInformation: reviewInformation
• schemaAttributes: array Schema Attributes
  タイトル: Schema Attributes

  読取り専用: true

  記事のスキーマに関する情報を返します。
• title: string
  タイトル: Title

  読取り専用: true

  最大長: 4000

  ドキュメントのタイトル。
• version: string
  タイトル: Version

  読取り専用: true

  最大長: 50

  記事のバージョン。
• versionId: string
  タイトル: Version ID

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。

{
    "description":"Documentation for BO mode: ContentKeyBO",
    "required":[
        "locale"
    ],
    "type":"object",
    "properties":{
        "allTranslations":{
            "title":"All Translations",
            "description":"Contains a collection of translations available of an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentDataBO"
            },
            "readOnly":true
        },
        "allVersions":{
            "title":"All Versions",
            "description":"Contains a collection of all versions of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentKeyBO"
            },
            "readOnly":true
        },
        "answerId":{
            "format":"int64",
            "title":"Answer ID",
            "description":"The unique identifier of an article in a locale.",
            "type":"integer",
            "readOnly":true
        },
        "articleStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ArticleStatusKeyBO"
                },
                {
                    "title":"Article Status",
                    "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
                    "readOnly":false
                }
            ]
        },
        "autoCheckIn":{
            "title":"Auto Check In",
            "description":"Indicates whether the article needs to be automatically checked in after saving it.",
            "default":"false",
            "type":"boolean",
            "readOnly":true
        },
        "autosave":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveKeyBO"
                },
                {
                    "title":"Autosave",
                    "description":"autosave record. ",
                    "readOnly":true
                }
            ]
        },
        "autosaveList":{
            "title":"Autosave List",
            "description":"Contains a collection of autosaves that exist for an article, if there are any.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContentAutosaveKeyBO"
            },
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this article was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date and time when the article will stop being available to display to end-users.",
            "type":"string",
            "readOnly":false
        },
        "displayReviewDate":{
            "format":"date",
            "title":"Display Review Date",
            "description":"The date and time when the article requires a review by an author capable of performing the review.",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date and time when the article will be available to display to end-users..",
            "type":"string",
            "readOnly":false
        },
        "documentId":{
            "title":"Document ID",
            "description":"The unique identifier of an article most usable for humans.",
            "type":"string",
            "readOnly":true
        },
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "latestContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Latest Content",
                    "description":"Latest BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocaleKeyBO"
                },
                {
                    "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
                    "readOnly":false
                }
            ]
        },
        "publishedContent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentKeyBO"
                },
                {
                    "title":"Published Content",
                    "description":"Published BO for this document.",
                    "readOnly":true
                }
            ]
        },
        "rating":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormBO"
                },
                {
                    "title":"Rating",
                    "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>",
                    "readOnly":true
                }
            ]
        },
        "ratingsAggregate":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AggregateFormResultsBO"
                },
                {
                    "title":"Ratings Aggregate",
                    "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
                    "readOnly":true
                }
            ]
        },
        "recordId":{
            "title":"Record ID",
            "description":"The unique identifier of the article. This ID is the same in all versions in all locales of the article and is recommended for programmatic use.",
            "type":"string",
            "readOnly":true
        },
        "reviewInformation":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewInformationBO"
                },
                {
                    "title":"Review Information",
                    "description":"Review information added after document marked as reviewed.",
                    "readOnly":true
                }
            ]
        },
        "schemaAttributes":{
            "title":"Schema Attributes",
            "description":"Returns information about the schema of an article.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":true
        },
        "title":{
            "title":"Title",
            "description":"The title of the document.",
            "maxLength":4000,
            "type":"string",
            "readOnly":true
        },
        "version":{
            "title":"Version",
            "description":"The version of the article.",
            "maxLength":50,
            "type":"string",
            "readOnly":true
        },
        "versionId":{
            "title":"Version ID",
            "description":"The unique identifier of the specific version of an article in a specific locale. You cannot use this field in queries made using q query parameter.",
            "maxLength":64,
            "type":"string",
            "readOnly":true
        },
        "versionState":{
            "title":"Version State",
            "description":"The state of a version, possible values are SCHEDULED, LIVE, EXPIRED, DRAFT.",
            "type":"string",
            "readOnly":true
        }
    }
}

ネストされたスキーマ : すべての翻訳

タイプ: array

タイトル: All Translations

読取り専用: true

記事の翻訳があれば、そのコレクションが含まれています。

ソースを表示

• Array of: object ContentDataBO
  BOモードのドキュメント: ContentDataBO

{
    "title":"All Translations",
    "description":"Contains a collection of translations available of an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentDataBO"
    },
    "readOnly":true
}

ネストされたスキーマ : すべてのバージョン

タイプ: array

タイトル: All Versions

読取り専用: true

記事のすべてのバージョンのコレクションが含まれます。

ソースを表示

• Array of: object ContentKeyBO
  BOモードのドキュメント: ContentKeyBO

{
    "title":"All Versions",
    "description":"Contains a collection of all versions of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentKeyBO"
    },
    "readOnly":true
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ArticleStatusKeyBO
  BOモードのドキュメント: ArticleStatusKeyBO
• タイトル: Article Status

  記事ステータス。

  articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

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

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

  OR

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')
  
  

  次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'
  
  

  次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

  • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')
  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

  
  

  指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ArticleStatusKeyBO"
        },
        {
            "title":"Article Status",
            "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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li><p style=\"text-indent:100px;\">OR</p><li><code>http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/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>",
            "readOnly":false
        }
    ]
}

ネストされたスキーマ : 自動保存

すべて一致

ソースを表示

• 「オブジェクト」 ContentAutosaveKeyBO
• タイトル: Autosave

  読取り専用: true

  自動保存レコード。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveKeyBO"
        },
        {
            "title":"Autosave",
            "description":"autosave record. ",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 自動保存リスト

タイプ: array

タイトル: Autosave List

読取り専用: true

記事に存在する自動保存のコレクション(ある場合)が含まれます。

ソースを表示

• Array of: object ContentAutosaveKeyBO

{
    "title":"Autosave List",
    "description":"Contains a collection of autosaves that exist for an article, if there are any.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContentAutosaveKeyBO"
    },
    "readOnly":true
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content such as a reference to an SR this article was created from.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、この記事の作成元のSRへの参照など、コンテンツの外部関連付けを返します。

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Latest Content

  読取り専用: true

  この文書の最新ビジネス・オブジェクト。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Latest Content",
            "description":"Latest BO for this document.",
            "readOnly":true
        }
    ]
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ロケール

すべて一致

ソースを表示

• 「オブジェクト」 LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• タイトル: Locale

  ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

  • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
    http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        {
            "title":"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://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'</code></li></ul>",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentKeyBO
  BOモードのドキュメント: ContentKeyBO
• タイトル: Published Content

  読取り専用: true

  この文書の公開済BO。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentKeyBO"
        },
        {
            "title":"Published Content",
            "description":"Published BO for this document.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 評価

すべて一致

ソースを表示

• 「オブジェクト」 DataFormBO
  BOモードのドキュメント: DataFormBO
• タイトル: Rating

  読取り専用: true

  5つ星またはY/Nタイプの評価かどうかを決定しました。

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormBO"
        },
        {
            "title":"Rating",
            "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>",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 AggregateFormResultsBO
  BOモードのドキュメント: AggregateFormResultsBO
• タイトル: Ratings Aggregate

  読取り専用: true

  集計フォームの結果。 これには、この記事の平均評点、合計レスポンスおよび特定の評点値が含まれます。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AggregateFormResultsBO"
        },
        {
            "title":"Ratings Aggregate",
            "description":"The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "readOnly":true
        }
    ]
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentReviewInformationBO
  コンテンツ・レビュー情報ビジネス・オブジェクト
• タイトル: Review Information

  読取り専用: true

  レビュー済としてマークされた文書の後に追加された情報をレビューします。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewInformationBO"
        },
        {
            "title":"Review Information",
            "description":"Review information added after document marked as reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : スキーマ属性

タイプ: array

タイトル: Schema Attributes

読取り専用: true

記事のスキーマに関する情報を返します。

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Schema Attributes",
    "description":"Returns information about the schema of an article.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: ArticleStatusKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  このリソースに関連するコレクション・リンク
• name: string
  タイトル: Name

  読取り専用: true

  最小長: 1

  最大長: 255

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

  ArticleStatusオブジェクトの一意の識別子。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

{
    "description":"Documentation for BO mode: ArticleStatusKeyBO",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the ArticleStatus object. The name field can only be used for sorting.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":true,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ArticleStatus object.",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the ArticleStatus object. ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

このリソースに関連するコレクション・リンク

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"The collection links related to this resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ソースを表示

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string"
        },
        "sinceVersion":{
            "type":"string"
        }
    }
}

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

タイプ: object

ソースを表示

• autosaveType(required): autosaveType
• dateAdded: string (date)
  タイトル: Date Added

  読取り専用: true

  この自動保存が作成された日時。
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  この自動保存が最後に変更された日時。
• documentId: string
  タイトル: Document Id

  読取り専用: true

  コンテンツが保存されるコンテンツ・タイプを示す文書の一意の識別子。
• locale: object LocaleKeyBO
  BOモードのドキュメント : LocaleKeyBO:

  ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

• recordId: string
• title: string
  最大長: 4000

{
    "required":[
        "autosaveType"
    ],
    "type":"object",
    "properties":{
        "autosaveType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentAutosaveType"
                },
                {
                    "nullable":false
                }
            ]
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this autosave was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time this autosave was last modified.",
            "type":"string",
            "readOnly":true
        },
        "documentId":{
            "title":"Document Id",
            "description":"The unique identifier of a document that indicates the content type in which the content is saved.",
            "type":"string",
            "readOnly":true
        },
        "locale":{
            "$ref":"#/components/schemas/LocaleKeyBO"
        },
        "recordId":{
            "type":"string"
        },
        "title":{
            "maxLength":4000,
            "type":"string"
        }
    }
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "ALL", "CREATED", "EDITED", "TRANSLATED" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentAutosaveType"
        },
        {
            "nullable":false
        }
    ]
}

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

タイプ: object

BOモードのドキュメント : LocaleKeyBO:

ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• localeDesc: string
  タイトル: Locale Desc

  読取り専用: true

  最大長: 100

  Localeオブジェクトが表す言語と国に関する説明。
• recordId: string
  タイトル: Record Id

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

{
    "description":"Documentation for BO mode: LocaleKeyBO: <p>Localized Name of the Locale is currently NOT provided (i.e. The word Japanese is always in Japanese and never localized in say Arabic.)</p>",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "localeDesc":{
            "title":"Locale Desc",
            "description":"The description about the language and country that the Locale object represents.",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the Locale object.",
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ContentExternalAssociationBOのドキュメント

ソースを表示

• alternateId: string
  タイトル: Alternate Id

  外部関連付けの代替識別子
• alternateIdType: string
  タイトル: Alternate Id Type

  外部呼出しの代替タイプ
• objectId(required): string
  タイトル: Object Id

  最小長: 1

  最大長: 50

  外部関連付けの一意の識別子。
• properties: object Properties
  タイトル: Properties

  追加プロパティの許可: additionalProperties

  外部関連付けのプロパティ
• type(required): string
  タイトル: Object Type

  最小長: 1

  最大長: 100

  外部関連付けのタイプ

{
    "description":"Documentation for ContentExternalAssociationBO",
    "required":[
        "objectId",
        "type"
    ],
    "type":"object",
    "properties":{
        "alternateId":{
            "title":"Alternate Id",
            "description":"The alternate identifier of the external association",
            "type":"string"
        },
        "alternateIdType":{
            "title":"Alternate Id Type",
            "description":"The alternate type of the external assocation",
            "type":"string"
        },
        "objectId":{
            "title":"Object Id",
            "description":"The unique identifier of the external association.",
            "maxLength":50,
            "minLength":1,
            "type":"string",
            "nullable":false
        },
        "properties":{
            "title":"Properties",
            "description":"The properties of the external association",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "type":{
            "title":"Object Type",
            "description":"The type of the external association",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "nullable":false
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

タイトル: Properties

追加プロパティの許可

ソースを表示

• 文字列

{
    "title":"Properties",
    "description":"The properties of the external association",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

外部関連付けのプロパティ

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

タイプ: object

BOモードのドキュメント: DataFormBO

ソースを表示

• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このDataFormオブジェクトが作成された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このDataFormオブジェクトが最後に変更された日時。
• displayEndDate: string (date)
  タイトル: Display End Date

  サービスがエンド・ユーザーへのデータ・フォームの表示を停止する日付
• displayStartDate: string (date)
  タイトル: Display Start Date

  データ・フォームをエンドユーザーに表示できるようになる日付
• emailContent: boolean
  タイトル: Email Content

  DataFormオブジェクトのemailContentフィールド
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

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

  質問と多数の関係
• ratingType: integer (int32)
  タイトル: Rating Type

  5つ星評価かY/Nタイプの評価かを決定

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  DataFormオブジェクトの参照キー
• ユーザー: ユーザー
• views: array Views
  タイトル: Views

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

{
    "description":"Documentation for BO mode: DataFormBO",
    "required":[
        "recordId",
        "referenceKey",
        "dateAdded",
        "dateModified"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataForm object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataForm object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this DataForm object was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this DataForm object was last modified.",
            "type":"string",
            "readOnly":true
        },
        "displayEndDate":{
            "format":"date",
            "title":"Display End Date",
            "description":"The date when the service stops the display of the data form to the end users",
            "type":"string",
            "readOnly":false
        },
        "displayStartDate":{
            "format":"date",
            "title":"Display Start Date",
            "description":"The date when the data form will be available to display to end-users",
            "type":"string",
            "readOnly":false
        },
        "emailContent":{
            "title":"Email Content",
            "description":"The emailContent field of the DataForm object",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The name of the data form.  The name field can only be used for sorting.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "ratingType":{
            "format":"int32",
            "title":"Rating Type",
            "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",
            "readOnly":false
        },
        "questions":{
            "title":"Questions",
            "description":"To Many Relationship to Question",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataFormQuestionBO"
            },
            "readOnly":false
        },
        "user":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"User",
                    "description":"Relationship to User",
                    "readOnly":false
                }
            ]
        },
        "views":{
            "title":"Views",
            "description":"To Many Relationship to View",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewKeyBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Questions

質問と多数の関係

ソースを表示

• Array of: object DataFormQuestionBO
  BOモードのドキュメント: QuestionBO

{
    "title":"Questions",
    "description":"To Many Relationship to Question",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataFormQuestionBO"
    },
    "readOnly":false
}

ネストされたスキーマ : ユーザー

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: User

  ユーザーとの関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"User",
            "description":"Relationship to User",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Views

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

ソースを表示

• Array of: object ViewKeyBO
  BOモードのドキュメント: ViewKeyBO

{
    "title":"Views",
    "description":"To Many Relationship to View",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewKeyBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: QuestionBO

ソースを表示

• answers: array Answers
  タイトル: Answers

  回答との関連性が多すぎます
• dataForm: dataForm
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  DataFormQuestionオブジェクトが作成された日時
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  DataFormQuestionオブジェクトが最後に変更された日時
• isMasterIdentifier: boolean
  タイトル: Is Master Identifier

  DataFormQuestionオブジェクトのisMasterIdentifierフィールド
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  DataFormQuestionオブジェクトのローカライズされた名前
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormQuestionオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormQuestionオブジェクトの参照キー
• required: boolean
  タイトル: Required

  この質問が必須かどうかを示すフラグ
• sortOrder: integer (int32)
  タイトル: Sort Order

  この質問のソート順
• specialTypeIndicator: integer (int32)
  タイトル: Special Type Indicator

  DataFormQuestionオブジェクトのspecialTypeIndicatorフィールド

{
    "description":"Documentation for BO mode: QuestionBO",
    "required":[
        "recordId",
        "dateAdded",
        "dateModified",
        "name"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormQuestion object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormQuestion object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time the DataFormQuestion object was created",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time the DataFormQuestion object was last modified",
            "type":"string",
            "readOnly":true
        },
        "isMasterIdentifier":{
            "title":"Is Master Identifier",
            "description":"The isMasterIdentifier field of the DataFormQuestion object",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the DataFormQuestion object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "required":{
            "title":"Required",
            "description":"The flag that indicates whether or not this question is required",
            "type":"boolean",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The sort order of this question",
            "type":"integer",
            "readOnly":false
        },
        "specialTypeIndicator":{
            "format":"int32",
            "title":"Special Type Indicator",
            "description":"The specialTypeIndicator field of the DataFormQuestion object",
            "type":"integer",
            "readOnly":false
        },
        "answers":{
            "title":"Answers",
            "description":"To Many Relationship to Answer",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataFormAnswerBO"
            },
            "readOnly":false
        },
        "dataForm":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormKeyBO"
                },
                {
                    "title":"Data Form",
                    "description":"Relationship to Rating",
                    "readOnly":false
                }
            ]
        }
    }
}

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

タイプ: array

タイトル: Answers

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

ソースを表示

• Array of: object DataFormAnswerBO
  BOモードのドキュメント: AnswerBO

{
    "title":"Answers",
    "description":"To Many Relationship to Answer",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataFormAnswerBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 DataFormKeyBO
  BOモードのドキュメント: DataFormKeyBO
• タイトル: Data Form

  評点との関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormKeyBO"
        },
        {
            "title":"Data Form",
            "description":"Relationship to Rating",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AnswerBO

ソースを表示

• dataFormQuestion: dataFormQuestion
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このDataFormAnswerオブジェクトが作成された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このDataFormAnswerオブジェクトが最後に変更された日時。
• defaultAnswer: boolean
  タイトル: Default Answer

  この回答がデフォルトの回答かどうかを示すフラグ
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  DataFormAnswerオブジェクトのローカライズされた名前
• numberValue: integer (int32)
  タイトル: Number Value

  回答の数値
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormAnswerオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormAnswerオブジェクトの参照キー
• sortOrder: integer (int32)
  タイトル: Sort Order

  回答のソート順

{
    "description":"Documentation for BO mode: AnswerBO",
    "required":[
        "recordId",
        "dateAdded",
        "dateModified",
        "name"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormAnswer object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormAnswer object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this DataFormAnswer object was created.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this DataFormAnswer object was last modified.",
            "type":"string",
            "readOnly":true
        },
        "defaultAnswer":{
            "title":"Default Answer",
            "description":"The flag that indicates whether or not this answer is the default answer",
            "type":"boolean",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the DataFormAnswer object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "numberValue":{
            "format":"int32",
            "title":"Number Value",
            "description":"The numeric value of the answer",
            "type":"integer",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The sort order of the answer",
            "type":"integer",
            "readOnly":false
        },
        "dataFormQuestion":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DataFormQuestionKeyBO"
                },
                {
                    "title":"Data Form Question",
                    "description":"Relationship to Question",
                    "readOnly":false
                }
            ]
        }
    }
}

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

すべて一致

ソースを表示

• 「オブジェクト」 DataFormQuestionKeyBO
  BOモードのドキュメント: QuestionKeyBO
• タイトル: Data Form Question

  質問との関係

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DataFormQuestionKeyBO"
        },
        {
            "title":"Data Form Question",
            "description":"Relationship to Question",
            "readOnly":false
        }
    ]
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: QuestionKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormQuestionオブジェクトの一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  DataFormQuestionオブジェクトの参照キー

{
    "description":"Documentation for BO mode: QuestionKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataFormQuestion object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataFormQuestion object",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: DataFormKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  DataFormオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  DataFormオブジェクトの参照キー

{
    "description":"Documentation for BO mode: DataFormKeyBO",
    "required":[
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the DataForm object",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The reference key for the DataForm object",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: UserKeyBO

ソースを表示

• canAssignTask: boolean
  タイトル: Can Assign tasks

  このユーザーがタスクを他のユーザーに割り当てることができるかどうかを返します。
• contentTypePrivileges: array Content Type Privileges
  タイトル: Content Type Privileges

  このフィールドは、ユーザーが所有するすべてのcontenttype権限のリストを返します
• email: string
  タイトル: Email

  最大長: 100

  ユーザーの電子メール・アドレス
• externalId: integer (int64)
  タイトル: External Id

  読取り専用: true

  ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
• functionalPrivileges: object Functional Privileges of user
  タイトル: Functional Privileges of user

  追加プロパティの許可: additionalProperties

  このフィールドは、ユーザーが所有するすべての権限のリストを返します
• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• login: string
  タイトル: Login

  最大長: 100

  ユーザーのログイン
• name: string
  タイトル: Name

  読取り専用: true

  最大長: 100

  ユーザーのフルネーム
• recordId(required): integer (int64)
  タイトル: Record Id

  読取り専用: true

  ユーザーの一意の識別子

{
    "description":"Documentation for BO mode: UserKeyBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "canAssignTask":{
            "title":"Can Assign tasks",
            "description":"Returns whether this user can assign tasks to other users.",
            "type":"boolean",
            "readOnly":false
        },
        "contentTypePrivileges":{
            "title":"Content Type Privileges",
            "description":"This field will return list of all contenttype privileges user have",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeContentTypeBO"
            },
            "readOnly":false
        },
        "email":{
            "title":"Email",
            "description":"The user's e-mail address",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "externalId":{
            "format":"int64",
            "title":"External Id",
            "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",
            "readOnly":true
        },
        "functionalPrivileges":{
            "title":"Functional Privileges of user ",
            "description":"This field will return list of all fucntional privileges user have",
            "type":"object",
            "additionalProperties":{
                "type":"boolean"
            },
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "login":{
            "title":"Login",
            "description":"The user's login",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"User's full name",
            "maxLength":100,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "format":"int64",
            "title":"Record Id",
            "description":"The unique identifier of the user",
            "type":"integer",
            "readOnly":true
        }
    }
}

ネストされたスキーマ : コンテンツ・タイプ権限

タイプ: array

タイトル: Content Type Privileges

このフィールドは、ユーザーが所有するすべてのcontenttype権限のリストを返します

ソースを表示

• Array of: object CompositeContentTypeBO
  ContentTypeBOおよびそのフラット化されたリレーションの複合。 行にさらに内容を追加できることに注意してください

{
    "title":"Content Type Privileges",
    "description":"This field will return list of all contenttype privileges user have",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeContentTypeBO"
    },
    "readOnly":false
}

ネストされたスキーマ : ユーザーの機能権限

タイプ: object

タイトル: Functional Privileges of user

追加プロパティの許可

ソースを表示

• ブール

{
    "title":"Functional Privileges of user ",
    "description":"This field will return list of all fucntional privileges user have",
    "type":"object",
    "additionalProperties":{
        "type":"boolean"
    },
    "readOnly":false
}

このフィールドは、ユーザーが所有するすべての権限のリストを返します

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

ContentTypeBOおよびそのフラット化されたリレーションの複合。 行にさらに内容を追加できることに注意してください

ソースを表示

• compositeWorkflowSteps(required): array WorkflowSteps Composite BO
  タイトル: WorkflowSteps Composite BO

  このコンテンツ・タイプにマップされたWorkflowStepsおよびそのコンテンツに対するユーザー権限
• contentTypeKeyBO(required): contentTypeKeyBO
• hasContentTypeAccess: boolean
  タイトル: Has Content Type Access

  ContentTypeBO権限がユーザーに対して有効かどうかを検証
• listOfPrivilege(required): array List Of Privilege
  タイトル: List Of Privilege

  ContentTypeの権限のリスト

{
    "description":"Composite of ContentTypeBO and its flattened relation. Keep in mind we can add more stuff down the line",
    "required":[
        "compositeWorkflowSteps",
        "contentTypeKeyBO",
        "listOfPrivilege"
    ],
    "type":"object",
    "properties":{
        "compositeWorkflowSteps":{
            "title":"WorkflowSteps Composite BO",
            "description":"WorkflowSteps mapped to this content type and user privileges on that",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompositeWorkflowStepBO"
            },
            "readOnly":false,
            "nullable":false
        },
        "contentTypeKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentTypeKeyBO"
                },
                {
                    "title":"Content Type Key BO",
                    "description":"ContentBO object being created or updated",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        },
        "hasContentTypeAccess":{
            "title":"Has Content Type Access",
            "description":"Verifies if ContentTypeBO privileges are valid for user",
            "type":"boolean",
            "readOnly":false
        },
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the ContentType",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":false
        }
    }
}

ネストされたスキーマ : WorkflowStepsコンポジットBO

タイプ: array

タイトル: WorkflowSteps Composite BO

このコンテンツ・タイプにマップされたWorkflowStepsおよびそのコンテンツに対するユーザー権限

ソースを表示

• Array of: object CompositeWorkflowStepBO
  このステップに対するユーザー権限を持つWorkflowStepBOのコンポジット。

{
    "title":"WorkflowSteps Composite BO",
    "description":"WorkflowSteps mapped to this content type and user privileges on that",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompositeWorkflowStepBO"
    },
    "readOnly":false,
    "nullable":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 ContentTypeKeyBO
  BOモードのドキュメント: ContentTypeKeyBO
• タイトル: Content Type Key BO

  作成または更新されるContentBOオブジェクト

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentTypeKeyBO"
        },
        {
            "title":"Content Type Key BO",
            "description":"ContentBO object being created or updated",
            "readOnly":false,
            "nullable":false
        }
    ]
}

ネストされたスキーマ : 権限のリスト

タイプ: array

タイトル: List Of Privilege

ContentTypeの権限のリスト

ソースを表示

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the ContentType",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false,
    "nullable":false
}

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

タイプ: object

このステップに対するユーザー権限を持つWorkflowStepBOのコンポジット。

ソースを表示

• listOfPrivilege(required): array List Of Privilege
  タイトル: List Of Privilege

  WorkflowStepの権限のリスト
• WorkflowStepKeyBO(required): WorkflowStepKeyBO

{
    "description":"Composite of WorkflowStepBO with user privileges on this step.",
    "required":[
        "listOfPrivilege",
        "WorkflowStepKeyBO"
    ],
    "type":"object",
    "properties":{
        "listOfPrivilege":{
            "title":"List Of Privilege",
            "description":"List of Privileges for the WorkflowStep",
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":false,
            "nullable":false
        },
        "WorkflowStepKeyBO":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowStepKeyBO"
                },
                {
                    "title":"WorkflowStep Key BO",
                    "description":"WorkflowStep object being fetched",
                    "readOnly":false,
                    "nullable":false
                }
            ]
        }
    }
}

ネストされたスキーマ : 権限のリスト

タイプ: array

タイトル: List Of Privilege

WorkflowStepの権限のリスト

ソースを表示

• Array of: string

{
    "title":"List Of Privilege",
    "description":"List of Privileges for the WorkflowStep",
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":false,
    "nullable":false
}

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

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowStepKeyBO
  BOモードのドキュメント: WorkflowStepKeyBO
• タイトル: WorkflowStep Key BO

  フェッチされるWorkflowStepオブジェクト

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowStepKeyBO"
        },
        {
            "title":"WorkflowStep Key BO",
            "description":"WorkflowStep object being fetched",
            "readOnly":false,
            "nullable":false
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: WorkflowStepKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ワークフロー・ステップのローカライズされた名前
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  WORKFLOWSTEP表からのGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

  ワークフロー・ステップのローカライズされていない名前
• workflowId(required): string
  タイトル: WorkflowRecord Id

  読取り専用: true

  WORKFLOW表からのGUID

{
    "description":"Documentation for BO mode: WorkflowStepKeyBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the workflow step",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: ContentTypeKeyBO

ソースを表示

• description: string
  タイトル: Description

  最大長: 255

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

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  ContentTypeオブジェクトの名前。 名前フィールドはソートにのみ使用できます。 コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。
• recordId: string
  タイトル: Record Id

  読取り専用: true

  ContentTypeオブジェクトの一意の識別子。
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

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

  最大長: 30

  ストライプ・コードを示す参照コード。
• usageCode: string
  タイトル: Usage Code

  読取り専用: true

  最大長: 30

  製品使用コードを示す参照コードです。
• ワークフロー: ワークフロー

{
    "description":"Documentation for BO mode: ContentTypeKeyBO",
    "required":[
        "name",
        "referenceKey",
        "stripeCd"
    ],
    "type":"object",
    "properties":{
        "description":{
            "title":"Description",
            "description":"The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The name for the ContentType object.  The name field can only be used for sorting. Content Types support multiple languages. This field identifies the object associated with the language specified by the user. ",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ContentType object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"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.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe Cd",
            "description":"Lookup code that indicates the stripe code.",
            "maxLength":30,
            "type":"string",
            "readOnly":false
        },
        "usageCode":{
            "title":"Usage Code",
            "description":"Lookup code that indicates the product usage code.",
            "maxLength":30,
            "type":"string",
            "readOnly":true
        },
        "workflow":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowKeyBO"
                },
                {
                    "title":"Workflow",
                    "description":"The workflow definition that the author can use while content authoring in a content type.",
                    "readOnly":false
                }
            ]
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

ネストされたスキーマ : ワークフロー

すべて一致

ソースを表示

• 「オブジェクト」 WorkflowKeyBO
• タイトル: Workflow

  コンテンツ・タイプでのコンテンツ・オーサリング中に作成者が使用できるワークフロー定義。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowKeyBO"
        },
        {
            "title":"Workflow",
            "description":"The workflow definition that the author can use while content authoring in a content type.",
            "readOnly":false
        }
    ]
}

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

タイプ: object

ソースを表示

• enabled: boolean
• links: array links
• name: string
  最大長: 255
• recordId: string
• referenceKey: string
  最小長: 0

  最大長: 100
• workflowVersion: integer (int32)

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "name":{
            "maxLength":255,
            "type":"string"
        },
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "workflowVersion":{
            "format":"int32",
            "type":"integer"
        }
    }
}

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

タイプ: array

ソースを表示

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

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

タイプ: object

BOモードのドキュメント: ViewKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ビューのローカライズ名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  ビュー定義を含むSITE表のGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

  ビューのローカライズされていない参照キー
• stripeCd: string
  タイトル: Stripe CD

  最大長: 30

  ビューのストライプ

{
    "description":"Documentation for BO mode: ViewKeyBO",
    "required":[
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the view",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID of the SITE table containing the view definition",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized reference key for the view",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe of a view",
            "maxLength":30,
            "type":"string",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: AggregateFormResultsBO

ソースを表示

• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• questions: array Questions
  タイトル: Questions

  AggregateQuestionResultとの関係が多すぎます
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateFormResultsオブジェクトの一意のレコードID。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

  AggregateFormResultsオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateFormResultsBO",
    "required":[
        "recordId"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateFormResults object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateFormResults object",
            "type":"integer",
            "readOnly":false
        },
        "questions":{
            "title":"Questions",
            "description":"To Many Relationship to AggregateQuestionResult",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AggregateQuestionResultBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Questions

AggregateQuestionResultとの関係が多すぎます

ソースを表示

• Array of: object AggregateQuestionResultBO
  BOモードのドキュメント: AggregateQuestionResultBO

{
    "title":"Questions",
    "description":"To Many Relationship to AggregateQuestionResult",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AggregateQuestionResultBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AggregateQuestionResultBO

ソースを表示

• answers: array Answers
  タイトル: Answers

  AggregateAnswerResultとの関係が多すぎます
• averageResponse: number (double)
  タイトル: Average Response

  AggregateQuestionResultオブジェクトのAverageResponse
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  質問のローカライズされた表示名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateQuestionResultオブジェクトの一意のレコードID。
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 255

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

  AggregateQuestionResultオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateQuestionResultBO",
    "required":[
        "name",
        "recordId",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "description":"Localized display name for the Question",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateQuestionResult object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "averageResponse":{
            "format":"double",
            "title":"Average Response",
            "description":"AverageResponse of the AggregateQuestionResult object",
            "type":"number",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateQuestionResult object",
            "type":"integer",
            "readOnly":false
        },
        "answers":{
            "title":"Answers",
            "description":"To Many Relationship to AggregateAnswerResult",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AggregateAnswerResultBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Answers

AggregateAnswerResultとの関係が多すぎます

ソースを表示

• Array of: object AggregateAnswerResultBO
  BOモードのドキュメント: AggregateAnswerResultBO

{
    "title":"Answers",
    "description":"To Many Relationship to AggregateAnswerResult",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AggregateAnswerResultBO"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: AggregateAnswerResultBO

ソースを表示

• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 255

  回答のローカライズされた表示名
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  AggregateAnswerResultオブジェクトの一意のレコードID。
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

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

  AggregateAnswerResultオブジェクトのTotalResponses

{
    "description":"Documentation for BO mode: AggregateAnswerResultBO",
    "required":[
        "name",
        "recordId"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"Name",
            "description":"Localized display name for the Answer",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique record ID of the AggregateAnswerResult object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "totalResponses":{
            "format":"int64",
            "title":"Total Responses",
            "description":"TotalResponses of the AggregateAnswerResult object",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

コンテンツ・レビュー情報ビジネス・オブジェクト

ソースを表示

• lastUpdateDate: string (date)
  タイトル: Last Update Date

  読取り専用: true

  文書がレビュー済としてマークされた日付。
• lastUpdatedBy: lastUpdatedBy
• 状態: 国家

{
    "description":"Content Review Information BO",
    "type":"object",
    "properties":{
        "lastUpdateDate":{
            "format":"date",
            "title":"Last Update Date",
            "description":"The date when the document was marked reviewed.",
            "type":"string",
            "readOnly":true
        },
        "lastUpdatedBy":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/UserKeyBO"
                },
                {
                    "title":"Last Updated By",
                    "description":"The user or author who marked document reviewed.",
                    "readOnly":true
                }
            ]
        },
        "state":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ContentReviewState"
                },
                {
                    "title":"State",
                    "description":" review state for document.",
                    "readOnly":true
                }
            ]
        }
    }
}

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

すべて一致

ソースを表示

• 「オブジェクト」 UserKeyBO
  BOモードのドキュメント: UserKeyBO
• タイトル: Last Updated By

  読取り専用: true

  レビュー済文書をマークしたユーザーまたは作成者。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserKeyBO"
        },
        {
            "title":"Last Updated By",
            "description":"The user or author who marked document reviewed.",
            "readOnly":true
        }
    ]
}

ネストされたスキーマ : 国家

すべて一致

ソースを表示

• 文字列
  許可された値: [ "REVIEWED" ]
• タイトル: State

  読取り専用: true

  ドキュメントのレビュー状態。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ContentReviewState"
        },
        {
            "title":"State",
            "description":" review state for document.",
            "readOnly":true
        }
    ]
}

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

タイプ: object

BOモードのドキュメント: SchemaAttributeBO

ソースを表示

• allowMultipleNodes: boolean
  タイトル: Allow Multiple Nodes

  このタイプの複数のノードが許可されるかどうかを示すフラグ@since 8.3
• allowPreselectedUserGroupChange: boolean
  タイトル: Allow Preselected User Group Change

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

  現在の要素の子ノードのリスト
• counter: integer (int32)
  タイトル: Counter

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

  最大長: 50

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

  読取り専用: true

  このSchemaAttribute定義が最初に作成された日時
• dateModified: string (date)
  タイトル: Date Modified

  読取り専用: true

  このSchemaAttribute定義が最後に変更された日時
• description: string
  タイトル: Description

  最大長: 1000

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

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

  このフィールドを全文索引に含めるかどうかを示すフラグ。 このフィールドは、以前は索引可能と呼ばれていました@since 8.3
• includeInMasterIdentifier: boolean
  タイトル: Include In Master Identifier

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

  この要素がノードであるかどうかを示すフラグ@since 8.3
• isRequired: boolean
  タイトル: Is Required

  属性を必須フィールドにします@since 8.3
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• localizedAttributes: array Localized Attributes
  タイトル: Localized Attributes

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

  最小長: 1

  最大長: 255

  属性のローカライズされた名前。 これはスキーマ内で一意である必要はありません。
• readOnly: boolean
  タイトル: Read Only

  このフィールドが編集可能かどうかを示すフラグ
• recordId: string
  タイトル: Record Id

  読取り専用: true

  SchemaAttributeオブジェクトの一意の識別子
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

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

  ワークフローが使用可能な場合、属性にはワークフロー承認が必要です
• schemaAttributeUserGroupList: array Schema Attribute User Group List
  タイトル: Schema Attribute User Group List

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

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

  選択したユーザー・グループに属性を制限
• securityRegex: string
  タイトル: Security Regex

  最大長: 100

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

  編集フォーム内のスキーマ属性の表示順序
• textHeight: string
  タイトル: Text Height

  最大長: 10

  テキスト領域およびリッチ・テキスト・フィールドのテキストの高さを指定
• textWidth: string
  タイトル: Text Width

  最大長: 10

  テキスト・フィールドの最大長を指定
• userGroupSelectionRequired: boolean
  タイトル: User Group Selection Required

  属性にはユーザー・グループが必要です
• wysiwygType: wysiwygType
• xpath: string
  タイトル: Xpath

  最大長: 2000

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

{
    "description":"Documentation for BO mode: SchemaAttributeBO",
    "required":[
        "name",
        "referenceKey"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the attribute. This need NOT be unique within the Schema.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"Unique identifier for the SchemaAttribute object",
            "type":"string",
            "readOnly":true
        },
        "xpath":{
            "title":"Xpath",
            "description":"The XPATH of this attribute within the schema. This is unique within the Schema.",
            "maxLength":2000,
            "type":"string",
            "readOnly":false
        },
        "allowMultipleNodes":{
            "title":"Allow Multiple Nodes",
            "description":"Flag indicating if multiple nodes are allowed of this type@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "allowPreselectedUserGroupChange":{
            "title":"Allow Preselected User Group Change",
            "description":"Enable editors to modify preselected user group restrictions@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "counter":{
            "format":"int32",
            "title":"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",
            "readOnly":false
        },
        "counterPrefix":{
            "title":"Counter Prefix",
            "description":"This attribute contains the prefix that is appended to the front of the DOC ID counter",
            "maxLength":50,
            "type":"string",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this SchemaAttribute definition was first created",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this SchemaAttribute definition was last modified",
            "type":"string",
            "readOnly":true
        },
        "description":{
            "title":"Description",
            "description":"Localized help text for the attribute. This text is displayed in the authoring view",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        },
        "enableAttributeLevelSearch":{
            "title":"Enable Attribute Level Search",
            "description":"Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This fieldwas previously called searchable@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "enableFullTextSearch":{
            "title":"Enable Full Text Search",
            "description":"Flag indicating whether this field should be included in the full text index. This field was previouslycalled indexable@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "includeInMasterIdentifier":{
            "title":"Include In Master Identifier",
            "description":"Flag indicating whether this field should be appended to the master identifier of the document",
            "type":"boolean",
            "readOnly":false
        },
        "isNode":{
            "title":"Is Node",
            "description":"Flag indicating if this element is a node@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "isRequired":{
            "title":"Is Required",
            "description":"Make attribute a required field@since 8.3",
            "type":"boolean",
            "readOnly":false
        },
        "readOnly":{
            "title":"Read Only",
            "description":"Flag indicating whether this field is editable",
            "type":"boolean",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "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.",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "requireWorkflowApproval":{
            "title":"Require Workflow Approval",
            "description":"Attribute requires workflow approval if workflow is enabled",
            "type":"boolean",
            "readOnly":false
        },
        "schemaAttrType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SchemaAttributeTypeEnum"
                },
                {
                    "title":"Schema Attr Type",
                    "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
                    "readOnly":false
                }
            ]
        },
        "secureWithUserGroups":{
            "title":"Secure With User Groups",
            "description":"Restrict attribute to selected user groups",
            "type":"boolean",
            "readOnly":false
        },
        "securedFileResource":{
            "title":"Secured File Resource",
            "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",
            "readOnly":false
        },
        "securityRegex":{
            "title":"Security Regex",
            "description":"The regular expression used to validate the field against security attacks.",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"Display order of the schema attributes within the edit form",
            "type":"integer",
            "readOnly":false
        },
        "textHeight":{
            "title":"Text Height",
            "description":"Specifies the text height for text areas and rich text fields",
            "maxLength":10,
            "type":"string",
            "readOnly":false
        },
        "textWidth":{
            "title":"Text Width",
            "description":"Specifies the max length for text fields",
            "maxLength":10,
            "type":"string",
            "readOnly":false
        },
        "userGroupSelectionRequired":{
            "title":"User Group Selection Required",
            "description":"User groups are required for attribute",
            "type":"boolean",
            "readOnly":false
        },
        "wysiwygType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/WysiwygTypeEnum"
                },
                {
                    "title":"Wysiwyg Type",
                    "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM@since 8.3",
                    "readOnly":false
                }
            ]
        },
        "children":{
            "title":"Children",
            "description":"List of child nodes of the current element",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeBO"
            },
            "readOnly":false
        },
        "localizedAttributes":{
            "title":"Localized Attributes",
            "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocalizedAttributesBO"
            },
            "readOnly":false
        },
        "schemaAttributeUserGroupList":{
            "title":"Schema Attribute User Group List",
            "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",
            "items":{
                "$ref":"#/components/schemas/SchemaAttributeUserGroupBO"
            },
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Children

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

ソースを表示

• Array of: object SchemaAttributeBO
  BOモードのドキュメント: SchemaAttributeBO

{
    "title":"Children",
    "description":"List of child nodes of the current element",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeBO"
    },
    "readOnly":false
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

ネストされたスキーマ : ローカライズされた属性

タイプ: array

タイトル: Localized Attributes

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

ソースを表示

• Array of: object LocalizedAttributesBO

{
    "title":"Localized Attributes",
    "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LocalizedAttributesBO"
    },
    "readOnly":false
}

ネストされたスキーマ : スキーマ属性ユーザー・グループ・リスト

タイプ: array

タイトル: Schema Attribute User Group List

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

ソースを表示

• Array of: object SchemaAttributeUserGroupBO

{
    "title":"Schema Attribute User Group List",
    "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",
    "items":{
        "$ref":"#/components/schemas/SchemaAttributeUserGroupBO"
    },
    "readOnly":false
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "BOOLEAN", "COUNTER", "DATE", "DATETIME", "FILE", "FLOAT", "INTEGER", "LIST", "TEXT_AREA", "TEXT_FIELD", "TIME", "WYSIWYG_EDIT" ]
• タイトル: Schema Attr Type

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SchemaAttributeTypeEnum"
        },
        {
            "title":"Schema Attr Type",
            "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
            "readOnly":false
        }
    ]
}

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

すべて一致

ソースを表示

• 文字列
  許可された値: [ "BASIC", "FULL", "MEDIUM" ]
• タイトル: Wysiwyg Type

  WYSIWYGリッチ・テキスト・フィールドのタイプ - i.e. FULL, BASIC, MEDIUM@since 8.3

{
    "allOf":[
        {
            "$ref":"#/components/schemas/WysiwygTypeEnum"
        },
        {
            "title":"Wysiwyg Type",
            "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM@since 8.3",
            "readOnly":false
        }
    ]
}

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

タイプ: object

ソースを表示

• description: string
  タイトル: Description

  最大長: 1000

  上のロケールでローカライズされた説明
• localeId(required): string
  タイトル: Locale Id

  読取り専用: true

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

  最小長: 1

  最大長: 255

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

{
    "description":"",
    "required":[
        "localeId",
        "name"
    ],
    "type":"object",
    "properties":{
        "description":{
            "title":"Description",
            "description":"Localized description in the above Locale",
            "maxLength":1000,
            "type":"string",
            "readOnly":false
        },
        "localeId":{
            "title":"Locale Id",
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string",
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"Localized Name in the above Locale",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        }
    }
}

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

タイプ: object

ソースを表示

• defaultValue: boolean
• recordId: string
• userGroup: object UserGroupKeyBO
  BOモードのドキュメント: UserGroupKeyBO

{
    "type":"object",
    "properties":{
        "defaultValue":{
            "type":"boolean"
        },
        "recordId":{
            "type":"string"
        },
        "userGroup":{
            "$ref":"#/components/schemas/UserGroupKeyBO"
        }
    }
}

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

タイプ: object

BOモードのドキュメント: UserGroupKeyBO

ソースを表示

• links: array Links
  タイトル: Links

  読取り専用: true

  このリソースに関連するコレクション・リンク
• name: string
  タイトル: Name

  読取り専用: true

  最大長: 255

  ユーザー・グループのローカライズされた名前。 名前フィールドはソートにのみ使用できます。
• recordId: string
  タイトル: Record Id

  userGroupsリソースを表すTAG表の一意の識別子
• referenceKey: string
  タイトル: Reference Key

  最大長: 255

  ユーザー・グループのローカライズされていない名前
• stripeCd: string
  タイトル: Stripe CD

  読取り専用: true

  最大長: 30

  UserGroupのストライプ

{
    "description":"Documentation for BO mode: UserGroupKeyBO",
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"The collection links related to this resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "name":{
            "title":"Name",
            "description":"The localized name of the user group.  The name field can only be used for sorting.",
            "maxLength":255,
            "type":"string",
            "readOnly":true
        },
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier from the TAG table that represent a userGroups resource",
            "type":"string",
            "readOnly":false
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"The non localized name of the user group",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "stripeCd":{
            "title":"Stripe CD",
            "description":"Stripe for UserGroup",
            "maxLength":30,
            "type":"string",
            "readOnly":true
        }
    }
}

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

タイプ: array

タイトル: Links

読取り専用: true

このリソースに関連するコレクション・リンク

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"The collection links related to this resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

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

タイプ: object

BOモードのドキュメント: WorkflowStepDataBO

ソースを表示

• allowDocumentEditing: boolean
  タイトル: Allow Document Editing

  このステップでドキュメントの編集を許可するかどうかを示すフラグ
• dateAdded(required): string (date)
  タイトル: Date Added

  読取り専用: true

  このワークフロー・ステップが追加された日時。
• dateModified(required): string (date)
  タイトル: Date Modified

  読取り専用: true

  このワークフロー・ステップが最後に変更された日時。
• defaultStepDurationInMinutes: integer (int32)
  タイトル: Default Workflow Step Due date in minutes

  委託期限超過になる前にワークフロー・ステップ・タスクがキューにとどまる時間(分)
• links: array Links
  タイトル: Links

  この単数リソースのREST API正規または収集リンク(あるいはその両方)
• name: string
  タイトル: Name

  最大長: 255

  ワークフロー・ステップのローカライズされた名前
• onlyAssigneeCanAppove: boolean
  タイトル: Can only assignee approve step

  ワークフロー・ステップ・タスク割当先のみがこのステップを承認できるかどうかを示すフラグ
• recordId(required): string
  タイトル: Record Id

  読取り専用: true

  WORKFLOWSTEP表からのGUID
• referenceKey(required): string
  タイトル: Reference Key

  最小長: 1

  最大長: 100

  ワークフロー・ステップのローカライズされていない名前
• sortOrder: integer (int32)
  タイトル: Sort Order

  ワークフロー内のワークフロー・ステップの順序
• workflowId(required): string
  タイトル: WorkflowRecord Id

  読取り専用: true

  WORKFLOW表からのGUID

{
    "description":"Documentation for BO mode: WorkflowStepDataBO",
    "required":[
        "recordId",
        "referenceKey",
        "workflowId",
        "dateAdded",
        "dateModified"
    ],
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"Localized name of the workflow step",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "recordId":{
            "title":"Record Id",
            "description":"GUID from the WORKFLOWSTEP table",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"Non localized name of the workflow step",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "readOnly":false,
            "nullable":false
        },
        "workflowId":{
            "title":"WorkflowRecord Id",
            "description":"GUID from the WORKFLOW table",
            "type":"string",
            "readOnly":true
        },
        "allowDocumentEditing":{
            "title":"Allow Document Editing",
            "description":"Flag indicating whether this step allows document editing",
            "type":"boolean",
            "readOnly":false
        },
        "dateAdded":{
            "format":"date",
            "title":"Date Added",
            "description":"The date and time when this work flow step was added.",
            "type":"string",
            "readOnly":true
        },
        "dateModified":{
            "format":"date",
            "title":"Date Modified",
            "description":"The date and time when this work flow step was last modified.",
            "type":"string",
            "readOnly":true
        },
        "defaultStepDurationInMinutes":{
            "format":"int32",
            "title":"Default Workflow Step Due date in minutes",
            "description":"Time in minutes that the workflow step task will stay in queue before being consdiered overdue",
            "type":"integer",
            "readOnly":false
        },
        "onlyAssigneeCanAppove":{
            "title":"Can only assignee approve step",
            "description":"Flag indicating whether this step can only be approved by workflow step task assignee",
            "type":"boolean",
            "readOnly":false
        },
        "sortOrder":{
            "format":"int32",
            "title":"Sort Order",
            "description":"The order of the workflow steps within the workflow",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: array

タイトル: Links

この単数リソースのREST API正規または収集リンク(あるいはその両方)

ソースを表示

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":false
}

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

タイプ: object

BOモードのドキュメント: CategoryItemKeyBO

ソースを表示

• categoryId(required): integer (int64)
  タイトル: Category Id

  カテゴリの一意の識別子。

{
    "description":"Documentation for BO mode: CategoryItemKeyBO",
    "required":[
        "categoryId"
    ],
    "type":"object",
    "properties":{
        "categoryId":{
            "format":"int64",
            "title":"Category Id",
            "description":"The unique identifier of the category.",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

BOモードのドキュメント: ProductItemKeyBO

ソースを表示

• inventoryItemId: integer (int64)
  タイトル: Inventory Item Id

  製品の一意の識別子。
• organizationId: integer (int64)
  タイトル: Organization Id

  特定のカテゴリの在庫組織ID。
• productGroupId: integer (int64)
  タイトル: Product Group Id

  製品グループの一意の識別子。

{
    "description":"Documentation for BO mode: ProductItemKeyBO",
    "type":"object",
    "properties":{
        "inventoryItemId":{
            "format":"int64",
            "title":"Inventory Item Id",
            "description":"The unique identifier of the product.",
            "type":"integer",
            "readOnly":false
        },
        "organizationId":{
            "format":"int64",
            "title":"Organization Id",
            "description":"The inventory organization id of the specific category.",
            "type":"integer",
            "readOnly":false
        },
        "productGroupId":{
            "format":"int64",
            "title":"Product Group Id",
            "description":"The unique identifier of the product group.",
            "type":"integer",
            "readOnly":false
        }
    }
}

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

タイプ: object

コンテンツ履歴Metadata BO

ソースを表示

• externalAssociations: object Content External Associations
  タイトル: Content External Associations

  読取り専用: true

  使用可能なその他のプロパティ: ContentExternalAssociationBO

  このフィールドは、コンテンツの外部関連付けを返します。
• operation: string
  タイトル: Operation

  このメタデータがコンテキストを提供しているアクション。
• sourceDocId: string
  タイトル: Source Doc Id

  読取り専用: true

  コピーされる記事のdocId。
• sourceLocaleId: string
  タイトル: Source Locale Id

  読取り専用: true

  コピーまたは復元する記事のロケール。
• sourceVersion: string
  タイトル: Source Version

  読取り専用: true

  コピーまたは復元する記事のバージョン。
• sourceVersionId: string
  タイトル: Source Version Id

  コピーされるアクチクルのversionId。

{
    "description":"Content History Metadata BO",
    "type":"object",
    "properties":{
        "externalAssociations":{
            "title":"Content External Associations",
            "description":"This field will return external associations of content.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/ContentExternalAssociationBO"
            },
            "readOnly":true
        },
        "operation":{
            "title":"Operation",
            "description":"The action this metadata is providing context for.",
            "type":"string",
            "readOnly":false
        },
        "sourceDocId":{
            "title":"Source Doc Id",
            "description":"docId of the article being copied.",
            "type":"string",
            "readOnly":true
        },
        "sourceLocaleId":{
            "title":"Source Locale Id",
            "description":"The locale of the article being copied or reverted to.",
            "type":"string",
            "readOnly":true
        },
        "sourceVersion":{
            "title":"Source Version",
            "description":"The version of the article being copied or reverted to.",
            "type":"string",
            "readOnly":true
        },
        "sourceVersionId":{
            "title":"Source Version Id",
            "description":"The versionId of the acticle being copied.",
            "type":"string",
            "readOnly":false
        }
    }
}

ネストされたスキーマ : コンテンツ外部関連

タイプ: object

タイトル: Content External Associations

読取り専用: true

追加プロパティの許可

ソースを表示

• 「オブジェクト」 ContentExternalAssociationBO
  ContentExternalAssociationBOのドキュメント

{
    "title":"Content External Associations",
    "description":"This field will return external associations of content.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/ContentExternalAssociationBO"
    },
    "readOnly":true
}

このフィールドは、コンテンツの外部関連付けを返します。

「トップに戻る」