機械翻訳について
  1. サイト管理用のREST API
  2. タスク
  3. テンプレート
  4. ジョブ

インポート・ジョブによって作成されたテンプレートの取得

get

/sites/management/api/v1/templates/_status/{id}/template

RELATION

完了済インポート・ジョブのインポート済テンプレート。

リリース19.4.1.での導入。

認可

この関係にアクセスするには、関係するテンプレートに対する読取りアクセス権が必要です。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK

リクエスト

GET https://api.example.com/sites/management/api/v1/templates/_status/{id}/template

レスポンス本文

{
  "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6",
  "name": "CafeSupremo",
  "themeName": "value",
  "author": "value",
  "longDescription": "value",
  "defaultLanguage": "en-US",
  "isDeleted": false,
  "granularSecurity": {
    "enabled": false
  },
  "createdAt": "2019-06-01T06:44:17.000Z",
  "isEnterprise": false,
  "description": "A folder for my assets.",
  "lastModifiedAt": "2019-06-01T06:44:17.000Z",
  "thumbnail": {
    "url": "http://cloud.example.com/images/site.png",
    "imageType": "thumbnail"
  }
}

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

404Not Found - Template Job Not Found

テンプレート・ジョブが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションにジョブへのアクセス権がありません。

エラー・コード

OCE-SITEMGMT-009051

解決 - 識別子のチェック

テンプレート・ジョブ識別子が有効であることを確認してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名説明
jobStatus存在しないか、認証されたユーザーに表示されないテンプレート・ジョブ・ステータス。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのTemplateJobNotFoundExceptionDetailスキーマを参照してください。

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Job Not Found",
  "status": "404",
  "detail": "Job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.",
  "o:errorCode": "OCE-SITEMGMT-009051",
  "jobStatus": {
    "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423"
  }
}

リリース19.4.1.での導入。

404Not Found - Relationship Not Found

関係が存在しないため、関係を読み取ろうとしましたが失敗しました。 関係が存在しなくなった場合、または認証されたアイデンティティが関係の詳細の読取りを承認されていない場合に、関係の読取りが失敗する可能性があります。

エラー・コード

PAAS-005027

レスポンス本文の例
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Relationship Not Found",
  "status": "404",
  "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
  "o:errorCode": "PAAS-005027"
}

このリソースは、テンプレート・ジョブ・ステータスとテンプレート・リソース間の関係を表します。 テンプレート・ジョブ・ステータスに関連付けられているテンプレートがない場合、レスポンス・ステータス・コードは204 No Contentになります。 テンプレートが削除されているか、または認証されたユーザーにリソースの読取り権限がない場合、レスポンス・ステータス・コードは「404見つかりません」になり、「関係が見つかりません」エラーがレスポンス本文で返されます。

リクエスト

パス・パラメータ

  • レスポンスを元の非同期ジョブに関連付けるために使用できるジョブ・コンテキスト識別子の値。 非同期ジョブがどのように開始されたかによって、コンテキスト値があるかどうか、およびコンテキスト値は何かが決まります。

問合せパラメータ

  • レスポンスに含めないフィールド名のカンマ区切り文字列。

  • レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。

  • 展開するフィールド名のカンマ区切りの文字列。 値allを使用して、すべての関係を展開します。

    expand問合せパラメータには次のフィールド名を指定できます:

    フィールド名説明
    ownedByこのテンプレートを所有するユーザーまたはクライアント・アプリケーション。
    createdByこのテンプレートを作成したユーザーまたはクライアント・アプリケーション。
    lastModifiedByこのテンプレートを最後に変更したユーザー、クライアント・アプリケーションまたはサービス。
    themeテンプレートに関連付けられているテーマ。
    localizationPolicyエンタープライズ・テンプレートをインポートするときに、関連付けられたローカリゼーション・ポリシーを作成します。
    policyポリシーが作成されると、ポリシーがテンプレートに関連付けられます。
    permissionsテンプレートのユーザー権限。
    membersテンプレートが共有されているユーザーおよびグループ。

  • 拡張のエラーの処理方法を指定します。 指定しない場合は、デフォルトで関連フィールドにエラーの詳細が含まれます。

    有効な値は次のとおりです。

    • ignore - エラーを無視して関係を展開しません。 関連リンクはレスポンスに含まれません
    • include - 展開された関係のかわりにエラー詳細を含めます。 関連リンクが返されます
    • fail - リクエストの拡張の失敗エラー・レスポンスでの失敗

  • レスポンスに含めるフィールド名のカンマ区切りの文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。

  • レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。

    次のリンクは、このリソースにより提供されます:

    リンク関係説明
    parent親リソースが読取り可能な場所を示します。 このリンクはupリンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
    selfリソースの現在の戻り表現を示します。 リソース自体を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
    canonicalリクエストされたリソースの優先表現を示します。 リソースの標準的な形式を表すリンクに使用されます。 たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
    describedByリソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。 スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。

  • レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。 表現が指定されない場合、fields、excludeFields、links、excludeLinksおよびexpand問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。

    次の表現は、return問合せパラメータでサポートされています:

    表現説明
    representationフル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。
    defaultデフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。
    basic基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。
    minimal最小リソース表現。必須プロパティとリンクなしが含まれます。
トップに戻る

レスポンス

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

200レスポンス

OK
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
  • Template

    サイト・テンプレートは、関連付けられた承認ポリシーを使用してサイト作成を管理する方法を提供します。 サイト・テンプレートはドラフトまたは使用可能ステータスで、新規サイトを作成するユーザーに提供されるテンプレートのみを使用できます。 サイト・テンプレートに関連付けられた承認ポリシーにより、サイト管理者によるリクエストの承認など、テンプレートから作成されたサイト・リクエストの承認方法が定義されます。 サイト・テンプレートには、作成できるサイトの視覚的表現を表示するために使用できるサムネイルおよびイメージ・セットが関連付けられます。 サイト・テンプレートには、サイト・フォルダ・リソースの形式で物理テンプレート・アーティファクトとの関係があります。

ネストされたスキーマ : テンプレート

サイト・テンプレートは、関連付けられた承認ポリシーを使用してサイト作成を管理する方法を提供します。 サイト・テンプレートはドラフトまたは使用可能ステータスで、新規サイトを作成するユーザーに提供されるテンプレートのみを使用できます。 サイト・テンプレートに関連付けられた承認ポリシーにより、サイト管理者によるリクエストの承認など、テンプレートから作成されたサイト・リクエストの承認方法が定義されます。 サイト・テンプレートには、作成できるサイトの視覚的表現を表示するために使用できるサムネイルおよびイメージ・セットが関連付けられます。 サイト・テンプレートには、サイト・フォルダ・リソースの形式で物理テンプレート・アーティファクトとの関係があります。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Template-allOf[1]
ネストされたスキーマ : SingularResource
型: object

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示
  • links
ネストされたスキーマ : Template-allOf[1]
型: object
ソースを表示

  • テンプレート作成者の文字列識別子

    リリース21.8.2で導入されました。

  • このテンプレートが作成された日。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

  • createdBy

    このテンプレートを作成したユーザーまたはクライアント・アプリケーション。

  • デフォルト言語の言語コード(例: "en")

    リリース21.8.2で導入されました。
  • 最大長: 1000

    オプションの説明。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。

  • granularSecurity

    テンプレートの詳細なセキュリティ設定。

    リリース22.8.2で導入されました。

  • テンプレートの不変識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

  • テンプレートがソフト削除されたことを示します。 対応するテンプレート・フォルダは、そのテンプレートを所有するユーザーのごみ箱フォルダ内にあります。

    リリース19.4.1.での導入。

  • これがエンタープライズ・テンプレートであるかどうかを示すフラグ

    リリース19.2.3.での導入。

  • 最終変更日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

  • lastModifiedBy

    このテンプレートを最後に変更したユーザー、クライアント・アプリケーションまたはサービス。

  • localizationPolicy

    エンタープライズ・テンプレートをインポートするときに、関連付けられたローカリゼーション・ポリシーを作成します。 このローカリゼーション・ポリシーはテンプレートに関連付けられます。 標準テンプレートの場合、ローカリゼーション・ポリシーはありません。

    リリース19.2.3.での導入。

  • テンプレートの詳細文字列

    リリース21.8.2で導入されました。
  • members

    テンプレートが共有されているユーザーおよびグループ。

    リリース19.4.3での導入。
  • 最大長: 242

    テンプレートのわかりやすい名前。

  • ownedBy

    このテンプレートを所有するユーザーまたはクライアント・アプリケーション。

  • permissions

    テンプレートのユーザー権限。

    リリース22.7.2で導入されました。
  • policy

    ポリシーが作成されると、ポリシーがテンプレートに関連付けられます。 ポリシーがテンプレートに関連付けられていない場合、ポリシー詳細は使用できません。

  • テーマ

    テンプレートに関連付けられているテーマ。 テンプレートからサイトを作成すると、サイトもテーマに関連付けられます。 テーマに公開した変更はライブ・サイトに影響します。

    リリース19.4.1.での導入。

  • このテンプレートで使用されるテーマの名前。

  • サムネイル

    サムネイル・イメージ。 使用可能な場合、これは、このサイト・テンプレートを表示する際にサムネイルとして表示するのに適したイメージです。

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

このテンプレートを作成したユーザーまたはクライアント・アプリケーション。

すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : granularSecurity

テンプレートの詳細なセキュリティ設定。

リリース22.8.2で導入されました。
すべてに一致
ソースを表示
  • GranularSecurity

    詳細なセキュリティ設定を定義します。

    詳細なセキュリティは、認証されたユーザーまたはクライアント・アプリケーションがリソースに対して実行できるアクションを制限します。

    リリース22.8.2で導入されました。
ネストされたスキーマ : lastModifiedBy

このテンプレートを最後に変更したユーザー、クライアント・アプリケーションまたはサービス。

すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : localizationPolicy

エンタープライズ・テンプレートをインポートするときに、関連付けられたローカリゼーション・ポリシーを作成します。 このローカリゼーション・ポリシーはテンプレートに関連付けられます。 標準テンプレートの場合、ローカリゼーション・ポリシーはありません。

リリース19.2.3.での導入。
すべてに一致
ソースを表示
  • LocalizationPolicy

    ローカリゼーション・ポリシーとは、リポジトリ内のテキスト・アセットに適用される翻訳ルールです。 これらのポリシーは、イメージなどのデジタル・アセットには適用されません。 そのコンテンツは、アップロード時に翻訳不可能として分類されます。 コンテンツ・アイテムは、元のアイテム(マスター・コピーとみなされます)に関連付けられた複数の翻訳バージョンを保持できます。

    アイテムをローカライズすると、その言語のアイテムのコピーが作成されます。 たとえば、英語のマスター・コピーを使用してフランス語およびスペイン語に翻訳された、最新のAndroidタブレットに関するブログ投稿があるとします。 ブログ投稿の各バージョンは、個別のエンティティとして存在します。 必要に応じて編集し、他とは異なるアセット・ライフサイクルのステージに設定できます。 フランス語バージョンはレビュー中に、スペイン語バージョンを公開できました。 投稿のコンテンツ・バージョンが2つまたは3つあり、それぞれ翻訳可能で、ステータスが異なる場合があります。

ネストされたスキーマ: members
型: object

テンプレートが共有されているユーザーおよびグループ。

リリース19.4.3での導入。
ソースを表示
  • items

    「テンプレート・メンバー」要素のコレクション。

    リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • CollectionResource

    REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

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

このテンプレートを所有するユーザーまたはクライアント・アプリケーション。

すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : 許可
型: object

テンプレートのユーザー権限。

リリース22.7.2で導入されました。
ソースを表示
  • annotation

    ユーザーが持つ注釈権限のセット。

    有効な値は次のとおりです。

    • read - 注釈を読む
    • write - 注釈の作成
    • update - 注釈の更新
    • delete - 注釈の削除

    リリース22.7.2で導入されました。
  • conversation

    ユーザーが持つ会話権限のセット。

    有効な値は次のとおりです。

    • read - 会話を読む
    • write - 会話への書込み
    • update - 会話の更新
    • delete - 会話の削除

    リリース22.7.2で導入されました。
  • file

    ユーザーが持つファイル・レベルのアクセス権のセット。

    有効な値は次のとおりです。

    • preview - ファイルのプレビュー
    • read - ファイルの読取り
    • write - ファイルへの書込み
    • update - 更新ファイル
    • delete - ファイルの削除

    リリース22.7.2で導入されました。
  • links
  • members

    ユーザーが持つメンバーの権限セット。

    有効な値は次のとおりです。

    • read - メンバーの読み取りと一覧表示
    • add - メンバーに追加
    • update - メンバーの更新
    • remove - メンバーの削除

    リリース22.7.2で導入されました。
  • self

    ユーザーが持つフォルダ・レベルの権限のセット。

    有効な値は次のとおりです。

    • preview - フォルダのプレビュー
    • read - フォルダの読取り
    • write - フォルダへの書込み
    • update - フォルダの更新
    • delete - フォルダ

    リリース22.7.2で導入されました。
  • shareLink
ネストしたスキーマ: policy

ポリシーが作成されると、ポリシーがテンプレートに関連付けられます。 ポリシーがテンプレートに関連付けられていない場合、ポリシー詳細は使用できません。

すべてに一致
ソースを表示
  • Policy

    ポリシーは、サイト関連の操作を実行するリクエストの承認方法と、その操作を実行する際に適用する特定の制限またはデフォルトがあるかどうかを制御します。

    ポリシーはリソースに関連付けられています。たとえば、「サイト作成」ポリシーはサイト・テンプレートに関連付けることができます。 たとえば、サイト作成ポリシーでは、サイト管理者の承認が特定のサイト・テンプレートからのサイトの作成に必要であり、そのサイト・テンプレートのドメイン・ユーザーのセキュリティ・レベルのみが割り当てられることを指定できます。

    ポリシーはinactiveとしてマークできます。これにより、操作の実行またはリクエストを防止できます。

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

テンプレートに関連付けられているテーマ。 テンプレートからサイトを作成すると、サイトもテーマに関連付けられます。 テーマに公開した変更はライブ・サイトに影響します。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • Theme

    テーマでは、色スキーム、フォント・サイズ、フォント・タイプ、ページ・バックグラウンドなど、サイトの一般的なルック・アンド・フィールや全体的なスタイルを定義します。 テーマは、サイト内のページ間に視覚的な統一感を与えます。 デザインを調整し、コンテンツを追加して、スタイル、ブランドおよびビジョンを売り込むサイトを作成します。

    リリース19.4.1.での導入。
ネストされたスキーマ : サムネイル

サムネイル・イメージ。 使用可能な場合、これは、このサイト・テンプレートを表示する際にサムネイルとして表示するのに適したイメージです。

すべてに一致
ソースを表示
  • Image

    サイトおよびサイト・テンプレートのサムネイルまたはプレビュー・イメージの詳細。

ネストされたスキーマ: Identity
識別子: type

ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

リリース20.3.1で導入されました。
すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Identity-allOf[1]
ネストされたスキーマ : Identity-allOf[1]
型: object
ソースを表示

  • 人間が判読できる表示名。

    リリース20.3.1で導入されました。

  • ユーザーまたはクライアント・アプリケーションに対してCECによって割り当てられる識別子値。 識別子はサービスのスコープ内で一意です。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース20.3.1で導入されました。

  • ユーザー名やクライアント・アプリケーション名などの一意の名前。

    リリース20.3.1で導入されました。
  • roles

    ロール

    有効な値は次のとおりです。

    • CECServiceAdministrator - サービス管理者
    • ユーザー列挙の割当
    • ユーザーのパスワードおよびチャレンジ質問の変更
    • サービス・インスタンスの構成、モニターおよび管理
    • CECSitesAdministrator - サイト管理者
    • サイト、テンプレート、テーマまたはコンポーネントの作成
    • CECRepositoryAdministrator - リポジトリ管理者
    • CECDeveloperUser - 開発者ユーザー
    • CECContentAdministrator - コンテンツ管理者
    • 新規コンテンツ・タイプの作成およびアイテムの公開
    • CECStandardUser - 標準ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • サイト内のコンテンツの表示および操作
    • カスタム・プロパティの管理と表示、および値の編集
    • CECEnterpriseUser - エンタープライズ・ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • デジタル・アセット
    • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
    • コンテンツ・アイテムの作成、管理、表示および操作
    • コレクション
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • カスタム・プロパティの管理と表示、および値の編集
    • CECExternalUser - 外部ユーザー
    将来使用するために予約済
    • CECIntegrationUser - 統合ユーザー
    Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
    • CECSitesVisitor - サイト・ビジター
    サイトへのアクセスはビジターに制限されます。

    リリース21.10.2で導入されました。

  • 「アイデンティティ」のタイプ。 有効な値は次のとおりです: user, service, application, unknown。

    リリース20.3.1で導入されました。
ネストされたスキーマ: roles
型: array

ロール

有効な値は次のとおりです。

  • CECServiceAdministrator - サービス管理者
  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者
  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者
  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー
将来使用するために予約済
  • CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
  • CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。

リリース21.10.2で導入されました。
ソースを表示
ネストされたスキーマ : GranularSecurity
型: object

詳細なセキュリティ設定を定義します。

詳細なセキュリティは、認証されたユーザーまたはクライアント・アプリケーションがリソースに対して実行できるアクションを制限します。

リリース22.8.2で導入されました。
ソースを表示

  • リソースに対して詳細なセキュリティを有効にするかどうかを決定します。

    リリース22.8.2で導入されました。
ネストされたスキーマ : LocalizationPolicy

ローカリゼーション・ポリシーとは、リポジトリ内のテキスト・アセットに適用される翻訳ルールです。 これらのポリシーは、イメージなどのデジタル・アセットには適用されません。 そのコンテンツは、アップロード時に翻訳不可能として分類されます。 コンテンツ・アイテムは、元のアイテム(マスター・コピーとみなされます)に関連付けられた複数の翻訳バージョンを保持できます。

アイテムをローカライズすると、その言語のアイテムのコピーが作成されます。 たとえば、英語のマスター・コピーを使用してフランス語およびスペイン語に翻訳された、最新のAndroidタブレットに関するブログ投稿があるとします。 ブログ投稿の各バージョンは、個別のエンティティとして存在します。 必要に応じて編集し、他とは異なるアセット・ライフサイクルのステージに設定できます。 フランス語バージョンはレビュー中に、スペイン語バージョンを公開できました。 投稿のコンテンツ・バージョンが2つまたは3つあり、それぞれ翻訳可能で、ステータスが異なる場合があります。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • LocalizationPolicy-allOf[1]
ネストされたスキーマ : LocalizationPolicy-allOf[1]
型: object
ソースを表示
ネストされたスキーマ : createdDate

ポリシーが作成された日時。

すべてに一致
ソースを表示
ネストされたスキーマ : optionalValues
型: array

オプションの言語値です。

ソースを表示
ネストされたスキーマ : requiredValues
型: array

必須言語の値です。

ソースを表示
ネストされたスキーマ : updatedDate

ポリシーが最後に更新された日時。

すべてに一致
ソースを表示
ネストされたスキーマ : DateTimeZone
型: object

日付、時間およびタイムゾーン。

ソースを表示
ネストされたスキーマ: items
型: array

「テンプレート・メンバー」要素のコレクション。

リリース19.4.1.での導入。
ソースを表示
ネストされたスキーマ : CollectionResource

REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • CollectionResource-allOf[1]
ネストされたスキーマ : CollectionResource-allOf[1]
型: object
ソースを表示

  • レスポンス内のリソースの合計数。

  • コレクションには、リクエストに一致する多くの要素があります。 ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。

  • 実際のレスポンス・サイズ制限。 リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。

  • 使用される実際のレスポンス・オフセット。 リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。

  • リクエストに一致するリソースの合計数。 指定した場合は、使用可能なアイテムの合計数です。 指定されない場合、合計が不明か、または戻り不可能です。 この値を計算するとき、ページング制限またはオフセットは無視されます。 totalResultsパラメータがサポートされていて、クライアントがtrueに設定している場合にのみ返されます。

ネストされたスキーマ: items
型: object
ソースを表示

  • ユーザー、クライアント・アプリケーションまたはグループの表示名。

    リリース19.4.1.での導入。
  • グループ

    メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

    リリース19.4.1.での導入。

  • メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。

    有効な値は次のとおりです。

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース20.1.1で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.4.1.での導入。

  • 関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。

    リリース21.10.2で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。

    リリース19.4.1.での導入。

  • ユーザー、クライアント・アプリケーションまたはグループが与えられた共有ロール。

    有効な値は次のとおりです。

    • owner - ユーザーが所有者です。
    • manager - ユーザーにマネージャ・ロールがあります
    • contributor - ユーザーにコントリビュータ・ロールがあります
    • downloader - ユーザーにはダウンロード実行者ロールがあります
    • viewer - ユーザーの参照者のロール

    リリース19.4.1.での導入。

  • メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。

    有効な値は次のとおりです。

    • user - メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
    クライアント・アプリケーションであるメンバー。
    • group - メンバーはグループです

    リリース19.4.1.での導入。
  • user

    メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

    リリース19.4.1.での導入。
ネストされたスキーマ : グループ

メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • Group

    グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

    リリース19.3.1.での導入。
ネストされたスキーマ: user

メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ: Group

グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

リリース19.3.1.での導入。
すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Group-allOf[1]
ネストされたスキーマ : Group-allOf[1]
型: object
ソースを表示

  • グループに対する、人間が読み取り可能な名前。

    リリース19.3.1.での導入。

  • サービス・インスタンス内で一意のグループ名。

    リリース19.3.1.での導入。

  • グループの一意の識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.3.1.での導入。
  • roles

    ロール

    有効な値は次のとおりです。

    • CECServiceAdministrator - サービス管理者
    • ユーザー列挙の割当
    • ユーザーのパスワードおよびチャレンジ質問の変更
    • サービス・インスタンスの構成、モニターおよび管理
    • CECSitesAdministrator - サイト管理者
    • サイト、テンプレート、テーマまたはコンポーネントの作成
    • CECRepositoryAdministrator - リポジトリ管理者
    • CECDeveloperUser - 開発者ユーザー
    • CECContentAdministrator - コンテンツ管理者
    • 新規コンテンツ・タイプの作成およびアイテムの公開
    • CECStandardUser - 標準ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • サイト内のコンテンツの表示および操作
    • カスタム・プロパティの管理と表示、および値の編集
    • CECEnterpriseUser - エンタープライズ・ユーザー
    • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
    • 他のユーザーとのコンテンツおよびサイトの共有
    • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
    • ユーザーのフォロー
    • デジタル・アセット
    • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
    • コンテンツ・アイテムの作成、管理、表示および操作
    • コレクション
    • サイトの作成、編集および公開
    • サイトのテーマの管理および公開
    • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
    • サイト・テンプレートの作成、編集、エクスポートおよびインポート
    • カスタム・プロパティの管理と表示、および値の編集
    • CECExternalUser - 外部ユーザー
    将来使用するために予約済
    • CECIntegrationUser - 統合ユーザー
    Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
    • CECSitesVisitor - サイト・ビジター
    サイトへのアクセスはビジターに制限されます。

    リリース21.10.2で導入されました。

  • グループのタイプ。

    有効な値は次のとおりです。

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース19.3.1.での導入。
ネストされたスキーマ: roles
型: array

ロール

有効な値は次のとおりです。

  • CECServiceAdministrator - サービス管理者
  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者
  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者
  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー
  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー
将来使用するために予約済
  • CECIntegrationUser - 統合ユーザー
Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。
  • CECSitesVisitor - サイト・ビジター
サイトへのアクセスはビジターに制限されます。

リリース21.10.2で導入されました。
ソースを表示
ネストされたスキーマ : 注釈
型: array

ユーザーが持つ注釈権限のセット。

有効な値は次のとおりです。

  • read - 注釈を読む
  • write - 注釈の作成
  • update - 注釈の更新
  • delete - 注釈の削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ : 会話
型: array

ユーザーが持つ会話権限のセット。

有効な値は次のとおりです。

  • read - 会話を読む
  • write - 会話への書込み
  • update - 会話の更新
  • delete - 会話の削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ : file
型: array

ユーザーが持つファイル・レベルのアクセス権のセット。

有効な値は次のとおりです。

  • preview - ファイルのプレビュー
  • read - ファイルの読取り
  • write - ファイルへの書込み
  • update - 更新ファイル
  • delete - ファイルの削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ: members
型: array

ユーザーが持つメンバーの権限セット。

有効な値は次のとおりです。

  • read - メンバーの読み取りと一覧表示
  • add - メンバーに追加
  • update - メンバーの更新
  • remove - メンバーの削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ: self
型: array

ユーザーが持つフォルダ・レベルの権限のセット。

有効な値は次のとおりです。

  • preview - フォルダのプレビュー
  • read - フォルダの読取り
  • write - フォルダへの書込み
  • update - フォルダの更新
  • delete - フォルダ

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ: Policy

ポリシーは、サイト関連の操作を実行するリクエストの承認方法と、その操作を実行する際に適用する特定の制限またはデフォルトがあるかどうかを制御します。

ポリシーはリソースに関連付けられています。たとえば、「サイト作成」ポリシーはサイト・テンプレートに関連付けることができます。 たとえば、サイト作成ポリシーでは、サイト管理者の承認が特定のサイト・テンプレートからのサイトの作成に必要であり、そのサイト・テンプレートのドメイン・ユーザーのセキュリティ・レベルのみが割り当てられることを指定できます。

ポリシーはinactiveとしてマークできます。これにより、操作の実行またはリクエストを防止できます。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Policy-allOf[1]
ネストされたスキーマ : Policy-allOf[1]
型: object
ソースを表示
  • access

    ポリシーに関連付けられた操作を実行できるユーザーおよびグループのリスト。 たとえば、テンプレートからサイトを作成できるユーザーおよびグループのリストです。 アクセス・リストが空の場合、すべてのユーザーがポリシー操作を実行できます。 アクセス・リストは、ポリシーのaccessTypeがrestrictedに設定されている場合にのみ使用されます。

    リリース19.3.1.での導入。

  • ポリシーをすべてのユーザーに適用するか、アクセス・リストに含まれるユーザーにのみ適用するかを決定します。

    有効な値は次のとおりです。

    • everyone - ポリシー(アクティブな場合)は全員に適用されます
    • restricted - ポリシーは、アクティブな場合、アクセス・リストに含まれるユーザーに適用可能です

    リリース19.3.1.での導入。

  • このポリシーに関連付けられたリクエストが作成される場合、そのリクエストにはポリシーで定義された承認のタイプが必要です。 承認のタイプが自動の場合、リクエストには手動での承認は必要ありません。

    有効な値は次のとおりです。

    • automatic - リクエストは、ユーザーの承認プロセスなしで自動的に承認されます
    • admin - 「サイト管理者」のロールを持つユーザーは、関連するリクエストを承認できます。
    • named - サイトの作成では、ポリシーに関連付けられた承認者リストのメンバーであるユーザーの承認が必要です

  • approvers

    ポリシーに関連付けられたリクエストを承認する権限を持つユーザーおよびグループのリスト。 たとえば、テンプレートからのサイトの作成を承認できるユーザーおよびグループのリストです。 承認リストは、承認タイプが「指定された承認者」に設定されている場合にのみ使用されます。

    リリース19.3.3.での導入。
  • 有効期限

    サイトが作成されたとき、サイト・テンプレートに関連付けられたポリシーにサイト有効期限が設定されている場合、有効期限をサイトに設定できます。 サイトの有効期限が切れている場合、有効期限が延長されないかぎりサイトをアクティブ化できません。

    リリース19.4.1.での導入。

  • ポリシーのグローバル一意識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

  • ローカリゼーション・ポリシーが許可されていない場合、リクエスタはサイトのリクエスト時にローカリゼーション・ポリシーの指定を許可されません。 テンプレートに関連付けられているローカリゼーション・ポリシーが使用されます。 ローカリゼーション・ポリシーが許可されている場合、リクエスタはサイトのリクエスト時に1つ指定する必要があります。 このプロパティは、ポリシーに関連付けられているテンプレートがエンタープライズ・テンプレートの場合にのみ設定できます。

    リリース19.2.3.での導入。
  • repository

    ポリシーを作成または編集する場合、そのポリシーをアセット・リポジトリに関連付けることができます。 新規サイトがリクエストされると、サイトはポリシー定義済アセット・リポジトリに関連付けられます。 リポジトリがポリシーに設定されている場合、ユーザーは新規サイトの作成時にリポジトリを指定できません。 ポリシーに関連付けられたアセット・リポジトリがない場合、ユーザーが新規サイトを作成するときにアセット・リポジトリを指定できます。 アセット・リポジトリは、ポリシーがエンタープライズ・テンプレートに関連付けられている場合にのみポリシーに関連付けることができます。 Standardサイトはアセット・リポジトリに関連付けられません。

    リリース19.2.3.での導入。

  • ポリシーが編集されるたびに、リビジョン番号が増分されます。 改訂番号はゼロから開始します。 リビジョン番号は、リビジョンがこのリソースの強力なETag値としても使用されるため、最後のリクエスト以降にポリシーが変更されたかどうかを確認するために使用できます。

  • security

    サイト作成ポリシーのセキュリティ・ポリシー。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。

  • trueの場合、新規サイトに対するリクエストには、明示的なサイト・プレフィクスを含めることができます。 falseの場合、サイト・プレフィクスを指定しないと、自動的に生成されます。 このプロパティは、ポリシーに関連付けられているテンプレートがエンタープライズ・テンプレートの場合にのみ設定できます。

    リリース19.2.3.での導入。

  • ポリシー・ステータスは、ポリシーに関連付けられた操作の実行にポリシーを使用できるかどうかを指定します。 ポリシー・ステータスがinactiveの場合、操作は実行できません。 ポリシー・ステータスが「アクティブ」の場合は、操作を実行できます。 たとえば、サイト・テンプレートに関連付けられたポリシーの場合、「アクティブ」のステータスは、ユーザーがサイト・テンプレートからサイトを作成できることを意味します。

    有効な値は次のとおりです。

    • inactive - 非アクティブとしてマークされているポリシーは、関連する操作をリクエストできないことを意味
    • active - アクティブとしてマークされているポリシーは、関連する操作がリクエスト可能であることを意味

ネストされたスキーマ : アクセス
型: object

ポリシーに関連付けられた操作を実行できるユーザーおよびグループのリスト。 たとえば、テンプレートからサイトを作成できるユーザーおよびグループのリストです。 アクセス・リストが空の場合、すべてのユーザーがポリシー操作を実行できます。 アクセス・リストは、ポリシーのaccessTypeがrestrictedに設定されている場合にのみ使用されます。

リリース19.3.1.での導入。
ソースを表示
  • items

    「ポリシー・アクセス・メンバー」要素のコレクション。

    リリース19.3.1.での導入。
すべてに一致
ソースを表示
  • CollectionResource

    REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

ネストされたスキーマ : 承認者
型: object

ポリシーに関連付けられたリクエストを承認する権限を持つユーザーおよびグループのリスト。 たとえば、テンプレートからのサイトの作成を承認できるユーザーおよびグループのリストです。 承認リストは、承認タイプが「指定された承認者」に設定されている場合にのみ使用されます。

リリース19.3.3.での導入。
ソースを表示
  • items

    「ポリシー承認者メンバー」要素のコレクション。

    リリース19.3.3.での導入。
すべてに一致
ソースを表示
  • CollectionResource

    REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

ネストされたスキーマ : 有効期限

サイトが作成されたとき、サイト・テンプレートに関連付けられたポリシーにサイト有効期限が設定されている場合、有効期限をサイトに設定できます。 サイトの有効期限が切れている場合、有効期限が延長されないかぎりサイトをアクティブ化できません。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • SiteExpirationPeriod

    サイトの有効期限は、時間と時間の単位で表されます。 たとえば、サイトが作成された後、2か月後にサイトを失効させます。

    リリース19.4.1.での導入。
ネストされたスキーマ : repository

ポリシーを作成または編集する場合、そのポリシーをアセット・リポジトリに関連付けることができます。 新規サイトがリクエストされると、サイトはポリシー定義済アセット・リポジトリに関連付けられます。 リポジトリがポリシーに設定されている場合、ユーザーは新規サイトの作成時にリポジトリを指定できません。 ポリシーに関連付けられたアセット・リポジトリがない場合、ユーザーが新規サイトを作成するときにアセット・リポジトリを指定できます。 アセット・リポジトリは、ポリシーがエンタープライズ・テンプレートに関連付けられている場合にのみポリシーに関連付けることができます。 Standardサイトはアセット・リポジトリに関連付けられません。

リリース19.2.3.での導入。
すべてに一致
ソースを表示
  • Repository

    リポジトリは、テキストとイメージの両方のファイルのストレージ・ロケーションです。 リポジトリ管理者は、リポジトリに対して指定されたチャネル・ポリシーおよびローカリゼーション・ポリシーを使用してリポジトリを作成できます。 様々なマーケティング・ニーズに対応するために、複数のリポジトリを作成できます。

    リポジトリを使用すると、必要なすべてのアセットを1箇所で管理できます。 たとえば、会社でコンピュータ機器を販売するとします。 デスクトップ・コンピュータに関連するファイルを処理するために、1つのリポジトリを設定できます。 タブレットには別のリポジトリを使用できます。 各リポジトリには、様々な種類のコンピュータに関する写真、グラフィックおよびコンテンツを含めることができます。 各リポジトリのアセットは、リポジトリに割り当てるポリシーによって制御されます。

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

サイト作成ポリシーのセキュリティ・ポリシー。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。

すべてに一致
ソースを表示
  • SecurityPolicy

    セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。 サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。 マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。

ネストされたスキーマ: items
型: array

「ポリシー・アクセス・メンバー」要素のコレクション。

リリース19.3.1.での導入。
ソースを表示
ネストされたスキーマ: items
型: object
ソースを表示

  • ユーザー、クライアント・アプリケーションまたはグループの表示名。

    リリース19.3.1.での導入。
  • グループ

    メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

    リリース19.3.1.での導入。

  • メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。

    有効な値は次のとおりです。

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース20.1.1で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.3.1.での導入。

  • 関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。

    リリース21.10.2で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。

    リリース19.3.1.での導入。

  • メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。

    有効な値は次のとおりです。

    • user - メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
    クライアント・アプリケーションであるメンバー。
    • group - メンバーはグループです

    リリース19.3.1.での導入。
  • user

    メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

    リリース19.3.1.での導入。
ネストされたスキーマ : グループ

メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

リリース19.3.1.での導入。
すべてに一致
ソースを表示
  • Group

    グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

    リリース19.3.1.での導入。
ネストされたスキーマ: user

メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

リリース19.3.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ: items
型: array

「ポリシー承認者メンバー」要素のコレクション。

リリース19.3.3.での導入。
ソースを表示
ネストされたスキーマ: items
型: object
ソースを表示

  • ユーザー、クライアント・アプリケーションまたはグループの表示名。

    リリース19.3.3.での導入。
  • グループ

    メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

    リリース19.3.3.での導入。

  • メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。

    有効な値は次のとおりです。

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース20.1.1で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.3.3.での導入。

  • 関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。

    リリース21.10.2で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。

    リリース19.3.3.での導入。

  • メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。

    有効な値は次のとおりです。

    • user - メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
    クライアント・アプリケーションであるメンバー。
    • group - メンバーはグループです

    リリース19.3.3.での導入。
  • user

    メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

    リリース19.3.3.での導入。
ネストされたスキーマ : グループ

メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

リリース19.3.3.での導入。
すべてに一致
ソースを表示
  • Group

    グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

    リリース19.3.1.での導入。
ネストされたスキーマ: user

メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

リリース19.3.3.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : SiteExpirationPeriod
型: object

サイトの有効期限は、時間と時間の単位で表されます。 たとえば、サイトが作成された後、2か月後にサイトを失効させます。

リリース19.4.1.での導入。
ソースを表示

  • サイト失効の測定に使用する期間。

    リリース19.4.1.での導入。

  • サイト失効の測定に使用する時間の単位。

    有効な値は次のとおりです。

    • months - 失効は月数で表されます
    • years - 失効までの年数

    リリース19.4.1.での導入。
ネストされたスキーマ : リポジトリ

リポジトリは、テキストとイメージの両方のファイルのストレージ・ロケーションです。 リポジトリ管理者は、リポジトリに対して指定されたチャネル・ポリシーおよびローカリゼーション・ポリシーを使用してリポジトリを作成できます。 様々なマーケティング・ニーズに対応するために、複数のリポジトリを作成できます。

リポジトリを使用すると、必要なすべてのアセットを1箇所で管理できます。 たとえば、会社でコンピュータ機器を販売するとします。 デスクトップ・コンピュータに関連するファイルを処理するために、1つのリポジトリを設定できます。 タブレットには別のリポジトリを使用できます。 各リポジトリには、様々な種類のコンピュータに関する写真、グラフィックおよびコンテンツを含めることができます。 各リポジトリのアセットは、リポジトリに割り当てるポリシーによって制御されます。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Repository-allOf[1]
ネストされたスキーマ : Repository-allOf[1]
型: object
ソースを表示
ネストされたスキーマ : channels
型: array

リポジトリに関連付けられているチャネル。

ソースを表示
ネストされたスキーマ : contentTypes
型: array

リポジトリに関連付けられたコンテンツ・タイプ。

ソースを表示
ネストされたスキーマ : createdDate

リポジトリの作成日時。

すべてに一致
ソースを表示
ネストされたスキーマ : languageOptions
型: array

リポジトリの言語オプション。

ソースを表示
ネストされたスキーマ : updatedDate

リポジトリが最後に更新された日時。

すべてに一致
ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
ネストされたスキーマ : ChannelId
型: object

チャネル識別子。

ソースを表示

  • リポジトリの一意の識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

  • チャネルを識別するための短くて判読可能な名前。

ネストされたスキーマ: items
すべてに一致
ソースを表示
ネストされたスキーマ : ContentTypeId
型: object

コンテンツ・タイプ識別子。

ソースを表示
ネストされたスキーマ : SecurityPolicy
型: object

セキュリティ・ポリシーでは、サイトに許可されるセキュリティ・レベルの最小レベルを指定します。 サイトはこの最小レベルで作成されます。サイト・マネージャ/所有者は必要に応じてサイトでより制限的なセキュリティ・レベルを設定できます。 マネージャ/所有者は、サイト・セキュリティ・ポリシーで指定された値よりも安全性が低いセキュリティ・レベルは選択できません。

ソースを表示

  • サイトにアクセス可能なユーザーのタイプを定義します。 すべてのユーザーを含めることも、指定ユーザーのみに制限することもできます。

    有効な値は次のとおりです。

    • named - 指定されたレベル内の指定ユーザーのみがアクセスできます
    • all - 指定されたレベル内のすべてのユーザーがアクセスできます

  • サイトに設定できる最大オープン・セキュリティ・レベル。

    有効な値は次のとおりです。

    • service - サービス・ユーザーのみ
    • cloud - ドメインにサインインできるクラウド・ユーザーのみ
    • everyone - サインインせずに誰でも

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

テーマでは、色スキーム、フォント・サイズ、フォント・タイプ、ページ・バックグラウンドなど、サイトの一般的なルック・アンド・フィールや全体的なスタイルを定義します。 テーマは、サイト内のページ間に視覚的な統一感を与えます。 デザインを調整し、コンテンツを追加して、スタイル、ブランドおよびビジョンを売り込むサイトを作成します。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Theme-allOf[1]
ネストされたスキーマ : Theme-allOf[1]
型: object
ソースを表示

  • 作成日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

    リリース19.4.1.での導入。
  • createdBy

    このテーマを作成したユーザーまたはクライアント・アプリケーション。

    リリース19.4.1.での導入。
  • 最大長: 1000

    オプションの説明。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。

    リリース19.4.1.での導入。

  • テーマの不変識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.4.1.での導入。

  • テーマがソフト削除されたことを示します。 対応するテーマ・フォルダは、テーマを所有するユーザーのごみ箱フォルダに配置されます。

    リリース19.4.1.での導入。

  • テーマがテーマであることを示します。 初期テーマとは、新しいサイトを開発する際の実験を目的とした既存のテーマのコピーです。

    リリース22.8.1で導入されました。
  • job

    テーマに割り当てられた現在のジョブのステータス。

    リリース21.9.1で導入されました。

  • 最終変更日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

    リリース19.4.1.での導入。
  • lastModifiedBy

    このテーマを最後に変更したユーザー、クライアント・アプリケーションまたはサービス。

    リリース19.4.1.での導入。
  • members

    テーマが共有されているユーザーおよびグループ。

    リリース19.4.3での導入。
  • 最大長: 255

    テーマの人に読める名前。

    リリース19.4.1.での導入。
  • ownedBy

    このテーマを所有するユーザーまたはクライアント・アプリケーション。

    リリース19.4.1.での導入。
  • permissions

    テーマのユーザー権限。

    リリース22.7.2で導入されました。

  • テーマが公開されているかどうかを示します。

    有効な値は次のとおりです。

    • unpublished - テーマは未公開です
    • published - テーマが公開されました

    リリース19.4.1.での導入。
ネストされたスキーマ : createdBy

このテーマを作成したユーザーまたはクライアント・アプリケーション。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : job

テーマに割り当てられた現在のジョブのステータス。

リリース21.9.1で導入されました。
すべてに一致
ソースを表示
  • SiteJobStatus
    識別子: action

    サイト・ジョブのバックグラウンド・ジョブの詳細。

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

このテーマを最後に変更したユーザー、クライアント・アプリケーションまたはサービス。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ: members
型: object

テーマが共有されているユーザーおよびグループ。

リリース19.4.3での導入。
ソースを表示
  • items

    「テーマ・メンバー」要素のコレクション。

    リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • CollectionResource

    REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

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

このテーマを所有するユーザーまたはクライアント・アプリケーション。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : 許可
型: object

テーマのユーザー権限。

リリース22.7.2で導入されました。
ソースを表示
  • annotation

    ユーザーが持つ注釈権限のセット。

    有効な値は次のとおりです。

    • read - 注釈を読む
    • write - 注釈の作成
    • update - 注釈の更新
    • delete - 注釈の削除

    リリース22.7.2で導入されました。
  • conversation

    ユーザーが持つ会話権限のセット。

    有効な値は次のとおりです。

    • read - 会話を読む
    • write - 会話への書込み
    • update - 会話の更新
    • delete - 会話の削除

    リリース22.7.2で導入されました。
  • file

    ユーザーが持つファイル・レベルのアクセス権のセット。

    有効な値は次のとおりです。

    • preview - ファイルのプレビュー
    • read - ファイルの読取り
    • write - ファイルへの書込み
    • update - 更新ファイル
    • delete - ファイルの削除

    リリース22.7.2で導入されました。
  • links
  • members

    ユーザーが持つメンバーの権限セット。

    有効な値は次のとおりです。

    • read - メンバーの読み取りと一覧表示
    • add - メンバーに追加
    • update - メンバーの更新
    • remove - メンバーの削除

    リリース22.7.2で導入されました。
  • self

    ユーザーが持つフォルダ・レベルの権限のセット。

    有効な値は次のとおりです。

    • preview - フォルダのプレビュー
    • read - フォルダの読取り
    • write - フォルダへの書込み
    • update - フォルダの更新
    • delete - フォルダ

    リリース22.7.2で導入されました。
  • shareLink
ネストされたスキーマ : SiteJobStatus
識別子: action

サイト・ジョブのバックグラウンド・ジョブの詳細。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • SiteJobStatus-allOf[1]
ネストされたスキーマ : SiteJobStatus-allOf[1]
型: object
ソースを表示

  • 「サイト・ジョブ・ステータス」のタイプ。 有効な値は次のとおりです: 、translate, copy, publish, importTranslations, hardDelete, copyTheme, copyComponent, refresh, publishTheme。

  • 非同期ジョブが完了したかどうか。

  • プロセスの完了数を取得し、0から100までの数値。 非同期ジョブが開始していない場合、完了率は提供されません。 すべてのバックグラウンド非同期ジョブが詳細なプロセスをサポートしているわけではないため、完了率はステップなしでゼロから100にジャンプできます。

  • レスポンスを元の非同期ジョブに関連付けるために使用できるジョブ・コンテキスト識別子の値。 非同期ジョブがどのように開始されたかによって、コンテキスト値があるかどうか、およびコンテキスト値は何かが決まります。

  • 非同期ジョブの実行が終了した時間、または非同期ジョブが失敗した時間。 非同期ジョブが終了していないか失敗した(または開始していない)場合、このプロパティは存在しません。 特定のバックグラウンド・ジョブは停止時間を記録しないことがあるため、ジョブが完了した場合、停止時間がない可能性があります。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

  • error

    ジョブの失敗時の非同期ジョブ・レスポンスのエラー詳細。 このオプションは、非同期ジョブが実行されたにも失敗した場合にのみ使用可能です。

  • クライアントがステータスを再度チェックするまでに待機する必要がある時間のヒントとして、1ミリ秒数。 この値がない場合、ポーリング間隔は提案されず、クライアントは必要に応じてポーリングできることを意味します。

  • 現在の処理ステータスに関する、人間が読み取り可能なメッセージ。 このメッセージは、エンド・ユーザーに進行状況を通知するために使用されます。 非同期リクエストまたはジョブは、判読可能なステータス・メッセージを提供しない場合があります。

  • 非同期ジョブの現在の進行状況。 これらの値は、非同期ジョブが終了したことを示します: succeeded、failed、aborted。 blockedの値は、非同期ジョブには人による承認の待機など、アクションが必要であることを意味します。 非同期ジョブが処理中であることを示す値は次のとおりです: pending、processing、paused。

    有効な値は次のとおりです。

    • pending - リクエストは実行を待機しています
    • processing - リクエストは実行中です
    • succeeded - リクエストは正常に完了しました
    • failed - リクエストに失敗しました
    処理リクエストが完了する前に失敗しました。
    • aborted - リクエストは中断されました
    処理リクエストが完了する前に中止されました。
    • paused - リクエストは実行中でしたが、現在は一時停止しています
    • blocked - リクエストはブロックされています
    リクエストには、人の承認を待機するなどのアクションが必要です。

  • 非同期ジョブ・リクエストのHTTPステータス・コード。 このステータスは、非同期ジョブ・ステータスの問合せ時に取得するステータスではなく、非同期ジョブが完了したときのステータス・レスポンスです。 この値は非同期ジョブの終了後のみ使用可能です。

  • result

    クライアントがステータスについてサービスをポーリングする際に結果を取得できるよう、ステータス・リソースに最終結果を含めることが望ましい場合もあります。 結果はこのオプション・プロパティで取得されます。 このプロパティは、HTTPレスポンスがステータス・リソース内で効率的に返される場合にのみ使用する必要があります。 このプロパティが存在する場合は、重複を避けるためにrequestStatusプロパティが省略されます。 レスポンスの本文は、レスポンス固有のプロパティで構成されるJSONオブジェクトです。 非JSONレスポンス・データは、Base64が、bodyプロパティ内のバイト文字列として非JSONデータをエンコードするか、ステータス・リソースのリンク・プロパティの非JSONリソースへのリンクを提供することでサポートされます。

  • 非同期ジョブの実行が開始された時間。 非同期ジョブが開始していない場合、このプロパティは表示されません。 特定のバックグラウンド・ジョブは開始時間を記録しないことがあるため、ジョブが開始した場合、開始時間がない可能性があります。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

ネストされたスキーマ : error
型: object

ジョブの失敗時の非同期ジョブ・レスポンスのエラー詳細。 このオプションは、非同期ジョブが実行されたにも失敗した場合にのみ使用可能です。

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

クライアントがステータスについてサービスをポーリングする際に結果を取得できるよう、ステータス・リソースに最終結果を含めることが望ましい場合もあります。 結果はこのオプション・プロパティで取得されます。 このプロパティは、HTTPレスポンスがステータス・リソース内で効率的に返される場合にのみ使用する必要があります。 このプロパティが存在する場合は、重複を避けるためにrequestStatusプロパティが省略されます。 レスポンスの本文は、レスポンス固有のプロパティで構成されるJSONオブジェクトです。 非JSONレスポンス・データは、Base64が、bodyプロパティ内のバイト文字列として非JSONデータをエンコードするか、ステータス・リソースのリンク・プロパティの非JSONリソースへのリンクを提供することでサポートされます。

すべてに一致
ソースを表示
  • HttpResponse

    非同期リクエストのHTTPレスポンスの取得など、構造化データとして返すことができるようにHTTPレスポンスを取得します。

ネストされたスキーマ : HttpResponse
型: object

非同期リクエストのHTTPレスポンスの取得など、構造化データとして返すことができるようにHTTPレスポンスを取得します。

ソースを表示
ネストされたスキーマ: headers
型: array

HTTPレスポンス・ヘッダー。

ソースを表示
ネストされたスキーマ: status
型: object

HTTPステータス・コードのレスポンス値および理由。

ソースを表示

  • 例外に対応するHTTPステータス・コード。 リソースを含む例外には404のHTTPステータスが存在します。

  • 短い、判読可能なステータス・コードのサマリーです。

ネストされたスキーマ: items
型: object
ソースを表示
ネストされたスキーマ: items
型: array

「テーマ・メンバー」要素のコレクション。

リリース19.4.1.での導入。
ソースを表示
ネストされたスキーマ: items
型: object
ソースを表示

  • ユーザー、クライアント・アプリケーションまたはグループの表示名。

    リリース19.4.1.での導入。
  • グループ

    メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

    リリース19.4.1.での導入。

  • メンバーがグループの場合、グループのタイプが指定されます。 メンバーがユーザーの場合、このフィールドは存在しません。

    有効な値は次のとおりです。

    • oce - コンテンツ管理グループ
    • idp - アイデンティティ・プロバイダ・グループ

    リリース20.1.1で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。

    フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。

    リリース19.4.1.での導入。

  • 関連するユーザーまたはクライアント・アプリケーションに外部ユーザー・ロールのみがある場合、trueに設定されます。

    リリース21.10.2で導入されました。

  • ユーザー、クライアント・アプリケーションまたはグループの一意の名前。 メンバーがユーザーの場合、名前はユーザー名です。 メンバーがグループの場合、名前はグループ名です。

    リリース19.4.1.での導入。

  • ユーザー、クライアント・アプリケーションまたはグループが与えられた共有ロール。

    有効な値は次のとおりです。

    • owner - ユーザーが所有者です。
    • manager - ユーザーにマネージャ・ロールがあります
    • contributor - ユーザーにコントリビュータ・ロールがあります
    • downloader - ユーザーにはダウンロード実行者ロールがあります
    • viewer - ユーザーの参照者のロール

    リリース19.4.1.での導入。

  • メンバーがユーザー、クライアント・アプリケーションまたはグループであることを示します。

    有効な値は次のとおりです。

    • user - メンバーはユーザーまたはクライアント・アプリケーションです。 ユーザーまたはメンバー間で区別されません
    クライアント・アプリケーションであるメンバー。
    • group - メンバーはグループです

    リリース19.4.1.での導入。
  • user

    メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

    リリース19.4.1.での導入。
ネストされたスキーマ : グループ

メンバーのグループ詳細。 メンバーのタイプが「グループ」の場合にのみ使用できます。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • Group

    グループとは、ユーザーおよびグループの集合です。 グループには、ユーザーが読取り可能なグループ名があります。

    リリース19.3.1.での導入。
ネストされたスキーマ: user

メンバーのユーザーまたはクライアント・アプリケーションの詳細。 メンバーのタイプがuserの場合にのみ使用できます。 メンバーは、ユーザー、クライアント・アプリケーションまたはグループにすることができます。 ユーザーとクライアント・アプリケーションの両方の詳細を読むことができます。

リリース19.4.1.での導入。
すべてに一致
ソースを表示
  • 「アイデンティティ」
    識別子: type

    ユーザーまたはクライアント・アプリケーションを表すアイデンティティ。 アイデンティティには、アイデンティティ識別子、一意の名前、表示名などの共通情報が含まれます。

    リリース20.3.1で導入されました。
ネストされたスキーマ : 注釈
型: array

ユーザーが持つ注釈権限のセット。

有効な値は次のとおりです。

  • read - 注釈を読む
  • write - 注釈の作成
  • update - 注釈の更新
  • delete - 注釈の削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ : 会話
型: array

ユーザーが持つ会話権限のセット。

有効な値は次のとおりです。

  • read - 会話を読む
  • write - 会話への書込み
  • update - 会話の更新
  • delete - 会話の削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ : file
型: array

ユーザーが持つファイル・レベルのアクセス権のセット。

有効な値は次のとおりです。

  • preview - ファイルのプレビュー
  • read - ファイルの読取り
  • write - ファイルへの書込み
  • update - 更新ファイル
  • delete - ファイルの削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ: members
型: array

ユーザーが持つメンバーの権限セット。

有効な値は次のとおりです。

  • read - メンバーの読み取りと一覧表示
  • add - メンバーに追加
  • update - メンバーの更新
  • remove - メンバーの削除

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ: self
型: array

ユーザーが持つフォルダ・レベルの権限のセット。

有効な値は次のとおりです。

  • preview - フォルダのプレビュー
  • read - フォルダの読取り
  • write - フォルダへの書込み
  • update - フォルダの更新
  • delete - フォルダ

リリース22.7.2で導入されました。
ソースを表示
ネストされたスキーマ : イメージ

サイトおよびサイト・テンプレートのサムネイルまたはプレビュー・イメージの詳細。

すべてに一致
ソースを表示
  • SingularResource

    すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

  • Image-allOf[1]
ネストされたスキーマ : Image-allOf[1]
型: object
ソースを表示

  • イメージ・タイプ。

    有効な値は次のとおりです。

    • thumbnail - サイトまたはテンプレートのサムネイル表示
    • preview - サイトまたはテンプレートの外観のプレビュー・イメージ

  • このイメージのURL。

レスポンスの例 ()
{
    "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6",
    "name":"CafeSupremo",
    "themeName":"value",
    "author":"value",
    "longDescription":"value",
    "defaultLanguage":"en-US",
    "isDeleted":false,
    "granularSecurity":{
        "enabled":false
    },
    "createdAt":"2019-06-01T06:44:17.000Z",
    "isEnterprise":false,
    "description":"A folder for my assets.",
    "lastModifiedAt":"2019-06-01T06:44:17.000Z",
    "thumbnail":{
        "url":"http://cloud.example.com/images/site.png",
        "imageType":"thumbnail"
    }
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

見つかりません
ヘッダー
本文()
ルート・スキーマ: schema
すべてに一致
ソースを表示
ネストされたスキーマ : TemplateJobNotFoundExceptionDetail
リリース19.4.1.での導入。
すべてに一致
ソースを表示
ネストされたスキーマ : ExceptionDetail
型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

  • この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。

  • エラーに関する詳細を提供するリンクへのURI。

  • アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。

  • o:errorDetails

    階層構造に複数のエラーがある場合もあります。

  • エラーが発生した場所を示すXPathまたはJSONパス。

  • エラーに対応するHTTPステータス・コード。

  • 問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。

  • 問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

ネストされたスキーマ : TemplateJobNotFoundExceptionDetail-allOf[1]
型: object
ソースを表示

  • 存在しないか、認証されたユーザーに表示されないテンプレート・ジョブ・ステータス。

    リリース19.4.1.での導入。
ネストされたスキーマ: o:errorDetails
型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示
ネストされたスキーマ: items
すべてに一致
ソースを表示
  • ExceptionDetail

    HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

レスポンスの例(テンプレート・ジョブが見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Job Not Found",
    "status":"404",
    "detail":"Job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.",
    "o:errorCode":"OCE-SITEMGMT-009051",
    "jobStatus":{
        "context":"37D1070720325969AC6C47ACE8B9BFF91533560416423"
    }
}
レスポンスの例 (関係が見つかりません)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Relationship Not Found",
    "status":"404",
    "detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
    "o:errorCode":"PAAS-005027"
}

406レスポンス

受入れられない

416 レスポンス

範囲を満たすことはできません

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト
先頭に戻る