機械翻訳について

移動先

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

サイトのフィールドの更新

patch

/sites/management/api/v1/sites/{id}

SINGULAR

サイト名や説明など、サイトのフィールドを更新します。 サイト名を更新することにより、サイト名を変更できます。 サイト・セキュリティを更新することもできます。 サイト管理者は、サイトの有効期限を更新できます。 ただし、サイトのアーティファクトはこの操作を使用して変更されません。サイトのルック・アンド・フィールを変更するには、サイト・ビルダーを使用します。

リリース19.4.1.での導入。

認可

サイトの有効期限を設定、更新または消去できるのは、「サイト管理者」のみです。 認証されたユーザーがサイトの所有者、マネージャまたはコントリビュータ共有ロールを持っている場合でも、この操作を使用してサイトの有効期限を更新することはできません。 同様に、名前を変更できるのは、サイトのmanagersおよびownersのみです。 サイトの有効期限および名前以外のフィールドを編集するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの共有ロールを持っている必要があります:

• 所有者
• マネージャ
• 貢献者

サイトの有効期限の延長

サイトの所有者またはマネージャは、有効期限日を明示的に設定できませんが、拡張操作を使用してサイトの有効期限を延長できます。

詳細は、「サイトの有効期限の延長」を参照してください。

オンライン・サイトにアクセスできるユーザーの指定

サイト所有者またはマネージャは、namedを含むサイト上でセキュリティ・アクセス・レベルを設定してから、サインイン後にサイトにアクセスできるユーザー、アプリケーションまたはグループを指定できます。

詳細は、「サイトへのアクセス権の付与」を参照してください。

パス代替識別子

「サイト」リソースのデフォルトの識別子は、「サイト識別子」です。 サイト・リソースは代替識別子をサポートしています。

nameサイト名

サイト識別子のかわりに、サイト名を使用してリソース・パスのサイトを一意に識別できます。 サイトのデフォルトのリソース・パス・パラメータはサイト識別子ですが、サイトでの作業時には判読可能なサイト名が簡単になる場合があります。

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct

リリース19.4.1.での導入。

成功したレスポンスの例

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

200OK - Rename a Site

サイトの名前を変更します。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/sites/{id}

リクエスト本文

{
  "name": "My-New-Product."
}

200 OK - サイトの説明の更新

サイトの説明を更新します。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/sites/{id}

リクエスト本文

{
  "description": "A new description for my site."
}

200 OK - サイト・アクセスの更新

サイト所有者またはマネージャは、ランタイム・サイトにアクセスできるユーザーを指定できます。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/sites/{id}

リクエスト本文

{
  "security": {
    "access": [
        "cloud",
        "visitors",
        "service"
    ]
  }
}

200 OK - サイト・セキュリティ・ポリシーの更新

サイト管理者でもあるサイトの所有者またはマネージャは、サイトに適用されるセキュリティ・ポリシーを更新できます。 ポリシーを更新する場合は、サイトの新しいアクセス・レベルも指定する必要があります。 サイト・アクセスはセキュリティ・ポリシーで許可される必要があります。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/sites/{id}

リクエスト本文

{
  "security": {
    "policy": {
      "level": "service",
      "appliesTo": "all"
    },
    "access": [
        "service"
    ]
  }
}

200 OK - サイト有効期限の更新

サイトの有効期限を更新します。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/sites/{id}

リクエスト本文

{
  "expiresAt": "2025-01-01T00:00:00.000Z"
}

200 OK - サイト失効日の消去

サイトの有効期限をクリアします。

リクエスト

PATCH https://api.example.com/sites/management/api/v1/sites/{id}

リクエスト本文

{
  "expiresAt": null
}

200 OK - 外部ユーザーの無効化

外部ユーザーをサイト・ロールから許可しない

リクエスト

PATCH https://api.example.com/sites/management/api/v1/sites/{id}

リクエスト本文

{
  "userSecurity": {
    "externalUserEnabled": false
  }
}

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

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

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

400Bad Request - Invalid Security Scope

サイト・セキュリティ・スコープnamedは、everyoneのセキュリティ・レベルでは使用できません。 everyoneのセキュリティ・レベルを使用する場合は、allのサイト・セキュリティ・スコープを使用する必要があります。

エラー・コード

OCE-SITEMGMT-009018

解決 - サイト・セキュリティ・スコープの編集

セキュリティ・スコープを推奨される必須スコープ値に変更します。

例外詳細フィールド

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

フィールド名	説明
level	指定されたサイト・セキュリティ・レベル。 有効な値は次のとおりです。 service - サービス・ユーザーのみ cloud - ドメインにサインインできるクラウド・ユーザーのみ everyone - サインインせずに誰でも
specifiedScope	指定したサイト・セキュリティ範囲。 有効な値は次のとおりです。 named - 指定されたレベル内の指定ユーザーのみがアクセスできます all - 指定されたレベル内のすべてのユーザーがアクセスできます
requiredScope	必須のサイト・セキュリティ・スコープです。 有効な値は次のとおりです。 named - 指定されたレベル内の指定ユーザーのみがアクセスできます all - 指定されたレベル内のすべてのユーザーがアクセスできます

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Security Scope",
  "status": "400",
  "detail": "Site security scope '{specifiedScope}' is not valid with a site security level of '{level}'. Use a security scope of '{requiredScope}'.",
  "o:errorCode": "OCE-SITEMGMT-009018",
  "level": "service",
  "specifiedScope": "named",
  "requiredScope": "all"
}

400Bad Request - Invalid Site Security Access

サイトのセキュリティ・ポリシーは、指定されたセキュリティ・アクセス・レベルを持つことができないことを意味します。 セキュリティ・ポリシーでは、サイトに許可される最小限のセキュリティ・レベルを指定します。 たとえば、セキュリティ・ポリシー内のサイトのセキュリティ・レベルがサービス・ユーザーを指定している場合、セキュリティ・アクセスはすべてのクラウド・ユーザーになることはできません。 サイトのセキュリティ・アクセス・レベルが許可されていない場合、サイトを公開したりサイト・アクセス・メンバーを更新することはできません。

エラー・コード

OCE-SITEMGMT-009019

解決 - セキュリティ・アクセスの変更

サイトのセキュリティ・ポリシーに準拠するようにサイトのセキュリティ・アクセス・レベルを変更し、操作を再試行してください。 サイト・ガバナンスが有効になっている場合、サイトが作成されたサイト・テンプレートのセキュリティ・ポリシーによって最初に定義されている、サイトごとのセキュリティ・ポリシーを指定できます。 サイト・ガバナンスが有効になる前に作成されたサイトには、サイトのセキュリティ・ポリシーがないため、テナント・サービス・レベル・ポリシーにフォールバックします。 このエラーが発生した場合は、そのサイトで直接セキュリティ・ポリシーを「パブリック」に設定できます。

例外詳細フィールド

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

フィールド名	説明
site	操作が実行されているサイト。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Security Access",
  "status": "400",
  "detail": "Site security access levels are not allowed by the security policy.",
  "o:errorCode": "OCE-SITEMGMT-009019",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

400Bad Request - Mandatory Site Field

サイトのフィールドが消去中であり、そのフィールドがサイトで必須であり、nullに設定できないことを示します。

エラー・コード

OCE-SITEMGMT-009070

解決 - サイト・セキュリティをクリアしない

securityフィールドのクリアは試行しないでください。 フィールドは異なる値にのみ変更できます。

例外詳細フィールド

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

フィールド名	説明
site	フィールドが必須のサイト。
fieldName	クリアされるフィールド名。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Mandatory Site Field",
  "status": "400",
  "detail": "Field '{fieldName}' should not be set to 'null'.",
  "o:errorCode": "OCE-SITEMGMT-009070",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "fieldName": "security"
}

リリース19.4.1.での導入。

400Bad Request - Invalid Site Name

指定されたサイト名に使用できません。使用できる文字または語が含まれています。 サイト名が無効な理由がエラー・メッセージにレポートされます。

エラー・コード

OCE-SITEMGMT-009012

解決 - スペースの削除

サイト名を変更して、空白が含まれないようにしてください。

解決 - チェック文字

サイト名に使用できるのは、文字、数字、ハイフンおよびアンダースコアのみです。

例外詳細フィールド

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

フィールド名	説明
siteName	無効なサイト名です。
reason	サイト名が無効な理由。 有効な値は次のとおりです。 tooLong - 名前が長すぎます。 invalidCharacters - 名前に無効な文字が含まれています startWithSpace - 名前が空白で始まります endWithSpace - 名前が空白で終わる internalWord - 名前が制限付きの内部語である empty - 名前が空です

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Name",
  "status": "400",
  "detail": "Site name '{siteName}' cannot be used to create a site.",
  "o:errorCode": "OCE-SITEMGMT-009012",
  "siteName": "MyNewProduct",
  "reason": "tooLong"
}

403Forbidden - Site Operation Forbidden

サイト内で共有ロールを持つユーザーは、この操作を実行できません。

エラー・コード

OCE-SITEMGMT-009026

解決 - 共有ロールの変更

認証ユーザーに付与された共有ロールを必要なロール以上に変更します。

解決 - アプリケーション・ロールの変更

ユーザーにStandardユーザーまたはエンタープライズ・ユーザー・アプリケーション・ロールがあることを確認します。

例外詳細フィールド

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

フィールド名	説明
site	操作が実行されているサイト。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Operation Forbidden",
  "status": "403",
  "detail": "You do have a sharing role in this site, but your role does not allow you to use this operation.",
  "o:errorCode": "OCE-SITEMGMT-009026",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

リリース19.1.5.での導入。

403Forbidden - Storage Limit Reached

ストレージ転送制限に達しました。 請求限度は、システム管理者が使用可能なストレージ容量に設定されています。

エラー・コード

OCE-SITEMGMT-009098

解決 - ストレージ制限の増加

ストレージ制限を増やすシステム管理者を取得します。

例外詳細フィールド

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

フィールド名	説明
used	使用済ストレージ(GB)。
limit	ストレージ制限(GB)。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Storage Limit Reached",
  "status": "403",
  "detail": "Storage limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009098",
  "used": 1.23456789,
  "limit": 1.23456789
}

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

403禁止 - サイト・コレクション操作禁止

サイト・コレクション内の共有ロールでは、操作を実行できません。

エラー・コード

OCE-SITEMGMT-009153

解決 - 共有ロールの変更

認証ユーザーに付与された共有ロールを必要なロール以上に変更します。

例外詳細フィールド

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

フィールド名	説明
site	サイト・コレクションの親サイト。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Collection Operation Forbidden",
  "status": "403",
  "detail": "User, or client application, has insufficient privileges on the site collection.",
  "o:errorCode": "OCE-SITEMGMT-009153",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

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

404Not Found - Site Not Found

サイトが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションがサイトへのアクセス権を持っていません。

エラー・コード

OCE-SITEMGMT-009003

解決 - 識別子のチェック

サイト識別子が有効であることを確認してください。

解決 - メンバーシップのチェック

認証済ユーザーがサイトのメンバーまたはサイト管理者であることを確認します。

例外詳細フィールド

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

フィールド名	説明
site	存在しないか、認証されたユーザーが参照できないサイトです。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Not Found",
  "status": "404",
  "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
  "o:errorCode": "OCE-SITEMGMT-009003",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

409Conflict - Site Already Exists

同じ名前のサイトがすでに存在します。 サイト名はすべてのサイトで一意である必要があります。

エラー・コード

OCE-SITEMGMT-009004

解決 - サイト名の編集

既存のサイトと競合しないように、リクエストのサイト名を編集します。

例外詳細フィールド

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

フィールド名	説明
name	重複している名前です

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Already Exists",
  "status": "409",
  "detail": "A site with the same name already exists.",
  "o:errorCode": "OCE-SITEMGMT-009004",
  "name": "Oracle Content and Experience"
}

409Conflict - Invalid Site Publish Status

サイトが間違った公開状態にあるため、サイト操作を実行できません。 例として、未公開のサイトをオンラインにするか、公開済サイトの名前を変更しようとしています。

エラー・コード

OCE-SITEMGMT-009031

解決 - セキュリティ・レベル更新前のサイトの公開解除

サイトが公開されている間は、サイト・セキュリティ・レベルをパブリックからセキュア・サイトに変更したり、またはその逆に変更することはできません。 サイトにサインインが必要かどうかを変更するために、サイトをオフラインおよび非公開にする必要があるかどうか。

解決 - 名前変更前のサイトの公開取消

サイトの名前を変更するには、オフラインで未公開である必要があります。

例外詳細フィールド

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

フィールド名	説明
site	操作が実行されているサイト。
publishStatus	サイト公開ステータス。 有効な値は次のとおりです。 unpublished - サイトは公開されていません。 ランタイム・サイト環境に公開されたファイルがありません draft - サイトに下書き更新があります。 公開されたファイルがランタイム・サイト環境に存在しますが、ベース・サイトに新しい未承認の更新があります approved - サイトには更新が承認されました。 公開されたファイルはランタイム・サイト環境に存在しますが、ベース・サイトには新しい承認済の更新があります published - サイトは公開されています。 公開されたファイルは、ランタイム・サイト環境に存在
requiredStatus	必須のサイト・パブリッシュ・ステータス。 有効な値は次のとおりです。 unpublished - サイトは公開されていません。 ランタイム・サイト環境に公開されたファイルがありません draft - サイトに下書き更新があります。 公開されたファイルがランタイム・サイト環境に存在しますが、ベース・サイトに新しい未承認の更新があります approved - サイトには更新が承認されました。 公開されたファイルはランタイム・サイト環境に存在しますが、ベース・サイトには新しい承認済の更新があります published - サイトは公開されています。 公開されたファイルは、ランタイム・サイト環境に存在

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Publish Status",
  "status": "409",
  "detail": "Operation cannot be performed on a site with publish status '{publishStatus}'.",
  "o:errorCode": "OCE-SITEMGMT-009031",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "publishStatus": "unpublished",
  "requiredStatus": [
      "unpublished"
  ]
}

409Conflict - Invalid Site Status

サイトが間違った状態にあるため、サイト操作を実行できません。 すでにオンラインになっているサイトをオンラインにしたり、オンラインサイトの名前を変更したりする例。

エラー・コード

OCE-SITEMGMT-009013

解決 - セキュリティ・レベルを更新する前にサイトをオフラインにします

サイトがオンラインである間は、サイトのセキュリティ・レベルをパブリックからセキュア・サイトに変更したり、またはその逆に変更したりすることはできません。 サイトにサインインが必要かどうかを変更するために、サイトをオフラインおよび非公開にする必要があるかどうか。

解決 - 名前変更前にサイトをオフラインにします

サイトの名前を変更するには、オフラインで未公開である必要があります。

例外詳細フィールド

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

フィールド名	説明
site	操作が実行されているサイト。
runtimeStatus	サイト 有効な値は次のとおりです。 offline - サイトはオフラインです。 サイトがアクティブ化されていないか、アクティブ化されて非アクティブ化されています online - サイトはオンラインです。 サイトがアクティブ化されました
requiredStatus	必須サイト・ステータスです。 有効な値は次のとおりです。 offline - サイトはオフラインです。 サイトがアクティブ化されていないか、アクティブ化されて非アクティブ化されています online - サイトはオンラインです。 サイトがアクティブ化されました

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Status",
  "status": "409",
  "detail": "Operation cannot be performed on a site with status '{runtimeStatus}'.",
  "o:errorCode": "OCE-SITEMGMT-009013",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "runtimeStatus": "offline",
  "requiredStatus": "offline"
}

409Conflict - Site Deleted

ソフト削除されたサイトでは操作を実行できません。 このエラーは、includeDeleted問合せパラメータがtrueに設定されている場合にのみ発生します。

エラー・コード

OCE-SITEMGMT-009059

解決 - サイトのリストア

サイトをリストアしてから操作を再試行してください。

例外詳細フィールド

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

フィールド名	説明
site	サイト識別子が指定されている場合、ソフト削除されるサイト。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Deleted",
  "status": "409",
  "detail": "The operation cannot be performed as the site has been soft deleted.",
  "o:errorCode": "OCE-SITEMGMT-009059",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

リリース19.4.1.での導入。

409競合 - サイト・コレクションはすでに存在

同じ名前のコレクションがすでに存在します。 サイト・コレクション名はすべてのコレクションで一意である必要があります。

エラー・コード

OCE-SITEMGMT-009154

解決 - サイト名の編集

既存のコレクションと衝突しないように、リクエストのサイト名を編集します。

例外詳細フィールド

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

フィールド名	説明
name	コレクション名が重複しています。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Collection Already Exists",
  "status": "409",
  "detail": "A collection with the same name already exists.",
  "o:errorCode": "OCE-SITEMGMT-009154",
  "name": "Oracle Content and Experience"
}

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

409競合 - サイト・チャネルはすでに存在

同じ名前のチャネルがすでに存在します。 チャネル名はすべてのサイトで一意である必要があります。

エラー・コード

OCE-SITEMGMT-009155

解決 - サイト名の編集

既存のチャネルと衝突しないように、リクエストのサイト名を編集します。

例外詳細フィールド

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

フィールド名	説明
channelName	チャネル名

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Channel Already Exists",
  "status": "409",
  "detail": "A channel with the same name already exists.",
  "o:errorCode": "OCE-SITEMGMT-009155",
  "channelName": "Oracle Content and Experience"
}

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

409競合 - サイト・コンテンツ・セキュリティ・グループはすでに存在

指定された名前のSSTグループがすでに存在するため、サイト操作を実行できません。 グループ名は親サイト名に基づきます。

エラー・コード

OCE-SITEMGMT-009158

解決 - サイト名の編集

既存のコンテンツ・セキュリティ・グループと衝突しないように、リクエストのサイト名を編集します。

例外詳細フィールド

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

フィールド名	説明
groupName	既存のグループ名。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Content Security Group Already Exists",
  "status": "409",
  "detail": "Site rename cannot be performed as there is an existing content security group with the same name.",
  "o:errorCode": "OCE-SITEMGMT-009158",
  "groupName": "Oracle Content and Experience"
}

409競合 - サイト・コンテンツ・セキュリティ・タクソノミ下書きが存在

コンテンツ・セキュリティ・タクソノミである既存の下書きがあるため、サイト操作(名前変更、更新、削除)を実行できません。

エラー・コード

OCE-SITEMGMT-009152

解決 - タクソノミ下書きの削除

サイト操作を実行できるように、タクソノミ・ドラフトを削除します。

例外詳細フィールド

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

フィールド名	説明
site	コンテンツ・セキュリティ・タクソノミ・ドラフトがあるサイト。
securityTaxonomyId	コンテンツ・セキュリティ・タクソノミID。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Content Security Taxonomy Draft Exists",
  "status": "409",
  "detail": "Site operation cannot be performed as it has an existing content security taxonomy draft.",
  "o:errorCode": "OCE-SITEMGMT-009152",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "securityTaxonomyId": "value"
}

リクエスト

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

• application/merge-patch+json

パス・パラメータ

• id: string

  サイトの不変の識別子。

問合せパラメータ

• includeDeleted(optional): boolean

  削除対象としてマークされているリソースでは、この問合せパラメータがtrueに設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。 includeDeleted問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。

本文()

更新対象のプロパティのみをリクエストに指定してください。 プロパティを削除するには、値をnullに指定してリクエストに含めます。 更新できないプロパティは無視されます。

ルート・スキーマ: schema

型: object

ソースを表示

• description(optional): string
  最大長: 1000

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

• expiresAt(optional): string(date-time)

  サイトに有効期限が設定されている場合、サイトの有効期限。 有効期限が切れたサイトはアクティブ化できません。

  リリース19.4.1.での導入。
• isIframeEmbeddingAllowed(optional): boolean

  このサイトをiFrameに埋め込むことができるかどうか。

• links(optional): array links

  このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

• name(optional): string
  最大長: 242

  サイトの読みやすい名前。

• security(optional): security

  サイト・セキュリティ設定。

• sitePageOptions(optional): object sitePageOptions

  サイト・ページのオプション。

  リリース23.2.1で導入されました。
• staticSiteDeliveryOptions(optional): object staticSiteDeliveryOptions

  静的サイト・オプション。

  リリース20.3.3で導入されました。
• userSecurity(optional): object userSecurity

  OCEユーザー・タイプに関連するサイト・セキュリティ設定。

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

{
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "name":{
            "description":"<p>Human readable name for the site. </p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":242
        },
        "description":{
            "description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "security":{
            "description":"<p>Site security settings.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteSecurity"
                }
            ]
        },
        "userSecurity":{
            "description":"<p>Site security settings relating to OCE user types.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "externalUserEnabled":{
                    "description":"<p>Indicates whether a site should allow external users. If true, the site will allow some (limited) privileges for external users, including (non-managing) member roles to be given to the such users.</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                }
            }
        },
        "isIframeEmbeddingAllowed":{
            "description":"<p>Whether this site can be embedded in an iFrame.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "expiresAt":{
            "description":"<p>Expiration date for the site, if the site has been given an expiration date. An expired site cannot be activated.</p><small>Introduced in release 19.4.1.</small>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "staticSiteDeliveryOptions":{
            "description":"<p>Static site options.</p><small>Introduced in release 20.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "compileSite":{
                    "description":"<p>Compile Site. Should the site be compiled for static site delivery.</p><small>Introduced in release 20.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "cachingResponseHeaders":{
                    "description":"<p>Caching response headers. Additional headers which are added to a site's page to override the default caching headers. By default compiled sites are cached on a user's browser for 300 seconds (5 minutes). This can be overriden by entering a valid <code>Cache-control</code> header. If Akamai is used an <code>Edge-Control</code> header can be used to override the Akamai caching configuration. </p><small>Introduced in release 20.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":2000
                },
                "mobileUserAgents":{
                    "description":"<p>Mobile user agents. Comma separated list of user-agent substrings to specify the user agents to generate mobile pages for. When compiling a site, mobile pages can be created to support adaptive layouts. If any part of the substring matches the browser's user-agent string, then the mobile pages are served. </p><small>Introduced in release 20.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":2000
                }
            }
        },
        "sitePageOptions":{
            "description":"<p>Site page options.</p><small>Introduced in release 23.2.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "urlValidationDisabled":{
                    "description":"<p>Disable the page url validation check that occurs when delivering a site page.</p><small>Introduced in release 23.2.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "ssrEnabled":{
                    "description":"<p>Enable server side rendering (SSR) when delivering a site page.</p><small><span style=\"color: red;\">&#42; </span>New in release 23.12.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                }
            }
        }
    },
    "example":{
        "name":"My-New-Product."
    }
}

例:

{
    "name":"My-New-Product."
}

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

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

サイト・セキュリティ設定。

すべてに一致

ソースを表示

• object SiteSecurity

  サイトおよびセキュリティ・ポリシーのセキュリティ・レベルを定義します。 アクセス・レベルを、ポリシーに必要な最小レベルより低いレベルに設定することはできません。 「サイト管理者」のみがサイトのセキュリティ・ポリシーを変更できます。

{
    "description":"<p>Site security settings.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteSecurity"
        }
    ]
}

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

型: object

サイト・ページのオプション。

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

ソースを表示

• ssrEnabled(optional): boolean

  サイト・ページの配信時にサーバー側レンダリング(SSR)を有効にします。

  *リリース23.12.1の新機能。
• urlValidationDisabled(optional): boolean

  サイト・ページの配信時に発生するページURL検証チェックを無効にします。

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

{
    "description":"<p>Site page options.</p><small>Introduced in release 23.2.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "urlValidationDisabled":{
            "description":"<p>Disable the page url validation check that occurs when delivering a site page.</p><small>Introduced in release 23.2.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "ssrEnabled":{
            "description":"<p>Enable server side rendering (SSR) when delivering a site page.</p><small><span style=\"color: red;\">&#42; </span>New in release 23.12.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

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

型: object

静的サイト・オプション。

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

ソースを表示

• cachingResponseHeaders(optional): string
  最大長: 2000

  レスポンス・ヘッダーをキャッシュしています。 デフォルトのキャッシュ・ヘッダーをオーバーライドするためにサイト・ページに追加されるヘッダー。 デフォルトでは、コンパイル済サイトはユーザー・ブラウザに300秒(5分)キャッシュされます。 これは、有効なCache-controlヘッダーを入力して上書きできます。 Akamaiが使用されている場合、Edge-Controlヘッダーを使用してAkamaiキャッシュ構成をオーバーライドできます。

  リリース20.3.3で導入されました。
• compileSite(optional): boolean

  サイトをコンパイルします。 サイトを静的サイト配信用にコンパイルする必要があります。

  リリース20.3.3で導入されました。
• mobileUserAgents(optional): string
  最大長: 2000

  モバイル・ユーザー・エージェント。 モバイル・ページを生成するユーザー・エージェントを指定するユーザー・エージェント部分文字列のカンマ区切りリスト。 サイトをコンパイルする際、モバイル・ページを作成してアダプティブ・レイアウトをサポートできます。 部分文字列の一部がブラウザのユーザー・エージェント文字列と一致した場合、モバイル・ページが提供されます。

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

{
    "description":"<p>Static site options.</p><small>Introduced in release 20.3.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "compileSite":{
            "description":"<p>Compile Site. Should the site be compiled for static site delivery.</p><small>Introduced in release 20.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "cachingResponseHeaders":{
            "description":"<p>Caching response headers. Additional headers which are added to a site's page to override the default caching headers. By default compiled sites are cached on a user's browser for 300 seconds (5 minutes). This can be overriden by entering a valid <code>Cache-control</code> header. If Akamai is used an <code>Edge-Control</code> header can be used to override the Akamai caching configuration. </p><small>Introduced in release 20.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":2000
        },
        "mobileUserAgents":{
            "description":"<p>Mobile user agents. Comma separated list of user-agent substrings to specify the user agents to generate mobile pages for. When compiling a site, mobile pages can be created to support adaptive layouts. If any part of the substring matches the browser's user-agent string, then the mobile pages are served. </p><small>Introduced in release 20.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":2000
        }
    }
}

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

型: object

OCEユーザー・タイプに関連するサイト・セキュリティ設定。

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

ソースを表示

• externalUserEnabled(optional): boolean

  サイトで外部ユーザーを許可するかどうかを示します。 trueの場合、サイトでは、外部ユーザーに対する一部の(制限された)権限(管理されていない)メンバー・ロールをそのようなユーザーに付与できます。

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

{
    "description":"<p>Site security settings relating to OCE user types.</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "externalUserEnabled":{
            "description":"<p>Indicates whether a site should allow external users. If true, the site will allow some (limited) privileges for external users, including (non-managing) member roles to be given to the such users.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

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

すべてに一致

ソースを表示

• object 「リンク」

  REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

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

型: object

REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

ソースを表示

• href(optional): string

  ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。 値がURIテンプレートに設定されている場合、templatedプロパティをtrueに設定する必要があります。

• mediaType(optional): string

  メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。

• method(optional): string

  リンクのターゲットをリクエストするためのHTTPメソッド。

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

  • OPTIONS - HTTP OPTIONS
  • HEAD - HTTP HEAD
  • GET - HTTP GET
  • POST - HTTP POST
  • PUT - HTTP PUT
  • PATCH - HTTP PATCH
  • DELETE - HTTP DELETE

• profile(optional): string(uri)

  ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。

• rel(optional): string

  リンクの詳細を取得するために使用できるリンク・リレーションの名前。

• templated(optional): boolean

  hrefプロパティを指定するブール・フラグは、URIまたはURIテンプレートです。 プロパティが存在しない場合、falseとみなすことができます。

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

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

型: object

サイトおよびセキュリティ・ポリシーのセキュリティ・レベルを定義します。 アクセス・レベルを、ポリシーに必要な最小レベルより低いレベルに設定することはできません。 「サイト管理者」のみがサイトのセキュリティ・ポリシーを変更できます。

ソースを表示

• access(optional): array access

  サイトが保護されているアクセス・レベルのセット。 ポリシーの制限に従い、サイトのマネージャが変更できます。 パブリック・サイトには、everyoneの値のみが含まれます。

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

  • named - 選択した名前付きユーザー
  • service - すべてのサービス・ユーザー
  • visitors - すべてのサービス・ビジター
  • cloud - ドメインにサインインするすべてのクラウド・ユーザー
  • everyone - サインインせずに誰でも

• policy(optional): policy

  サイト管理者によって設定された、サイトで必要なセキュリティの最小レベル。 サイトのアクセス・レベルを必要最小限のレベル以下に設定できません。 サイトのマネージャは、制限されたアクセスがあればそれ以上適用できます。

{
    "description":"<p>Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only <strong>site administrators</strong> can change the security policy of a site.</p>",
    "properties":{
        "policy":{
            "description":"<p>The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SecurityPolicy"
                }
            ]
        },
        "access":{
            "description":"<p>The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.</p><p>Valid values are:\n<ul><li> <code>named</code> - Selected named users</li><li> <code>service</code> - All service users</li><li> <code>visitors</code> - All service visitors</li><li> <code>cloud</code> - All cloud users who sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

サイトが保護されているアクセス・レベルのセット。 ポリシーの制限に従い、サイトのマネージャが変更できます。 パブリック・サイトには、everyoneの値のみが含まれます。

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

• named - 選択した名前付きユーザー
• service - すべてのサービス・ユーザー
• visitors - すべてのサービス・ビジター
• cloud - ドメインにサインインするすべてのクラウド・ユーザー
• everyone - サインインせずに誰でも

ソースを表示

• Array of: string

{
    "description":"<p>The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.</p><p>Valid values are:\n<ul><li> <code>named</code> - Selected named users</li><li> <code>service</code> - All service users</li><li> <code>visitors</code> - All service visitors</li><li> <code>cloud</code> - All cloud users who sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: policy

サイト管理者によって設定された、サイトで必要なセキュリティの最小レベル。 サイトのアクセス・レベルを必要最小限のレベル以下に設定できません。 サイトのマネージャは、制限されたアクセスがあればそれ以上適用できます。

すべてに一致

ソースを表示

• object SecurityPolicy

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

{
    "description":"<p>The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SecurityPolicy"
        }
    ]
}

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

型: object

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

ソースを表示

• appliesTo(optional): string

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

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

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

• level(optional): string

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

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

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

{
    "description":"<p>The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.</p>",
    "properties":{
        "level":{
            "description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "appliesTo":{
            "description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

トップに戻る

レスポンス

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

• application/json
• application/vnd.oracle.resource+json;type=singular

200レスポンス

OK

ヘッダー

• Cache-Control: string

  キャッシュ・メカニズムのディレクティブ。

• Content-Length: string

  レスポンス本文のサイズ。

• Content-Type: string

  レスポンスのコンテンツ・タイプ。

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf Site

  サイトには、リクエストしたユーザーやサイトを承認したユーザー、物理サイトに関する詳細など、サイト・フォルダに対する元のリクエストに関する情報が含まれます。 承認プロセスを使用してリクエストを介して作成されたすべてのサイトには、そのサイトの作成に使用されたリクエストへの参照がありますが、直接作成されたサイトにはリクエストの詳細はありません。

{
    "allOf":[
        {
            "$ref":"#/definitions/Site"
        }
    ]
}

ネストされたスキーマ : サイト

サイトには、リクエストしたユーザーやサイトを承認したユーザー、物理サイトに関する詳細など、サイト・フォルダに対する元のリクエストに関する情報が含まれます。 承認プロセスを使用してリクエストを介して作成されたすべてのサイトには、そのサイトの作成に使用されたリクエストへの参照がありますが、直接作成されたサイトにはリクエストの詳細はありません。

すべてに一致

ソースを表示

• object SingularResource

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

• object Site-allOf[1]

{
    "description":"<p>A site includes information about the original request for the site, such as who requested and who approved the site as well as details about the physical site, in the form of a site folder. All sites created through requests using the approval process will have a reference to the request that was used to created them, but sites created directly will not have request details.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Immutable identifier for the site.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Human readable name for the site. </p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":242
                },
                "ownedBy":{
                    "description":"<p>User or client application that owns this site.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "createdBy":{
                    "description":"<p>User or client application that created this site.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "lastModifiedBy":{
                    "description":"<p>User, client application or service that last modified this site.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "theme":{
                    "description":"<p>Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.</p><small>Introduced in release 19.4.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Theme"
                        }
                    ]
                },
                "request":{
                    "description":"<p>Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Request"
                        }
                    ]
                },
                "members":{
                    "description":"<p>Users and groups the site has been shared with.</p><small>Introduced in release 19.4.3.</small>",
                    "x-queryable":true,
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "role":{
                                        "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "role",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "access":{
                    "description":"<p>Users and groups that can access the site.</p><small>Introduced in release 19.4.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.3.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "permissions":{
                    "description":"<p>User permissions for the site.</p><small>Introduced in release 22.7.2.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "properties":{
                        "links":{
                            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Link"
                                    }
                                ]
                            }
                        },
                        "self":{
                            "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "file":{
                            "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "members":{
                            "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "shareLink":{
                            "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "annotation":{
                            "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "conversation":{
                            "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    }
                },
                "vanityDomain":{
                    "description":"<p>Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.</p><small>Introduced in release 21.5.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/VanityDomain"
                        }
                    ]
                },
                "updates":{
                    "description":"<p>Updates for the site.</p><small>Introduced in release 21.9.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/SiteUpdate"
                                    }
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "isExpired":{
                    "description":"<p>If a site has an expiration date then an expired indicator will also be available. If a site does not have an expiration date then this field will not be present.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "isDeleted":{
                    "description":"<p>Indicates that the site has been soft deleted. The corresponding site folder will be in the trash folder of the user that owned the site.</p><small>Introduced in release 19.4.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "description":{
                    "description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "createdAt":{
                    "description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "lastModifiedAt":{
                    "description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "thumbnail":{
                    "description":"<p>Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Image"
                        }
                    ]
                },
                "isEnterprise":{
                    "description":"<p>Is this an Enterprise site.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "themeName":{
                    "description":"<p>Name of the theme used by this template.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "defaultLanguage":{
                    "description":"<p>Default language for translation.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "runtimeStatus":{
                    "description":"<p>Indicates whether the site is offline or online.</p><p>Valid values are:\n<ul><li> <code>offline</code> - Site is offline. Site has not been activated, or was activated and was deactivated</li><li> <code>online</code> - Site is online. Site has been activated</li></p><small>Introduced in release 19.2.2.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "offlineAt":{
                    "description":"<p>When the site was last taken offline. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "onlineAt":{
                    "description":"<p>When the site was last brought online. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.2.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "publishStatus":{
                    "description":"<p>Indicates what state the site is in with respect to site artifact publication.</p><p>Valid values are:\n<ul><li> <code>unpublished</code> - Site is unpublished. No published files on runtime site environment</li><li> <code>draft</code> - Site has draft updates. Published files exist on runtime site environment, but there are new unapproved updates in base site</li><li> <code>approved</code> - Site has approved updates. Published files exist on runtime site environment, but there are new approved updates in base site</li><li> <code>published</code> - Site is published. Published files exist on runtime site environment</li></p><small>Introduced in release 19.2.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "publishedAt":{
                    "description":"<p>When the site was last published. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "unpublishedAt":{
                    "description":"<p>When the site was last unpublished. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.2.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "expiresAt":{
                    "description":"<p>Expiration date for the site, if the site has been given an expiration date. An expired site cannot be activated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "description":"<p>Site security settings.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteSecurity"
                        }
                    ]
                },
                "userSecurity":{
                    "description":"<p>Site security settings relating to OCE user types.</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteUserSecurity"
                        }
                    ]
                },
                "sitePrefix":{
                    "description":"<p>The site prefix is used to prefix content item names that appear in a URL if the content item does not have a slug prefix. Specifying a site prefix ensures all content items for the site have a unique slug. Site prefixes are limit to 15 characters in length.</p><small>Introduced in release 19.2.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":15
                },
                "templateName":{
                    "description":"<p>Name of the template that was used to create this site.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "isIframeEmbeddingAllowed":{
                    "description":"<p>Whether this site can be embedded in an iFrame.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "numberOfUpdates":{
                    "description":"<p>Number of updates made on this site.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "job":{
                    "description":"<p>Running job details for the site. If there is a job running for the site the details will be returned.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteJobStatus"
                        }
                    ]
                },
                "repository":{
                    "description":"<p>The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.</p><small>Introduced in release 19.2.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Repository"
                        }
                    ]
                },
                "channel":{
                    "description":"<p>The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.</p><small>Introduced in release 19.2.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Channel"
                        }
                    ]
                },
                "defaultCollection":{
                    "description":"<p>When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.</p><small>Introduced in release 19.2.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/RepositoryCollection"
                        }
                    ]
                },
                "staticSiteDeliveryOptions":{
                    "description":"<p>Static site options.</p><small>Introduced in release 20.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/StaticSiteDeliveryOptions"
                        }
                    ]
                },
                "contentSecurity":{
                    "description":"<p>Content security assigned to the site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/TaxonomyCategory"
                        }
                    ]
                },
                "siteCategory":{
                    "description":"<p>Private site category generated for SST sites.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/TaxonomyCategory"
                        }
                    ]
                },
                "compilationStatus":{
                    "description":"<p>The compilation status of the site. This can either be a custom value or one of the several know statuses e.g <code>Submitted</code>, <code>Compiled</code> and <code>Failed</code>.</p><small>Introduced in release 23.1.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "sitePageOptions":{
                    "description":"<p>Site page options.</p><small>Introduced in release 23.2.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SitePageOptions"
                        }
                    ]
                }
            }
        }
    ]
}

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

型: object

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

ソースを表示

• links(optional): array links

  このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

{
    "description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : Site-allOf[1]

型: object

ソースを表示

• access(optional): object access

  サイトにアクセスできるユーザーおよびグループ。

  リリース19.4.3での導入。
• channel(optional): channel

  エンタープライズ・サイトに関連付けられたチャネル。 サイト・チャネルは、サイトの作成時またはコピー時に作成されます。 サイトのローカリゼーション・ポリシーは、チャネルから見つかります。 Standardサイトはチャネルに関連付けられていません。

  リリース19.2.3.での導入。
• compilationStatus(optional): string

  サイトのコンパイル・ステータス。 これは、カスタム値か、Submitted、Compiled、Failedなどの既知のステータスのいずれかです。

  リリース23.1.1で導入されました。
• contentSecurity(optional): contentSecurity

  サイトに割り当てられたコンテンツ・セキュリティ。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• createdAt(optional): string(date-time)

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

• createdBy(optional): createdBy

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

• defaultCollection(optional): defaultCollection

  エンタープライズ・サイトが作成されると、そのサイトで使用するリポジトリが指定されます。 コレクションは、サイトが作成され、コレクションがリポジトリに関連付けられたときに作成されます。 アセットがこのコレクションに追加されると、それらのアセットはこのサイトで使用可能になります。 Standardサイトはコレクションに関連付けられていません。

  リリース19.2.3.での導入。
• defaultLanguage(optional): string

  翻訳のデフォルト言語。

• description(optional): string
  最大長: 1000

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

• expiresAt(optional): string(date-time)

  サイトに有効期限が設定されている場合、サイトの有効期限。 有効期限が切れたサイトはアクティブ化できません。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

  リリース19.4.1.での導入。
• id(optional): string

  サイトの不変の識別子。

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

• isDeleted(オプション): boolean

  サイトがソフト削除されたことを示します。 対応するサイト・フォルダは、サイトを所有しているユーザーのごみ箱フォルダにあります。

  リリース19.4.1.での導入。
• isEnterprise(optional): boolean

  これはエンタープライズ・サイトです。

• isExpired(optional): boolean

  サイトに失効日がある場合、失効インジケータも使用できます。 サイトに有効期限がない場合、このフィールドは表示されません。

  リリース19.4.1.での導入。
• isIframeEmbeddingAllowed(optional): boolean

  このサイトをiFrameに埋め込むことができるかどうか。

• job(optional): job

  サイトで実行中のジョブの詳細。 サイトに対して実行中のジョブがある場合、詳細が返されます。

• lastModifiedAt(optional): string(date-time)

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

• lastModifiedBy(optional): lastModifiedBy

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

• members(optional): object members

  サイトが共有されたユーザーおよびグループ。

  リリース19.4.3での導入。
• name(optional): string
  最大長: 242

  サイトの読みやすい名前。

• numberOfUpdates(optional): integer(int32)

  このサイトで行われた更新の数。

• offlineAt(optional): string(date-time)

  サイトが最後にオフラインにされたとき。 サイトがオフラインにされていない場合、このプロパティは表示されません。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

• onlineAt(optional): string(date-time)

  サイトが最後にオンラインにされた時間。 サイトがオフラインにされていない場合、このプロパティは表示されません。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

  リリース19.2.2.での導入。
• ownedBy(optional): ownedBy

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

• permissions(optional): object permissions

  サイトのユーザー権限。

  リリース22.7.2で導入されました。
• publishedAt(optional): string(date-time)

  サイトが最後に公開された日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

• publishStatus(optional): string

  サイトがサイト・アーティファクト公開に関してどの状態にあるかを示します。

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

  • unpublished - サイトは公開されていません。 ランタイム・サイト環境に公開されたファイルがありません
  • draft - サイトに下書き更新があります。 公開されたファイルがランタイム・サイト環境に存在しますが、ベース・サイトに新しい未承認の更新があります
  • approved - サイトには更新が承認されました。 公開されたファイルはランタイム・サイト環境に存在しますが、ベース・サイトには新しい承認済の更新があります
  • published - サイトは公開されています。 公開されたファイルは、ランタイム・サイト環境に存在

  リリース19.2.2.での導入。
• repository(optional): repository

  エンタープライズ・サイトに関連付けられたリポジトリ。 このリポジトリのアセットは、サイト・コンテンツの一部として使用できます。 サイトが作成またはコピーされると、リポジトリが設定されます。 Standardサイトはリポジトリに関連付けられません。

  リリース19.2.3.での導入。
• request(optional): リクエスト

  このサイトが作成される原因となったリクエスト。 サイトが新規サイト・リクエストまたはコピー・サイト・リクエストから作成された場合、リクエスト詳細はサイトに関連付けられます。 これには、リクエストがどのように承認されたかの詳細も含まれています。 サイト・ガバナンスが無効になっている状態でサイトが作成された場合、サイトにリクエストは関連付けられません。

• runtimeStatus(optional): string

  サイトがオフラインであるかオンラインであるかを示します。

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

  • offline - サイトはオフラインです。 サイトがアクティブ化されていないか、アクティブ化されて非アクティブ化されています
  • online - サイトはオンラインです。 サイトがアクティブ化されました

  リリース19.2.2.での導入。
• security(optional): security

  サイト・セキュリティ設定。

• siteCategory(optional): siteCategory

  SSTサイトに対して生成されたプライベート・サイト・カテゴリ。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• sitePageOptions(optional): sitePageOptions

  サイト・ページのオプション。

  リリース23.2.1で導入されました。
• sitePrefix(optional): string
  最大長: 15

  サイト・プレフィクスは、コンテンツ・アイテムにスラグ・プレフィクスがない場合にURLに表示されるコンテンツ・アイテム名のプレフィクスとして使用されます。 サイト・プレフィクスを指定すると、サイトのすべてのコンテンツ・アイテムに一意のスラグが適用されます。 サイト・プレフィクスの長さは15文字までです。

  リリース19.2.3.での導入。
• staticSiteDeliveryOptions(optional): staticSiteDeliveryOptions

  静的サイト・オプション。

  リリース20.3.3で導入されました。
• templateName(optional): string

  このサイトの作成に使用されたテンプレートの名前。

• theme(optional): テーマ

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

  リリース19.4.1.での導入。
• themeName(optional): string

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

• thumbnail(optional): サムネイル

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

• unpublishedAt(optional): string(date-time)

  サイトが最後に公開取消された日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

  リリース19.2.2.での導入。
• updates(optional): object updates

  サイトの更新。

  リリース21.9.1で導入されました。
• userSecurity(optional): userSecurity

  OCEユーザー・タイプに関連するサイト・セキュリティ設定。

  リリース21.10.2で導入されました。
• vanityDomain(optional): vanityDomain

  サイトに関連付けられたバニティ・ドメイン。 サイトにバニティ・ドメインがある場合は、このドメインを使用してランタイム・サイトにアクセスできます。

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

{
    "properties":{
        "id":{
            "description":"<p>Immutable identifier for the site.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Human readable name for the site. </p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":242
        },
        "ownedBy":{
            "description":"<p>User or client application that owns this site.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "createdBy":{
            "description":"<p>User or client application that created this site.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "lastModifiedBy":{
            "description":"<p>User, client application or service that last modified this site.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "theme":{
            "description":"<p>Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.</p><small>Introduced in release 19.4.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Theme"
                }
            ]
        },
        "request":{
            "description":"<p>Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Request"
                }
            ]
        },
        "members":{
            "description":"<p>Users and groups the site has been shared with.</p><small>Introduced in release 19.4.3.</small>",
            "x-queryable":true,
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "role":{
                                "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "role",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "access":{
            "description":"<p>Users and groups that can access the site.</p><small>Introduced in release 19.4.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.3.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "permissions":{
            "description":"<p>User permissions for the site.</p><small>Introduced in release 22.7.2.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "properties":{
                "links":{
                    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Link"
                            }
                        ]
                    }
                },
                "self":{
                    "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "file":{
                    "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "members":{
                    "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "shareLink":{
                    "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "annotation":{
                    "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "conversation":{
                    "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "vanityDomain":{
            "description":"<p>Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.</p><small>Introduced in release 21.5.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/VanityDomain"
                }
            ]
        },
        "updates":{
            "description":"<p>Updates for the site.</p><small>Introduced in release 21.9.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/SiteUpdate"
                            }
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "isExpired":{
            "description":"<p>If a site has an expiration date then an expired indicator will also be available. If a site does not have an expiration date then this field will not be present.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "isDeleted":{
            "description":"<p>Indicates that the site has been soft deleted. The corresponding site folder will be in the trash folder of the user that owned the site.</p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "description":{
            "description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "createdAt":{
            "description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedAt":{
            "description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "thumbnail":{
            "description":"<p>Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Image"
                }
            ]
        },
        "isEnterprise":{
            "description":"<p>Is this an Enterprise site.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "themeName":{
            "description":"<p>Name of the theme used by this template.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "defaultLanguage":{
            "description":"<p>Default language for translation.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "runtimeStatus":{
            "description":"<p>Indicates whether the site is offline or online.</p><p>Valid values are:\n<ul><li> <code>offline</code> - Site is offline. Site has not been activated, or was activated and was deactivated</li><li> <code>online</code> - Site is online. Site has been activated</li></p><small>Introduced in release 19.2.2.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "offlineAt":{
            "description":"<p>When the site was last taken offline. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "onlineAt":{
            "description":"<p>When the site was last brought online. If the site has never been taken offline this property will not be present. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.2.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "publishStatus":{
            "description":"<p>Indicates what state the site is in with respect to site artifact publication.</p><p>Valid values are:\n<ul><li> <code>unpublished</code> - Site is unpublished. No published files on runtime site environment</li><li> <code>draft</code> - Site has draft updates. Published files exist on runtime site environment, but there are new unapproved updates in base site</li><li> <code>approved</code> - Site has approved updates. Published files exist on runtime site environment, but there are new approved updates in base site</li><li> <code>published</code> - Site is published. Published files exist on runtime site environment</li></p><small>Introduced in release 19.2.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "publishedAt":{
            "description":"<p>When the site was last published. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "unpublishedAt":{
            "description":"<p>When the site was last unpublished. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.2.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "expiresAt":{
            "description":"<p>Expiration date for the site, if the site has been given an expiration date. An expired site cannot be activated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "description":"<p>Site security settings.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteSecurity"
                }
            ]
        },
        "userSecurity":{
            "description":"<p>Site security settings relating to OCE user types.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteUserSecurity"
                }
            ]
        },
        "sitePrefix":{
            "description":"<p>The site prefix is used to prefix content item names that appear in a URL if the content item does not have a slug prefix. Specifying a site prefix ensures all content items for the site have a unique slug. Site prefixes are limit to 15 characters in length.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":15
        },
        "templateName":{
            "description":"<p>Name of the template that was used to create this site.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isIframeEmbeddingAllowed":{
            "description":"<p>Whether this site can be embedded in an iFrame.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "numberOfUpdates":{
            "description":"<p>Number of updates made on this site.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "job":{
            "description":"<p>Running job details for the site. If there is a job running for the site the details will be returned.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteJobStatus"
                }
            ]
        },
        "repository":{
            "description":"<p>The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.</p><small>Introduced in release 19.2.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Repository"
                }
            ]
        },
        "channel":{
            "description":"<p>The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.</p><small>Introduced in release 19.2.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Channel"
                }
            ]
        },
        "defaultCollection":{
            "description":"<p>When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.</p><small>Introduced in release 19.2.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/RepositoryCollection"
                }
            ]
        },
        "staticSiteDeliveryOptions":{
            "description":"<p>Static site options.</p><small>Introduced in release 20.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/StaticSiteDeliveryOptions"
                }
            ]
        },
        "contentSecurity":{
            "description":"<p>Content security assigned to the site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/TaxonomyCategory"
                }
            ]
        },
        "siteCategory":{
            "description":"<p>Private site category generated for SST sites.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/TaxonomyCategory"
                }
            ]
        },
        "compilationStatus":{
            "description":"<p>The compilation status of the site. This can either be a custom value or one of the several know statuses e.g <code>Submitted</code>, <code>Compiled</code> and <code>Failed</code>.</p><small>Introduced in release 23.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "sitePageOptions":{
            "description":"<p>Site page options.</p><small>Introduced in release 23.2.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SitePageOptions"
                }
            ]
        }
    }
}

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• object 「リンク」

  REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

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

型: object

REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

ソースを表示

• href(optional): string

  ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。 値がURIテンプレートに設定されている場合、templatedプロパティをtrueに設定する必要があります。

• mediaType(optional): string

  メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。

• method(optional): string

  リンクのターゲットをリクエストするためのHTTPメソッド。

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

  • OPTIONS - HTTP OPTIONS
  • HEAD - HTTP HEAD
  • GET - HTTP GET
  • POST - HTTP POST
  • PUT - HTTP PUT
  • PATCH - HTTP PATCH
  • DELETE - HTTP DELETE

• profile(optional): string(uri)

  ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。

• rel(optional): string

  リンクの詳細を取得するために使用できるリンク・リレーションの名前。

• templated(optional): boolean

  hrefプロパティを指定するブール・フラグは、URIまたはURIテンプレートです。 プロパティが存在しない場合、falseとみなすことができます。

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

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

型: object

サイトにアクセスできるユーザーおよびグループ。

リリース19.4.3での導入。

ソースを表示

• items: array items

  「サイト・アクセス・メンバー」要素のコレクション。

  リリース19.4.3での導入。

{
    "description":"<p>Users and groups that can access the site.</p><small>Introduced in release 19.4.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

• allOf CollectionResource

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

{
    "description":"<p>Users and groups that can access the site.</p><small>Introduced in release 19.4.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

エンタープライズ・サイトに関連付けられたチャネル。 サイト・チャネルは、サイトの作成時またはコピー時に作成されます。 サイトのローカリゼーション・ポリシーは、チャネルから見つかります。 Standardサイトはチャネルに関連付けられていません。

リリース19.2.3.での導入。

すべてに一致

ソースを表示

• allOf Channel

  パブリッシュ・チャネルは、リポジトリ内のアイテムに適用されるリリース・ルールを決定します。 チャネルは、パブリックで全員が使用可能な場合も、安全で制限されている場合もあります。 リポジトリでは、複数のチャネルを使用できます。 リポジトリの特定のアセットで使用する特定のチャネルを選択して、個々のケースで適用するポリシーを決定できます。

{
    "description":"<p>The channel associated with an enterprise site. Site channels are created when the site is created or copied. The localization policy for the site can be found from the channel. Standard sites are not associated with a channel.</p><small>Introduced in release 19.2.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Channel"
        }
    ]
}

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

サイトに割り当てられたコンテンツ・セキュリティ。

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

すべてに一致

ソースを表示

• allOf TaxonomyCategory

  タクソノミのカテゴリ。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

{
    "description":"<p>Content security assigned to the site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/TaxonomyCategory"
        }
    ]
}

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

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

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application that created this site.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

エンタープライズ・サイトが作成されると、そのサイトで使用するリポジトリが指定されます。 コレクションは、サイトが作成され、コレクションがリポジトリに関連付けられたときに作成されます。 アセットがこのコレクションに追加されると、それらのアセットはこのサイトで使用可能になります。 Standardサイトはコレクションに関連付けられていません。

リリース19.2.3.での導入。

すべてに一致

ソースを表示

• allOf RepositoryCollection

  コレクションを使用すると、Webサイト、外部アプリケーションまたはマーケティング・キャンペーンで使用するコンテンツ・アイテム、デジタル・アセットおよびドキュメントをグループ化できます。 コレクションは個々のリポジトリに固有であり、リポジトリ内のアイテムのサブセットの管理に使用できます。 コレクション内のすべてのアイテムは、コレクションに割り当てられたパブリッシュ・チャネルに準拠します。

{
    "description":"<p>When an enterprise site is created, a repository is specified for use with that site. A collection is created when the site is created and the collection is associated with the repository. When assets are added to this collection, those assets are available for use in this site. Standard sites are not associated with a collection.</p><small>Introduced in release 19.2.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/RepositoryCollection"
        }
    ]
}

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

サイトで実行中のジョブの詳細。 サイトに対して実行中のジョブがある場合、詳細が返されます。

すべてに一致

ソースを表示

• allOf SiteJobStatus
  識別子: action

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

{
    "description":"<p>Running job details for the site. If there is a job running for the site the details will be returned.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteJobStatus"
        }
    ]
}

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

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

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User, client application or service that last modified this site.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

型: object

サイトが共有されたユーザーおよびグループ。

リリース19.4.3での導入。

ソースを表示

• items: array items

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

  リリース19.4.1.での導入。

{
    "description":"<p>Users and groups the site has been shared with.</p><small>Introduced in release 19.4.3.</small>",
    "x-queryable":true,
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "role":{
                        "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "role",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

• allOf CollectionResource

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

{
    "description":"<p>Users and groups the site has been shared with.</p><small>Introduced in release 19.4.3.</small>",
    "x-queryable":true,
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "role":{
                        "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "role",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

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

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application that owns this site.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

ネストされたスキーマ : 許可

型: object

サイトのユーザー権限。

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

ソースを表示

• annotation(optional): array annotation

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

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

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

  リリース22.7.2で導入されました。
• conversation(optional): array conversation

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

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

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

  リリース22.7.2で導入されました。
• file(optional): array file

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

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

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

  リリース22.7.2で導入されました。
• links(optional): array links

  このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

• members(optional): array members

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

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

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

  リリース22.7.2で導入されました。
• self(optional): array self

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

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

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

  リリース22.7.2で導入されました。
• shareLink(optional): array shareLink

  ユーザーが持つ共有リンク・アクセス権のセット。

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

  • read - 共有リンクの読取りおよびリスト
  • create - 共有リンクの作成
  • update - 共有リンクの更新
  • delete - 共有リンクの削除

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

{
    "description":"<p>User permissions for the site.</p><small>Introduced in release 22.7.2.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "self":{
            "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "file":{
            "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "members":{
            "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "shareLink":{
            "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "annotation":{
            "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "conversation":{
            "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

エンタープライズ・サイトに関連付けられたリポジトリ。 このリポジトリのアセットは、サイト・コンテンツの一部として使用できます。 サイトが作成またはコピーされると、リポジトリが設定されます。 Standardサイトはリポジトリに関連付けられません。

リリース19.2.3.での導入。

すべてに一致

ソースを表示

• allOf Repository

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

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

{
    "description":"<p>The repository associated with an enterprise site. Assets from this repository can be used as part of the site content. The repository is set when the site is created or copied. Standard sites are not associated with a repository.</p><small>Introduced in release 19.2.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Repository"
        }
    ]
}

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

このサイトが作成される原因となったリクエスト。 サイトが新規サイト・リクエストまたはコピー・サイト・リクエストから作成された場合、リクエスト詳細はサイトに関連付けられます。 これには、リクエストがどのように承認されたかの詳細も含まれています。 サイト・ガバナンスが無効になっている状態でサイトが作成された場合、サイトにリクエストは関連付けられません。

すべてに一致

ソースを表示

• allOf Request
  識別子: requestType

  リクエストは、処理前に承認を必要とする操作を表します。 リクエストの例は、新規サイトの作成のリクエストです。 リクエストは却下することもできます。 リクエストは、1つ以上の「レビュー」をリクエストに追加することで承認または却下されます。 リクエストが作成されると、リクエストの承認または拒否ステータスに影響するレビューの追加とは別に変更できません。 有効でなくなったリクエストは削除できます。 リクエストが否認された場合、新しいリクエストを作成する必要があります。 リクエストが承認されると、リクエストにレビューを追加できなくなります。 否認されたリクエストは、そのリクエストを承認するレビューを作成することによって承認できます。 サイト・ガバナンスが無効になっている場合、リクエストは失敗します。

{
    "description":"<p>Request that caused this site to be created. If the site was created from a new site request or copy site request the request details are associated with the site. This also includes details of how the request was approved. If the site was created with site governance disabled no request will be associated with the site.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Request"
        }
    ]
}

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

サイト・セキュリティ設定。

すべてに一致

ソースを表示

• object SiteSecurity

  サイトおよびセキュリティ・ポリシーのセキュリティ・レベルを定義します。 アクセス・レベルを、ポリシーに必要な最小レベルより低いレベルに設定することはできません。 「サイト管理者」のみがサイトのセキュリティ・ポリシーを変更できます。

{
    "description":"<p>Site security settings.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteSecurity"
        }
    ]
}

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

SSTサイトに対して生成されたプライベート・サイト・カテゴリ。

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

すべてに一致

ソースを表示

• allOf TaxonomyCategory

  タクソノミのカテゴリ。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

{
    "description":"<p>Private site category generated for SST sites.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/TaxonomyCategory"
        }
    ]
}

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

サイト・ページのオプション。

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

すべてに一致

ソースを表示

• object SitePageOptions

  サイト・ページのオプション。

  URL検証チェックの無効化やサーバー側レンダリングの有効化などのページ固有のオプション。

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

{
    "description":"<p>Site page options.</p><small>Introduced in release 23.2.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SitePageOptions"
        }
    ]
}

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

静的サイト・オプション。

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

すべてに一致

ソースを表示

• object StaticSiteDeliveryOptions

  静的なサイト配信オプション。

  静的サイト(つまり、コンパイル済サイト)の場合、これらのサイトがキャッシュされる期間と、サイト・コンパイルでサポートされるアダプティブ・モバイル・レイアウトのモバイル・ユーザー・アジェントが呼び出す時間。

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

{
    "description":"<p>Static site options.</p><small>Introduced in release 20.3.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/StaticSiteDeliveryOptions"
        }
    ]
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• allOf Theme

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

  リリース19.4.1.での導入。

{
    "description":"<p>Theme associated with the site. When sites are created from the template the sites are associated with the theme of the template. Published changes to the theme will affect the live site.</p><small>Introduced in release 19.4.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Theme"
        }
    ]
}

ネストされたスキーマ : サムネイル

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

すべてに一致

ソースを表示

• allOf Image

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

{
    "description":"<p>Thumbnail image. If available, this is the image suitable for displaying as thumbnail when displaying this site template.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Image"
        }
    ]
}

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

型: object

サイトの更新。

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

ソースを表示

• items: array items

  「サイトの更新」要素のコレクション。

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

{
    "description":"<p>Updates for the site.</p><small>Introduced in release 21.9.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/SiteUpdate"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

• allOf CollectionResource

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

{
    "description":"<p>Updates for the site.</p><small>Introduced in release 21.9.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/SiteUpdate"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

OCEユーザー・タイプに関連するサイト・セキュリティ設定。

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

すべてに一致

ソースを表示

• object SiteUserSecurity

  サイトで特定の権限を付与する必要があるかどうかなど、OCEユーザー・タイプに関連するセキュリティ設定を定義

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

{
    "description":"<p>Site security settings relating to OCE user types.</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteUserSecurity"
        }
    ]
}

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

サイトに関連付けられたバニティ・ドメイン。 サイトにバニティ・ドメインがある場合は、このドメインを使用してランタイム・サイトにアクセスできます。

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

すべてに一致

ソースを表示

• allOf VanityDomain

  サイトのバニティ・ドメインを定義します。 構成すると、サイト・ドメインの代わりにバニティ・ドメインを使用してサイトにアクセスできます。

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

{
    "description":"<p>Vanity Domain associated with the site. If the site has a vanity domain, the runtime site can be accessed using this domain.</p><small>Introduced in release 21.5.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/VanityDomain"
        }
    ]
}

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

型: array

「サイト・アクセス・メンバー」要素のコレクション。

リリース19.4.3での導入。

ソースを表示

• Array of: object items

{
    "description":"<p>Collection of <em>Site Access Member</em> elements.</p><small>Introduced in release 19.4.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.3.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

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

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

すべてに一致

ソースを表示

• object SingularResource

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

• object CollectionResource-allOf[1]

{
    "description":"<p>All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "totalResults":{
                    "description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "limit":{
                    "description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "count":{
                    "description":"<p>Total number of resources in the response.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "hasMore":{
                    "description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"boolean"
                },
                "offset":{
                    "description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

ネストされたスキーマ : CollectionResource-allOf[1]

型: object

ソースを表示

• count(optional): integer(int32)

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

• hasMore(optional): boolean

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

• limit(optional): integer(int32)

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

• offset(optional): integer(int64)

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

• totalResults(optional): integer(int64)

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

{
    "properties":{
        "totalResults":{
            "description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "description":"<p>Total number of resources in the response.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"boolean"
        },
        "offset":{
            "description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: object

ソースを表示

• displayName(optional): string

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

  リリース19.4.3での導入。
• group(optional): グループ

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

  リリース19.4.3での導入。
• groupType(optional): string

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

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

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

  リリース20.1.1で導入されました。
• id: string

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

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

  リリース19.4.3での導入。
• isExternalUser(optional): boolean

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

  リリース21.10.2で導入されました。
• name: string

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

  リリース19.4.3での導入。
• type: string

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

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

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

  クライアント・アプリケーションであるメンバー。

  • group - メンバーはグループです

  リリース19.4.3での導入。
• user(optional): user

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

  リリース19.4.3での導入。

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.3.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.3.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

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

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

リリース19.4.3での導入。

すべてに一致

ソースを表示

• allOf Group

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

  リリース19.3.1.での導入。

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

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

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

リリース19.4.3での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

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

リリース19.3.1.での導入。

すべてに一致

ソースを表示

• object SingularResource

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

• object Group-allOf[1]

{
    "description":"<p>A group is a collection of users and groups. A group has a human readable group name.</p><small>Introduced in release 19.3.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "type":{
                    "description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "groupName":{
                    "description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "displayName":{
                    "description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "roles":{
                    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : Group-allOf[1]

型: object

ソースを表示

• displayName(optional): string

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

  リリース19.3.1.での導入。
• groupName(optional): string

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

  リリース19.3.1.での導入。
• id(optional): string

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

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

  リリース19.3.1.での導入。
• roles(optional): array roles

  ロール

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

  • CECServiceAdministrator - サービス管理者

  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者

  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者

  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー

  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー

  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー

  将来使用するために予約済

  • CECIntegrationUser - 統合ユーザー

  Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。

  • CECSitesVisitor - サイト・ビジター

  サイトへのアクセスはビジターに制限されます。

  リリース21.10.2で導入されました。
• type(optional): string

  グループのタイプ。

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

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

  リリース19.3.1.での導入。

{
    "properties":{
        "id":{
            "description":"<p>Unique identifer for the group.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Type of the group.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupName":{
            "description":"<p>Group name that is unique within the service instance.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Human-readable name for the group.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "roles":{
            "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

ロール

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

• CECServiceAdministrator - サービス管理者

• ユーザー列挙の割当
• ユーザーのパスワードおよびチャレンジ質問の変更
• サービス・インスタンスの構成、モニターおよび管理
• CECSitesAdministrator - サイト管理者

• サイト、テンプレート、テーマまたはコンポーネントの作成
• CECRepositoryAdministrator - リポジトリ管理者
• CECDeveloperUser - 開発者ユーザー
• CECContentAdministrator - コンテンツ管理者

• 新規コンテンツ・タイプの作成およびアイテムの公開
• CECStandardUser - 標準ユーザー

• コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
• 他のユーザーとのコンテンツおよびサイトの共有
• 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
• ユーザーのフォロー
• サイトの作成、編集および公開
• サイトのテーマの管理および公開
• カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
• サイト・テンプレートの作成、編集、エクスポートおよびインポート
• サイト内のコンテンツの表示および操作
• カスタム・プロパティの管理と表示、および値の編集
• CECEnterpriseUser - エンタープライズ・ユーザー

• コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
• 他のユーザーとのコンテンツおよびサイトの共有
• 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
• ユーザーのフォロー
• デジタル・アセット
• コンテンツ・アイテム(エディトリアル・コンテンツ管理)
• コンテンツ・アイテムの作成、管理、表示および操作
• コレクション
• サイトの作成、編集および公開
• サイトのテーマの管理および公開
• カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
• サイト・テンプレートの作成、編集、エクスポートおよびインポート
• カスタム・プロパティの管理と表示、および値の編集
• CECExternalUser - 外部ユーザー

将来使用するために予約済

• CECIntegrationUser - 統合ユーザー

Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。

• CECSitesVisitor - サイト・ビジター

サイトへのアクセスはビジターに制限されます。

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

ソースを表示

• Array of: string

{
    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

識別子: type

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

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

すべてに一致

ソースを表示

• object SingularResource

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

• object Identity-allOf[1]

{
    "description":"<p>Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.</p><small>Introduced in release 20.3.1.</small>",
    "discriminator":"type",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "type":{
                    "description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "id":{
                    "description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "displayName":{
                    "description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "roles":{
                    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : Identity-allOf[1]

型: object

ソースを表示

• displayName(optional): string

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

  リリース20.3.1で導入されました。
• id(optional): string

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

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

  リリース20.3.1で導入されました。
• name(optional): string

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

  リリース20.3.1で導入されました。
• roles(optional): array roles

  ロール

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

  • CECServiceAdministrator - サービス管理者

  • ユーザー列挙の割当
  • ユーザーのパスワードおよびチャレンジ質問の変更
  • サービス・インスタンスの構成、モニターおよび管理
  • CECSitesAdministrator - サイト管理者

  • サイト、テンプレート、テーマまたはコンポーネントの作成
  • CECRepositoryAdministrator - リポジトリ管理者
  • CECDeveloperUser - 開発者ユーザー
  • CECContentAdministrator - コンテンツ管理者

  • 新規コンテンツ・タイプの作成およびアイテムの公開
  • CECStandardUser - 標準ユーザー

  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • サイト内のコンテンツの表示および操作
  • カスタム・プロパティの管理と表示、および値の編集
  • CECEnterpriseUser - エンタープライズ・ユーザー

  • コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
  • 他のユーザーとのコンテンツおよびサイトの共有
  • 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
  • ユーザーのフォロー
  • デジタル・アセット
  • コンテンツ・アイテム(エディトリアル・コンテンツ管理)
  • コンテンツ・アイテムの作成、管理、表示および操作
  • コレクション
  • サイトの作成、編集および公開
  • サイトのテーマの管理および公開
  • カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
  • サイト・テンプレートの作成、編集、エクスポートおよびインポート
  • カスタム・プロパティの管理と表示、および値の編集
  • CECExternalUser - 外部ユーザー

  将来使用するために予約済

  • CECIntegrationUser - 統合ユーザー

  Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。

  • CECSitesVisitor - サイト・ビジター

  サイトへのアクセスはビジターに制限されます。

  リリース21.10.2で導入されました。
• type(optional): string

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

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

{
    "properties":{
        "type":{
            "description":"<p>Type of <em>Identity</em>. Valid values are: <code>user</code>, <code>service</code>, <code>application</code>, <code>unknown</code>.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "id":{
            "description":"<p>An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name, such as the user name or client application name.</p><small>Introduced in release 20.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Human-readable display name.</p><small>Introduced in release 20.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "roles":{
            "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

ロール

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

• CECServiceAdministrator - サービス管理者

• ユーザー列挙の割当
• ユーザーのパスワードおよびチャレンジ質問の変更
• サービス・インスタンスの構成、モニターおよび管理
• CECSitesAdministrator - サイト管理者

• サイト、テンプレート、テーマまたはコンポーネントの作成
• CECRepositoryAdministrator - リポジトリ管理者
• CECDeveloperUser - 開発者ユーザー
• CECContentAdministrator - コンテンツ管理者

• 新規コンテンツ・タイプの作成およびアイテムの公開
• CECStandardUser - 標準ユーザー

• コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
• 他のユーザーとのコンテンツおよびサイトの共有
• 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
• ユーザーのフォロー
• サイトの作成、編集および公開
• サイトのテーマの管理および公開
• カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
• サイト・テンプレートの作成、編集、エクスポートおよびインポート
• サイト内のコンテンツの表示および操作
• カスタム・プロパティの管理と表示、および値の編集
• CECEnterpriseUser - エンタープライズ・ユーザー

• コンテンツの管理(ドキュメントの表示、アップロードおよび編集)
• 他のユーザーとのコンテンツおよびサイトの共有
• 会話によるコラボレーション(トピックのディスカッション、他のユーザーへのメッセージの送信、他のユーザーへのフラグの割当て、ドキュメントへの注釈の追加)
• ユーザーのフォロー
• デジタル・アセット
• コンテンツ・アイテム(エディトリアル・コンテンツ管理)
• コンテンツ・アイテムの作成、管理、表示および操作
• コレクション
• サイトの作成、編集および公開
• サイトのテーマの管理および公開
• カスタム・サイト・コンポーネントの作成、登録、エクスポートおよびインポート
• サイト・テンプレートの作成、編集、エクスポートおよびインポート
• カスタム・プロパティの管理と表示、および値の編集
• CECExternalUser - 外部ユーザー

将来使用するために予約済

• CECIntegrationUser - 統合ユーザー

Collaboration REST APIのソーシャルRESTエンドポイントを介して操作を実行しながら、別のユーザーを偽装するために使用されます。

• CECSitesVisitor - サイト・ビジター

サイトへのアクセスはビジターに制限されます。

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

ソースを表示

• Array of: string

{
    "description":"<p>Roles.</p><p>Valid values are:\n<ul><li> <code>CECServiceAdministrator</code> - Service Administrator</li></ul>\n<ul><li> Assign user enumerates</li><li> Change user passwords and challenge questions</li><li> Configure, monitor, and manage service instances</li><li> <code>CECSitesAdministrator</code> - Sites Administrator</li></ul>\n<ul><li> Create sites, templates, themes or components</li><li> <code>CECRepositoryAdministrator</code> - Repository Administrator</li><li> <code>CECDeveloperUser</code> - Developer User</li><li> <code>CECContentAdministrator</code> - Content Administrator</li></ul>\n<ul><li> Create new content types and publish items</li><li> <code>CECStandardUser</code> - Standard User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> View and interact with content items in sites</li><li> Manage and view custom properties and edit values</li><li> <code>CECEnterpriseUser</code> - Enterprise User</li></ul>\n<ul><li> Manage content (view, upload, and edit documents)</li><li> Share content and sites with others</li><li> Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)</li><li> Follow people</li><li> Digital Assets</li><li> Content Items (editorial content management)</li><li> Create, manage, view, and interact with content items</li><li> Collections</li><li> Create, edit, and publish sites</li><li> Manage and publish site themes</li><li> Create, register, export, and import custom site components</li><li> Create, edit, export, and import site templates</li><li> Manage and view custom properties and edit values</li><li> <code>CECExternalUser</code> - External User</li></ul>\nReserved for future use.\n<ul><li> <code>CECIntegrationUser</code> - Integration User</li></ul>\nUsed to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.\n<ul><li> <code>CECSitesVisitor</code> - Sites Visitor</li></ul>\nAccess sites restricted to visitors.\n</p><small>Introduced in release 21.10.2.</small>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : チャネル

パブリッシュ・チャネルは、リポジトリ内のアイテムに適用されるリリース・ルールを決定します。 チャネルは、パブリックで全員が使用可能な場合も、安全で制限されている場合もあります。 リポジトリでは、複数のチャネルを使用できます。 リポジトリの特定のアセットで使用する特定のチャネルを選択して、個々のケースで適用するポリシーを決定できます。

すべてに一致

ソースを表示

• object SingularResource

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

• object Channel-allOf[1]

{
    "description":"<p>A publishing channel determines the release rules that are applied to an item in a repository. A channel can be public and available to everyone, or secure and limited. A repository can use multiple channels. You can select specific channels to use with specific assets in the repository, letting you decide the policies to be applied in individual cases.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifier for the channel.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Short human-readable name to identify the channel.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "description":{
                    "description":"<p>Human-readable description of the channel to give consumers an idea of what content this channel contains.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "createdBy":{
                    "description":"<p>User that created the channel.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "createdDate":{
                    "description":"<p>Date and time the channel was created.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "updatedBy":{
                    "description":"<p>User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "updatedDate":{
                    "description":"<p>Date and time the channel was last updated.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "channelType":{
                    "description":"<p>User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.</p><p>Valid values are:\n<ul><li> <code>public</code> - Public channel</li><li> <code>secure</code> - Secure channel</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "isSiteChannel":{
                    "description":"<p>Flag to indicate whether the channel is site channel.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "publishPolicy":{
                    "description":"<p>Publish policy of the channel.</p><p>Valid values are:\n<ul><li> <code>anythingPublished</code> - Any asset can be published</li><li> <code>onlyApproved</code> - Only approved assets can be published</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "localizationPolicy":{
                    "description":"<p>Localization policy of the channel.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "channelTokens":{
                    "description":"<p>Tokens associated with this channel.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ChannelToken"
                            }
                        ]
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : Channel-allOf[1]

型: object

ソースを表示

• channelTokens(optional): array channelTokens

  このチャネルに関連付けられているトークン。

• channelType(optional): string

  チャネルを最後に更新したユーザー。 チャネルが更新されていない場合、更新者はチャネルを作成したユーザーになります。

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

  • public - パブリック・チャネル
  • secure - セキュア・チャネル

• createdBy(optional): string

  チャネルを作成したユーザー。

• createdDate(optional): createdDate

  チャネルが作成された日時。

• description(optional): string

  このチャネルに含まれるコンテンツをコンシューマに知らせるためのチャネルの判読可能な説明。

• id(optional): string

  チャネルの一意の識別子。

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

• isSiteChannel(optional): boolean

  チャネルがサイト・チャネルであるかどうかを示すフラグ。

• localizationPolicy(optional): string

  チャネルのローカリゼーション・ポリシー。

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

• name(optional): string

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

• publishPolicy(optional): string

  チャネルの公開ポリシー。

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

  • anythingPublished - 任意のアセットをパブリッシュできます
  • onlyApproved - 承認済アセットのみをパブリッシュできます

• updatedBy(optional): string

  チャネルを最後に更新したユーザー。 チャネルが更新されていない場合、更新者はチャネルを作成したユーザーになります。

• updatedDate(optional): updatedDate

  チャネルが最後に更新された日時。

{
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the channel.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short human-readable name to identify the channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Human-readable description of the channel to give consumers an idea of what content this channel contains.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "createdBy":{
            "description":"<p>User that created the channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "createdDate":{
            "description":"<p>Date and time the channel was created.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "updatedBy":{
            "description":"<p>User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "updatedDate":{
            "description":"<p>Date and time the channel was last updated.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "channelType":{
            "description":"<p>User that last updated the channel. If the channel has not been updated the updated by will be the user that created the channel.</p><p>Valid values are:\n<ul><li> <code>public</code> - Public channel</li><li> <code>secure</code> - Secure channel</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isSiteChannel":{
            "description":"<p>Flag to indicate whether the channel is site channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "publishPolicy":{
            "description":"<p>Publish policy of the channel.</p><p>Valid values are:\n<ul><li> <code>anythingPublished</code> - Any asset can be published</li><li> <code>onlyApproved</code> - Only approved assets can be published</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "localizationPolicy":{
            "description":"<p>Localization policy of the channel.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "channelTokens":{
            "description":"<p>Tokens associated with this channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ChannelToken"
                    }
                ]
            }
        }
    }
}

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

型: array

このチャネルに関連付けられているトークン。

ソースを表示

• Array of: items

{
    "description":"<p>Tokens associated with this channel.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ChannelToken"
            }
        ]
    }
}

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

チャネルが作成された日時。

すべてに一致

ソースを表示

• object DateTimeZone

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

{
    "description":"<p>Date and time the channel was created.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

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

チャネルが最後に更新された日時。

すべてに一致

ソースを表示

• object DateTimeZone

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

{
    "description":"<p>Date and time the channel was last updated.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

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

すべてに一致

ソースを表示

• object ChannelToken

  認証を行わずにチャネルへのパブリック・アクセスを許可する認可トークンです。

{
    "allOf":[
        {
            "$ref":"#/definitions/ChannelToken"
        }
    ]
}

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

型: object

認証を行わずにチャネルへのパブリック・アクセスを許可する認可トークンです。

ソースを表示

• expirationDate(optional): expirationDate

  トークンの有効期限が切れる日付。

• name(optional): string

  トークンの名前。

• token(optional): string

  トークン値です。

{
    "description":"<p>Authorization token that allows public access to a channel without authentication.</p>",
    "properties":{
        "name":{
            "description":"<p>Name of the token.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "token":{
            "description":"<p>Token value.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "expirationDate":{
            "description":"<p>Date the token expires.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        }
    }
}

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

トークンの有効期限が切れる日付。

すべてに一致

ソースを表示

• object DateTimeZone

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

{
    "description":"<p>Date the token expires.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

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

型: object

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

ソースを表示

• description(optional): string

  日付、時間およびタイム・ゾーン情報の説明。

• timezone(optional): string

  Olsonデータベース形式のタイムゾーン。

• value(optional): string(date-time)

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

{
    "description":"<p>Date, time and time zone.</p>",
    "properties":{
        "value":{
            "description":"<p>Date in ISO 8601 format. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"<p>Timezone in Olson database format.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Description of the date, time and time zone information.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

タクソノミのカテゴリ。

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

すべてに一致

ソースを表示

• object SingularResource

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

• object TaxonomyCategory-allOf[1]

{
    "description":"<p>Category of a Taxonomy.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifier for the Taxonomy Category.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Short human-readable name to identify the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "description":{
                    "description":"<p>Human-readable description of the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "status":{
                    "description":"<p>Taxonomy Category status.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "parentId":{
                    "description":"<p>Parent id of the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "apiName":{
                    "description":"<p>Uniquely identifies a Taxonomy Category across Taxonomies.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "position":{
                    "description":"<p>The position of the Taxonomy Category among its siblings.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "namePath":{
                    "description":"<p>Full name path from the root category to this category separated by '/'.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : TaxonomyCategory-allOf[1]

型: object

ソースを表示

• apiName(optional): string

  タクソノミ間でタクソノミ・カテゴリを一意に識別します。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• description(optional): string

  タクソノミ・カテゴリのわかりやすい説明。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• id(optional): string

  タクソノミ・カテゴリの一意の識別子。

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

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• name(optional): string

  タクソノミ・カテゴリを識別するための、人間が読める短い名前。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• namePath(optional): string

  ルート・カテゴリから、'/'で区切られたこのカテゴリへのフル・ネーム・パス。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• parentId(optional): string

  タクソノミ・カテゴリの親ID。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• position(optional): integer(int32)

  兄弟間のタクソノミ・カテゴリの位置。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

• status(optional): string

  タクソノミ・カテゴリ・ステータス。

  将来のリリースを対象としています。

  この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。

{
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the Taxonomy Category.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short human-readable name to identify the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Human-readable description of the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Taxonomy Category status.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "parentId":{
            "description":"<p>Parent id of the Taxonomy Category.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "apiName":{
            "description":"<p>Uniquely identifies a Taxonomy Category across Taxonomies.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "position":{
            "description":"<p>The position of the Taxonomy Category among its siblings.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "namePath":{
            "description":"<p>Full name path from the root category to this category separated by '/'.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

コレクションを使用すると、Webサイト、外部アプリケーションまたはマーケティング・キャンペーンで使用するコンテンツ・アイテム、デジタル・アセットおよびドキュメントをグループ化できます。 コレクションは個々のリポジトリに固有であり、リポジトリ内のアイテムのサブセットの管理に使用できます。 コレクション内のすべてのアイテムは、コレクションに割り当てられたパブリッシュ・チャネルに準拠します。

すべてに一致

ソースを表示

• object SingularResource

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

• object RepositoryCollection-allOf[1]

{
    "description":"<p>Collections are a way to group content items, digital assets, and documents for use on a website, external application or for marketing campaigns. Collections are specific to individual repositories and can be used to manage a subset of items in a repository. All the items in the collection will adhere to the publishing channel that is assigned to the collection.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifier for the collection.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Short human-readable name to identify the collection.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "description":{
                    "description":"<p>Human-readable description of the collection to give consumers an idea of what content this collection is for.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "createdBy":{
                    "description":"<p>User that created the collection.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "createdDate":{
                    "description":"<p>Date and time the collection was created.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "updatedBy":{
                    "description":"<p>User that last updated the collection. If the collection has not been updated the updated by will be the user that created the collection.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "updatedDate":{
                    "description":"<p>Date and time the collection was last updated.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "channels":{
                    "description":"<p>Channels associated with the collection.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ChannelId"
                            }
                        ]
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : RepositoryCollection-allOf[1]

型: object

ソースを表示

• channels(optional): array channels

  コレクションに関連付けられているチャネル。

• createdBy(optional): string

  コレクションを作成したユーザー。

• createdDate(optional): createdDate

  コレクションが作成された日時。

• description(optional): string

  コンシューマに、このコレクションの対象であるコンテンツについての理解を提供するために、コレクションに関する判読可能な説明。

• id(optional): string

  コレクションの一意の識別子。

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

• name(optional): string

  コレクションを識別するための判読可能な短い名前。

• updatedBy(optional): string

  最後にコレクションを更新したユーザー。 コレクションが更新されていない場合、更新者はコレクションを作成したユーザーになります。

• updatedDate(optional): updatedDate

  収集が最後に更新された日時。

{
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the collection.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short human-readable name to identify the collection.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Human-readable description of the collection to give consumers an idea of what content this collection is for.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "createdBy":{
            "description":"<p>User that created the collection.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "createdDate":{
            "description":"<p>Date and time the collection was created.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "updatedBy":{
            "description":"<p>User that last updated the collection. If the collection has not been updated the updated by will be the user that created the collection.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "updatedDate":{
            "description":"<p>Date and time the collection was last updated.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "channels":{
            "description":"<p>Channels associated with the collection.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ChannelId"
                    }
                ]
            }
        }
    }
}

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

型: array

コレクションに関連付けられているチャネル。

ソースを表示

• Array of: items

{
    "description":"<p>Channels associated with the collection.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ChannelId"
            }
        ]
    }
}

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

コレクションが作成された日時。

すべてに一致

ソースを表示

• object DateTimeZone

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

{
    "description":"<p>Date and time the collection was created.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

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

収集が最後に更新された日時。

すべてに一致

ソースを表示

• object DateTimeZone

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

{
    "description":"<p>Date and time the collection was last updated.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

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

すべてに一致

ソースを表示

• object ChannelId

  チャネル識別子。

{
    "allOf":[
        {
            "$ref":"#/definitions/ChannelId"
        }
    ]
}

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

型: object

チャネル識別子。

ソースを表示

• id(optional): string

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

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

• name(optional): string

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

{
    "description":"<p>Channel identifier.</p>",
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short unique human-readable name to identify the channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

識別子: action

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

すべてに一致

ソースを表示

• object SingularResource

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

• object SiteJobStatus-allOf[1]

{
    "description":"<p>Background job details for site jobs.</p>",
    "discriminator":"action",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "action":{
                    "description":"<p>Type of <em>Site Job Status</em>. Valid values are: <code></code>, <code>translate</code>, <code>copy</code>, <code>publish</code>, <code>importTranslations</code>, <code>hardDelete</code>, <code>copyTheme</code>, <code>copyComponent</code>, <code>refresh</code>, <code>publishTheme</code>.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "context":{
                    "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "startTime":{
                    "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "endTime":{
                    "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "progress":{
                    "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completed":{
                    "description":"<p>Whether the asynchronous job is completed or not.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "requestStatus":{
                    "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "message":{
                    "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
                    "x-multiLingual":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completedPercentage":{
                    "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "intervalToPoll":{
                    "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "error":{
                    "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"object"
                },
                "result":{
                    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/HttpResponse"
                        }
                    ]
                }
            }
        }
    ]
}

ネストされたスキーマ : SiteJobStatus-allOf[1]

型: object

ソースを表示

• action(optional): string

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

• completed(optional): boolean

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

• completedPercentage(optional): integer(int32)

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

• context(optional): string

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

• endTime(optional): string(date-time)

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

• error(optional): object error

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

• intervalToPoll(optional): integer(int64)

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

• message(optional): string

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

• progress(optional): string

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

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

  • pending - リクエストは実行を待機しています
  • processing - リクエストは実行中です
  • succeeded - リクエストは正常に完了しました
  • failed - リクエストに失敗しました

  処理リクエストが完了する前に失敗しました。

  • aborted - リクエストは中断されました

  処理リクエストが完了する前に中止されました。

  • paused - リクエストは実行中でしたが、現在は一時停止しています
  • blocked - リクエストはブロックされています

  リクエストには、人の承認を待機するなどのアクションが必要です。

• requestStatus(optional): integer(int32)

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

• result(optional): result

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

• startTime(optional): string(date-time)

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

{
    "properties":{
        "action":{
            "description":"<p>Type of <em>Site Job Status</em>. Valid values are: <code></code>, <code>translate</code>, <code>copy</code>, <code>publish</code>, <code>importTranslations</code>, <code>hardDelete</code>, <code>copyTheme</code>, <code>copyComponent</code>, <code>refresh</code>, <code>publishTheme</code>.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "context":{
            "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "progress":{
            "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completed":{
            "description":"<p>Whether the asynchronous job is completed or not.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "requestStatus":{
            "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completedPercentage":{
            "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "intervalToPoll":{
            "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "error":{
            "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object"
        },
        "result":{
            "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/HttpResponse"
                }
            ]
        }
    }
}

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

型: object

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

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

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

すべてに一致

ソースを表示

• object HttpResponse

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

{
    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/HttpResponse"
        }
    ]
}

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

型: object

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

ソースを表示

• headers(optional): array headers

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

• status (オプション): object status

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

{
    "description":"<p>Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.</p>",
    "properties":{
        "status":{
            "description":"<p>HTTP status code response value and reason.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "code":{
                    "description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "reason":{
                    "description":"<p>Short, human-readable summary of the status code.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            },
            "required":[
                "code",
                "reason"
            ]
        },
        "headers":{
            "description":"<p>HTTP response headers.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"<p>Header name.</p>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "value":{
                        "description":"<p>Header value.</p>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    }
                },
                "required":[
                    "name"
                ]
            }
        }
    }
}

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

型: array

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

ソースを表示

• Array of: object items

{
    "description":"<p>HTTP response headers.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"<p>Header name.</p>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "value":{
                "description":"<p>Header value.</p>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            }
        },
        "required":[
            "name"
        ]
    }
}

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

型: object

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

ソースを表示

• code: integer(int32)

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

• reason: string

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

{
    "description":"<p>HTTP status code response value and reason.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "code":{
            "description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "reason":{
            "description":"<p>Short, human-readable summary of the status code.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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

型: object

ソースを表示

• name: string

  ヘッダー名。

• value(optional): string

  ヘッダー値。

{
    "type":"object",
    "properties":{
        "name":{
            "description":"<p>Header name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "value":{
            "description":"<p>Header value.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "name"
    ]
}

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

型: array

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

リリース19.4.1.での導入。

ソースを表示

• Array of: object items

{
    "description":"<p>Collection of <em>Site Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "role":{
                "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "role",
            "type",
            "name"
        ]
    }
}

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

型: object

ソースを表示

• displayName(optional): string

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

  リリース19.4.1.での導入。
• group(optional): グループ

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

  リリース19.4.1.での導入。
• groupType(optional): string

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

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

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

  リリース20.1.1で導入されました。
• id: string

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

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

  リリース19.4.1.での導入。
• isExternalUser(optional): boolean

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

  リリース21.10.2で導入されました。
• name: string

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

  リリース19.4.1.での導入。
• role: string

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

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

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

  リリース19.4.1.での導入。
• type: string

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

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

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

  クライアント・アプリケーションであるメンバー。

  • group - メンバーはグループです

  リリース19.4.1.での導入。
• user(optional): user

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

  リリース19.4.1.での導入。

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "role":{
            "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "role",
        "type",
        "name"
    ]
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• allOf Group

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

  リリース19.3.1.での導入。

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

ネストされたスキーマ : 注釈

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : 会話

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

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

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ユーザーが持つ共有リンク・アクセス権のセット。

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

• read - 共有リンクの読取りおよびリスト
• create - 共有リンクの作成
• update - 共有リンクの更新
• delete - 共有リンクの削除

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

すべてに一致

ソースを表示

• object 「リンク」

  REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

ネストされたスキーマ : リポジトリ

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

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

すべてに一致

ソースを表示

• object SingularResource

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

• object Repository-allOf[1]

{
    "description":"<p>Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.</p><p>A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "minimal",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Short human-readable name to identify the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "description":{
                    "description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "createdBy":{
                    "description":"<p>User that created the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "createdDate":{
                    "description":"<p>Date and time the repository was created.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "updatedBy":{
                    "description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "updatedDate":{
                    "description":"<p>Date and time the repository was last updated.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/DateTimeZone"
                        }
                    ]
                },
                "autoTagEnabled":{
                    "description":"<p>Whether auto tagging is enabled for the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "contentTypes":{
                    "description":"<p>Content types associated with the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ContentTypeId"
                            }
                        ]
                    }
                },
                "channels":{
                    "description":"<p>Channels associated with the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ChannelId"
                            }
                        ]
                    }
                },
                "defaultLanguage":{
                    "description":"<p>Default language of the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "languageOptions":{
                    "description":"<p>Language options for the repository.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "roleName":{
                    "description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : Repository-allOf[1]

型: object

ソースを表示

• autoTagEnabled(optional): boolean

  リポジトリに対して自動タグ付けを有効にするかどうか。

• channels(optional): array channels

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

• contentTypes(optional): array contentTypes

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

• createdBy(optional): string

  リポジトリを作成したユーザー。

• createdDate(optional): createdDate

  リポジトリの作成日時。

• defaultLanguage(optional): string

  リポジトリのデフォルト言語。

• description(optional): string

  コンシューマにこのリポジトリに含まれる内容を伝えるために、管理者がリポジトリについて説明します。

• id(optional): string

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

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

• languageOptions(optional): array languageOptions

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

• name(optional): string

  リポジトリを識別するための判読可能な短い名前。

• roleName(optional): string

  認証されたユーザーがリポジトリ内に持つロール。

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

  • owner - リソースの所有者
  • custom - カスタム・ロール
  • manager - マネージャ・ロール
  • contributor - コントリビュータ・ロール
  • downloader - ダウンロード機能
  • viewer - ビューア・ロール

• updatedBy(optional): string

  最後にリポジトリを更新したユーザー。 リポジトリが更新されていない場合、更新者はリポジトリを作成したユーザーになります。

• updatedDate(optional): updatedDate

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

{
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "minimal",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short human-readable name to identify the repository.</p>",
            "x-returnedIn":[
                "representation",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Human-readable description of the repository to give consumers an idea of what content this repository contains.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "createdBy":{
            "description":"<p>User that created the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "createdDate":{
            "description":"<p>Date and time the repository was created.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "updatedBy":{
            "description":"<p>User that last updated the repository. If the repository has not been updated the updated by will be the user that created the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "updatedDate":{
            "description":"<p>Date and time the repository was last updated.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/DateTimeZone"
                }
            ]
        },
        "autoTagEnabled":{
            "description":"<p>Whether auto tagging is enabled for the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "contentTypes":{
            "description":"<p>Content types associated with the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ContentTypeId"
                    }
                ]
            }
        },
        "channels":{
            "description":"<p>Channels associated with the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ChannelId"
                    }
                ]
            }
        },
        "defaultLanguage":{
            "description":"<p>Default language of the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "languageOptions":{
            "description":"<p>Language options for the repository.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "description":"<p>The role the authenticated user has within the repository.</p><p>Valid values are:\n<ul><li> <code>owner</code> - Owner of the resource</li><li> <code>custom</code> - Custom role</li><li> <code>manager</code> - Manager role</li><li> <code>contributor</code> - Contributor role</li><li> <code>downloader</code> - Downloader role</li><li> <code>viewer</code> - Viewer role</li></p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        }
    }
}

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

型: array

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

ソースを表示

• Array of: items

{
    "description":"<p>Channels associated with the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ChannelId"
            }
        ]
    }
}

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

型: array

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

ソースを表示

• Array of: items

{
    "description":"<p>Content types associated with the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ContentTypeId"
            }
        ]
    }
}

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

リポジトリの作成日時。

すべてに一致

ソースを表示

• object DateTimeZone

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

{
    "description":"<p>Date and time the repository was created.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

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

型: array

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

ソースを表示

• Array of: string

{
    "description":"<p>Language options for the repository.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

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

すべてに一致

ソースを表示

• object DateTimeZone

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

{
    "description":"<p>Date and time the repository was last updated.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/DateTimeZone"
        }
    ]
}

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

すべてに一致

ソースを表示

• object ChannelId

  チャネル識別子。

{
    "allOf":[
        {
            "$ref":"#/definitions/ChannelId"
        }
    ]
}

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

すべてに一致

ソースを表示

• object ContentTypeId

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ContentTypeId"
        }
    ]
}

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

型: object

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

ソースを表示

• name(optional): string

  コンテンツ・タイプ名。

{
    "description":"<p>Content type identifier.</p>",
    "properties":{
        "name":{
            "description":"<p>Content type name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

識別子: requestType

リクエストは、処理前に承認を必要とする操作を表します。 リクエストの例は、新規サイトの作成のリクエストです。 リクエストは却下することもできます。 リクエストは、1つ以上の「レビュー」をリクエストに追加することで承認または却下されます。 リクエストが作成されると、リクエストの承認または拒否ステータスに影響するレビューの追加とは別に変更できません。 有効でなくなったリクエストは削除できます。 リクエストが否認された場合、新しいリクエストを作成する必要があります。 リクエストが承認されると、リクエストにレビューを追加できなくなります。 否認されたリクエストは、そのリクエストを承認するレビューを作成することによって承認できます。 サイト・ガバナンスが無効になっている場合、リクエストは失敗します。

すべてに一致

ソースを表示

• object SingularResource

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

• object Request-allOf[1]

{
    "description":"<p>A request represents an operation that needs approval before being fulfilled. An example request is a request for a new site to be created. A request can also be rejected. A request is approved or rejected by adding one or more <em>reviews</em> to the request. Requests, once created, cannot change apart from adding reviews that affect the approval or rejected status of the request. A request that is no longer valid can be deleted. If a request is rejected, then a new request needs to be created. Once a request is approved no further reviews can be added to the request. A rejected request can still be approved by creating a review that approves the request. Requests will fail if site governance is disabled.</p>",
    "discriminator":"requestType",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "requestType":{
                    "description":"<p>Type of <em>Request</em>. Valid values are: <code>SiteRequest</code>, <code>CopySiteRequest</code>.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "id":{
                    "description":"<p>Globally unique immutable identifier for a request.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "minimal",
                        "basic",
                        "default"
                    ],
                    "type":"string"
                },
                "isDeleted":{
                    "description":"<p>Indicates that the request is has been marked as soft deleted.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "justification":{
                    "description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "reviews":{
                    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Review</em> elements.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Review"
                                    }
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "status":{
                    "description":"<p>Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "job":{
                    "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "properties":{
                        "links":{
                            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Link"
                                    }
                                ]
                            }
                        },
                        "context":{
                            "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"string"
                        },
                        "startTime":{
                            "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string",
                            "format":"date-time"
                        },
                        "endTime":{
                            "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string",
                            "format":"date-time"
                        },
                        "progress":{
                            "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string"
                        },
                        "completed":{
                            "description":"<p>Whether the asynchronous job is completed or not.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"boolean"
                        },
                        "requestStatus":{
                            "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int32"
                        },
                        "message":{
                            "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
                            "x-multiLingual":true,
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"string"
                        },
                        "completedPercentage":{
                            "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int32"
                        },
                        "intervalToPoll":{
                            "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"integer",
                            "format":"int64"
                        },
                        "error":{
                            "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"object"
                        },
                        "result":{
                            "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "allOf":[
                                {
                                    "$ref":"#/definitions/HttpResponse"
                                }
                            ]
                        }
                    },
                    "required":[
                        "progress",
                        "completed"
                    ]
                },
                "failure":{
                    "description":"<p>If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"object"
                },
                "createdBy":{
                    "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "createdAt":{
                    "description":"<p>Date and time the request was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "lastModifiedAt":{
                    "description":"<p>Date and time the request was last updated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "original":{
                    "description":"<p>Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This <em>forked</em> request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.</p>",
                    "x-returnedIn":[
                        "representation"
                    ],
                    "type":"string"
                },
                "revision":{
                    "description":"<p>Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "policy":{
                    "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Policy"
                        }
                    ]
                },
                "approvers":{
                    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
                    "x-queryable":true,
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                }
            }
        }
    ]
}

ネストされたスキーマ : Request-allOf[1]

型: object

ソースを表示

• approvers(optional): object approvers

  このリクエストを承認する権限を持つユーザーおよびグループのリスト。 承認タイプが「指定された承認者」でない場合、承認リストは空になります。

  リリース19.3.3.での導入。
• createdAt(optional): string(date-time)

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

• createdBy(optional): createdBy

  リクエストを作成したユーザーまたはクライアント・アプリケーションを取得します。 リクエストが作成されると、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションが取得され、そのリクエストに関連付けられます。

• failure(optional): object failure

  リクエスト処理が失敗した場合、失敗の詳細がこのプロパティに表示されます。 リクエストが失敗としてマークされていない場合、失敗の詳細はありません。

• id(optional): string

  リクエストのグローバルに一意の不変識別子。

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

• isDeleted(オプション): boolean

  リクエストがソフト削除済としてマークされていることを示します。

• job(optional): object job

  リクエストが承認されると、リクエストに必要な処理がすべて開始されます。たとえば、新規サイトへのリクエストでは、サイト作成処理が開始されます。 この処理の進行状況は、ジョブ・ステータスの詳細によって監視できます。 ジョブ・ステータスは常にリクエストに対して使用可能です。リクエストが承認されていない場合、ステータスはリクエストがblockedであることを示します。 - 承認待ちのブロック。 完了したリクエストには、ジョブ・ステータス(completed)もあります。

• justification(optional): string
  最大長: 1000

  理由は、承認者がこのリクエストをレビューするのに役立ちます。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。

• lastModifiedAt(optional): string(date-time)

  リクエストが最後に更新された日時。 日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

• original(optional): string

  リクエストが編集されたリクエストのフォークである場合の元のリクエスト。 リクエストが更新され、リクエストが失敗または却下されると、リクエストおよび関連付けられたレビューがコピーされ、更新されたリクエストにリンクされます。 この「分岐済」リクエストは、リクエストの詳細および編集時にリクエストに関連付けられていたレビューを取得します。 複数の更新が実行される場合、分岐された複数のコピーがある可能性があります。各分岐は元のリクエストにリンクされます。 分岐したリクエストには、編集中の元のリクエストと同じIdを保持しているため、新しい識別子が付けられています。

• policy(optional): policy

  リクエストが行われた時点でのこのリクエストのポリシー詳細のすべてのスナップショット。 これにより、このリクエストに必要な承認を判断できます。

  リリース19.2.1.での導入。
• requestType(optional): string

  「リクエスト」のタイプ。 有効な値は次のとおりです: SiteRequest、CopySiteRequest。

• reviews(optional): object reviews

  リクエストに関連するレビュー。 リクエストに手動承認が必要な場合、このプロパティには、このリクエストに関連付けられているレビューのセットが反映されます。 リクエストが最初に作成された場合、レビューはありません。

• revision(optional): integer(int64)

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

• status(optional): string

  このリクエストの承認または拒否のステータス。 リクエストのステータスには、関連付けられたレビューがまだ作成、承認または却下されていないかが反映されます。

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

  • pending - リクエストは承認待ちです
  • rejected - リクエストは承認されていません
  • approved - リクエストが承認されました
  • failed - リクエストは承認されましたが、リクエストの処理に失敗しました
  • complete - リクエストは承認され、現在完了しています

{
    "properties":{
        "requestType":{
            "description":"<p>Type of <em>Request</em>. Valid values are: <code>SiteRequest</code>, <code>CopySiteRequest</code>.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "id":{
            "description":"<p>Globally unique immutable identifier for a request.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "minimal",
                "basic",
                "default"
            ],
            "type":"string"
        },
        "isDeleted":{
            "description":"<p>Indicates that the request is has been marked as soft deleted.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "justification":{
            "description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "reviews":{
            "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Review</em> elements.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Review"
                            }
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "status":{
            "description":"<p>Approval or rejection status of this request. The status of the request reflects whether the associated reviews are not yet created, approved or rejected.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is pending approval</li><li> <code>rejected</code> - Request has not been approved</li><li> <code>approved</code> - Request has been approved</li><li> <code>failed</code> - Request has been approved but failed during the request processing</li><li> <code>complete</code> - Request has been approved and is now complete</li></p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "job":{
            "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "properties":{
                "links":{
                    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Link"
                            }
                        ]
                    }
                },
                "context":{
                    "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "startTime":{
                    "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "endTime":{
                    "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "progress":{
                    "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completed":{
                    "description":"<p>Whether the asynchronous job is completed or not.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "requestStatus":{
                    "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "message":{
                    "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
                    "x-multiLingual":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completedPercentage":{
                    "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "intervalToPoll":{
                    "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "error":{
                    "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"object"
                },
                "result":{
                    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/HttpResponse"
                        }
                    ]
                }
            },
            "required":[
                "progress",
                "completed"
            ]
        },
        "failure":{
            "description":"<p>If the request processing has failed, the details of the failure will be available in this property. If the request is not marked as failed, there will be no failure details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object"
        },
        "createdBy":{
            "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "createdAt":{
            "description":"<p>Date and time the request was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedAt":{
            "description":"<p>Date and time the request was last updated. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "original":{
            "description":"<p>Original request if the request is a fork of an edited request. If a request is updated, and the request is failed or rejected, the request and associated reviews are copied and linked to the updated request. This <em>forked</em> request captures the details of the request and any reviews that were associated with the request at the time of editing. If multiple updates are performed there may be multiple forked copies, each fork is linked to the original request. Forked requests are given new identifiers as the original request being edited maintains the same identity.</p>",
            "x-returnedIn":[
                "representation"
            ],
            "type":"string"
        },
        "revision":{
            "description":"<p>Every time a request is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a request has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "policy":{
            "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Policy"
                }
            ]
        },
        "approvers":{
            "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-expandable":true,
            "x-returnedIn":[
                "representation"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        }
    }
}

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

型: object

このリクエストを承認する権限を持つユーザーおよびグループのリスト。 承認タイプが「指定された承認者」でない場合、承認リストは空になります。

リリース19.3.3.での導入。

ソースを表示

• items: array items

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

  リリース19.3.3.での導入。

{
    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-queryable":true,
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

• allOf CollectionResource

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

{
    "description":"<p>List of users and groups who have the ability to approve this request. The approval list will be empty if the approval type is not <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-queryable":true,
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

リクエストを作成したユーザーまたはクライアント・アプリケーションを取得します。 リクエストが作成されると、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションが取得され、そのリクエストに関連付けられます。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>Get the user or client application that created the request. When a request is created, the authenticated user or client application is captured and associated with the request.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

ネストされたスキーマ : 失敗

型: object

リクエスト処理が失敗した場合、失敗の詳細がこのプロパティに表示されます。 リクエストが失敗としてマークされていない場合、失敗の詳細はありません。

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

型: object

リクエストが承認されると、リクエストに必要な処理がすべて開始されます。たとえば、新規サイトへのリクエストでは、サイト作成処理が開始されます。 この処理の進行状況は、ジョブ・ステータスの詳細によって監視できます。 ジョブ・ステータスは常にリクエストに対して使用可能です。リクエストが承認されていない場合、ステータスはリクエストがblockedであることを示します。 - 承認待ちのブロック。 完了したリクエストには、ジョブ・ステータス(completed)もあります。

ソースを表示

• completed: boolean

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

• completedPercentage(optional): integer(int32)

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

• context(optional): string

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

• endTime(optional): string(date-time)

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

• error(optional): object error

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

• intervalToPoll(optional): integer(int64)

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

• links(optional): array links

  このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

• message(optional): string

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

• progress: string

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

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

  • pending - リクエストは実行を待機しています
  • processing - リクエストは実行中です
  • succeeded - リクエストは正常に完了しました
  • failed - リクエストに失敗しました

  処理リクエストが完了する前に失敗しました。

  • aborted - リクエストは中断されました

  処理リクエストが完了する前に中止されました。

  • paused - リクエストは実行中でしたが、現在は一時停止しています
  • blocked - リクエストはブロックされています

  リクエストには、人の承認を待機するなどのアクションが必要です。

• requestStatus(optional): integer(int32)

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

• result(optional): result

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

• startTime(optional): string(date-time)

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

{
    "description":"<p>When a request is approved, any processing required by the request will be initiated, for example a request for a new site would start the site creation processing. The progress of this processing can be monitored by the job status details. The job status is always available for a request, if the request has not been approved then the status will indicate that the request is <code>blocked</code> - blocked waiting for approval. A completed request will also have a job status that is <code>completed</code>.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "context":{
            "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "progress":{
            "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completed":{
            "description":"<p>Whether the asynchronous job is completed or not.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "requestStatus":{
            "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completedPercentage":{
            "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "intervalToPoll":{
            "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "error":{
            "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object"
        },
        "result":{
            "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/HttpResponse"
                }
            ]
        }
    },
    "required":[
        "progress",
        "completed"
    ]
}

ネストしたスキーマ: policy

リクエストが行われた時点でのこのリクエストのポリシー詳細のすべてのスナップショット。 これにより、このリクエストに必要な承認を判断できます。

リリース19.2.1.での導入。

すべてに一致

ソースを表示

• allOf Policy

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

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

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

{
    "description":"<p>Snapshot of all the policy details for this request at the time the request was made. This can be used to determine what approval this request requires, for example.</p><small>Introduced in release 19.2.1.</small>",
    "x-queryable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Policy"
        }
    ]
}

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

型: object

リクエストに関連するレビュー。 リクエストに手動承認が必要な場合、このプロパティには、このリクエストに関連付けられているレビューのセットが反映されます。 リクエストが最初に作成された場合、レビューはありません。

ソースを表示

• items: array items

  「確認」要素のコレクション。

{
    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Review</em> elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Review"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

• allOf CollectionResource

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

{
    "description":"<p>Reviews associated with the request. If the request requires manual approval, this property reflects the set of reviews that have been associated with this request. When a request is first created there will be no reviews.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Review</em> elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Review"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

型: array

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

リリース19.3.3.での導入。

ソースを表示

• Array of: object items

{
    "description":"<p>Collection of <em>Request Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

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

型: object

ソースを表示

• displayName(optional): string

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

  リリース19.3.3.での導入。
• group(optional): グループ

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

  リリース19.3.3.での導入。
• groupType(optional): string

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

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

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

  リリース20.1.1で導入されました。
• id: string

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

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

  リリース19.3.3.での導入。
• isExternalUser(optional): boolean

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

  リリース21.10.2で導入されました。
• name: string

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

  リリース19.3.3.での導入。
• type: string

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

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

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

  クライアント・アプリケーションであるメンバー。

  • group - メンバーはグループです

  リリース19.3.3.での導入。
• user(optional): user

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

  リリース19.3.3.での導入。

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

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

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

リリース19.3.3.での導入。

すべてに一致

ソースを表示

• allOf Group

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

  リリース19.3.1.での導入。

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

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

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

リリース19.3.3.での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

型: object

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

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

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

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

すべてに一致

ソースを表示

• object HttpResponse

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

{
    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/HttpResponse"
        }
    ]
}

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

すべてに一致

ソースを表示

• object 「リンク」

  REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

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

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

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

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

すべてに一致

ソースを表示

• object SingularResource

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

• object Policy-allOf[1]

{
    "description":"<p>A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.</p><p>A policy is associated with a resource, for example a <em>site creation</em> policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.</p><p>A policy can be marked as <em>inactive</em> which prevents the operation from being performed or requested.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Globally unique identifier for a policy.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "minimal",
                        "basic"
                    ],
                    "type":"string"
                },
                "status":{
                    "description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "approvalType":{
                    "description":"<p>When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "approvers":{
                    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "accessType":{
                    "description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"string"
                },
                "access":{
                    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "security":{
                    "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SecurityPolicy"
                        }
                    ]
                },
                "repository":{
                    "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Repository"
                        }
                    ]
                },
                "localizationPolicyAllowed":{
                    "description":"<p>If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "sitePrefixAllowed":{
                    "description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "type":"boolean"
                },
                "expiration":{
                    "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteExpirationPeriod"
                        }
                    ]
                },
                "revision":{
                    "description":"<p>Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

ネストされたスキーマ : Policy-allOf[1]

型: object

ソースを表示

• access(optional): object access

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

  リリース19.3.1.での導入。
• accessType(optional): string

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

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

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

  リリース19.3.1.での導入。
• approvalType(optional): string

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

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

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

• approvers(optional): object approvers

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

  リリース19.3.3.での導入。
• expiration(optional): 有効期限

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

  リリース19.4.1.での導入。
• id(optional): string

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

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

• localizationPolicyAllowed(optional): boolean

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

  リリース19.2.3.での導入。
• repository(optional): repository

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

  リリース19.2.3.での導入。
• revision(optional): integer(int64)

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

• security(optional): security

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

• sitePrefixAllowed(optional): boolean

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

  リリース19.2.3.での導入。
• status(optional): string

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

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

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

{
    "properties":{
        "id":{
            "description":"<p>Globally unique identifier for a policy.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "minimal",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is <em>inactive</em> then the operation cannot be performed. If the policy status is <em>active</em> then the operation can be performed. For example, for a policy associated with a site template, a status of <em>active</em> means that users can create sites from that site template.</p><p>Valid values are:\n<ul><li> <code>inactive</code> - Policy that is marked as inactive means the associated operation <strong>cannot</strong> be requested</li><li> <code>active</code> - Policy that is marked as active means the associated operation <strong>can</strong> be requested</li></p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "approvalType":{
            "description":"<p>When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.</p><p>Valid values are:\n<ul><li> <code>automatic</code> - A request will automatically be approved without any human approval process involved</li><li> <code>admin</code> - Any user with the <strong>site administrator</strong> role can approve the associated request</li><li> <code>named</code> - Site creation will require approval from one user that is a member of the approvers list associated with the policy</li></p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "approvers":{
            "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "accessType":{
            "description":"<p>Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.</p><p>Valid values are:\n<ul><li> <code>everyone</code> - Policy, when active, is applicable to everyone</li><li> <code>restricted</code> - Policy, when active, is applicable to users that are part of the access list</li></p><small>Introduced in release 19.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"string"
        },
        "access":{
            "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "security":{
            "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SecurityPolicy"
                }
            ]
        },
        "repository":{
            "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Repository"
                }
            ]
        },
        "localizationPolicyAllowed":{
            "description":"<p>If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "sitePrefixAllowed":{
            "description":"<p>If <code>true</code>, a request for a new site can include an explicit site prefix. If <code>false</code>, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "type":"boolean"
        },
        "expiration":{
            "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteExpirationPeriod"
                }
            ]
        },
        "revision":{
            "description":"<p>Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong <code>ETag</code> value for this resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: object

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

リリース19.3.1.での導入。

ソースを表示

• items: array items

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

  リリース19.3.1.での導入。

{
    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

• allOf CollectionResource

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

{
    "description":"<p>List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the <code>accessType</code> of the policy is set to <code>restricted</code>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

型: object

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

リリース19.3.3.での導入。

ソースを表示

• items: array items

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

  リリース19.3.3.での導入。

{
    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

• allOf CollectionResource

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

{
    "description":"<p>List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to <em>named approvers</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• object SiteExpirationPeriod

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

  リリース19.4.1.での導入。

{
    "description":"<p>When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteExpirationPeriod"
        }
    ]
}

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

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

リリース19.2.3.での導入。

すべてに一致

ソースを表示

• allOf Repository

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

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

{
    "description":"<p>When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.</p><small>Introduced in release 19.2.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Repository"
        }
    ]
}

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

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

すべてに一致

ソースを表示

• object SecurityPolicy

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

{
    "description":"<p>Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.</p>",
    "x-returnedIn":[
        "representation",
        "default"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SecurityPolicy"
        }
    ]
}

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

型: array

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

リリース19.3.1.での導入。

ソースを表示

• Array of: object items

{
    "description":"<p>Collection of <em>Policy Access Member</em> elements.</p><small>Introduced in release 19.3.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

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

型: object

ソースを表示

• displayName(optional): string

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

  リリース19.3.1.での導入。
• group(optional): グループ

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

  リリース19.3.1.での導入。
• groupType(optional): string

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

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

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

  リリース20.1.1で導入されました。
• id: string

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

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

  リリース19.3.1.での導入。
• isExternalUser(optional): boolean

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

  リリース21.10.2で導入されました。
• name: string

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

  リリース19.3.1.での導入。
• type: string

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

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

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

  クライアント・アプリケーションであるメンバー。

  • group - メンバーはグループです

  リリース19.3.1.での導入。
• user(optional): user

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

  リリース19.3.1.での導入。

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

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

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

リリース19.3.1.での導入。

すべてに一致

ソースを表示

• allOf Group

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

  リリース19.3.1.での導入。

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

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

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

リリース19.3.1.での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

型: array

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

リリース19.3.3.での導入。

ソースを表示

• Array of: object items

{
    "description":"<p>Collection of <em>Policy Approvers Member</em> elements.</p><small>Introduced in release 19.3.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "type",
            "name"
        ]
    }
}

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

型: object

ソースを表示

• displayName(optional): string

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

  リリース19.3.3.での導入。
• group(optional): グループ

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

  リリース19.3.3.での導入。
• groupType(optional): string

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

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

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

  リリース20.1.1で導入されました。
• id: string

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

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

  リリース19.3.3.での導入。
• isExternalUser(optional): boolean

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

  リリース21.10.2で導入されました。
• name: string

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

  リリース19.3.3.での導入。
• type: string

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

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

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

  クライアント・アプリケーションであるメンバー。

  • group - メンバーはグループです

  リリース19.3.3.での導入。
• user(optional): user

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

  リリース19.3.3.での導入。

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.3.3.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.3.3.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "type",
        "name"
    ]
}

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

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

リリース19.3.3.での導入。

すべてに一致

ソースを表示

• allOf Group

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

  リリース19.3.1.での導入。

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

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

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

リリース19.3.3.での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.3.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

型: object

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

リリース19.4.1.での導入。

ソースを表示

• amount(optional): integer(int32)

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

  リリース19.4.1.での導入。
• unit(オプション): string

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

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

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

  リリース19.4.1.での導入。

{
    "description":"<p>Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.</p><small>Introduced in release 19.4.1.</small>",
    "properties":{
        "amount":{
            "description":"<p>Amount of time used to measure site expiration.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "unit":{
            "description":"<p>Unit of time used to measure site expiration.</p><p>Valid values are:\n<ul><li> <code>months</code> - Expiration expressed in the number of months</li><li> <code>years</code> - Expiration expressed in the number of years</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

型: object

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

ソースを表示

• appliesTo(optional): string

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

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

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

• level(optional): string

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

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

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

{
    "description":"<p>The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.</p>",
    "properties":{
        "level":{
            "description":"<p>Maximum open security level that can be set on a site.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "appliesTo":{
            "description":"<p>Define which types of users may access a site. Can include all users or be restricted to named users only.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

型: array

「確認」要素のコレクション。

ソースを表示

• Array of: items

{
    "description":"<p>Collection of <em>Review</em> elements.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Review"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• allOf Review

  レビューとは、リクエストの承認または却下を目的とした人間が開始したレビューです。 レビューは、リクエスト元がリクエストを承認または却下した理由を理解するために使用できるオプションのコメントとともに、リクエストを承認または却下します。 リクエストに関連付けられている承認のタイプに応じて、ゼロ以上のレビューが必要になる場合があります。 たとえば、「自動承認」リクエストではレビューは不要です。 「管理者承認」では、リクエストをレビューするには1人の管理者が必要です。

{
    "allOf":[
        {
            "$ref":"#/definitions/Review"
        }
    ]
}

ネストされたスキーマ : 確認

レビューとは、リクエストの承認または却下を目的とした人間が開始したレビューです。 レビューは、リクエスト元がリクエストを承認または却下した理由を理解するために使用できるオプションのコメントとともに、リクエストを承認または却下します。 リクエストに関連付けられている承認のタイプに応じて、ゼロ以上のレビューが必要になる場合があります。 たとえば、「自動承認」リクエストではレビューは不要です。 「管理者承認」では、リクエストをレビューするには1人の管理者が必要です。

すべてに一致

ソースを表示

• object SingularResource

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

• object Review-allOf[1]

{
    "description":"<p>A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, <em>auto approved</em> requests do not need a review. An <em>administrator approval</em> requires one administrator to review the request.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "decision":{
                    "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "comment":{
                    "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "createdAt":{
                    "description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "reviewedBy":{
                    "description":"<p>Get the details of the user or client application that created the review.</p>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                }
            }
        }
    ]
}

ネストされたスキーマ : Review-allOf[1]

型: object

ソースを表示

• comment(optional): string
  最大長: 1000

  レビューに関連付けられたコメントは、リクエストが承認または却下された理由を説明するために使用できます。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。

• createdAt(optional): string(date-time)

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

• decision(optional): string

  このレビューの結果で、リクエストを承認または否認します。

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

  • approved - 関連リクエストが承認されました
  • rejected - 関連リクエストは却下されました

• id(optional): integer(int32)

  レビューのリクエスト・スコープ指定識別子。 レビュー識別子は、レビューが作成されるときにシステムによって生成され、変更できません。 識別子は、親リクエストのスコープ内でのみ一意です。 最新のレビューの識別子値は小さくなります。

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

• reviewedBy(optional): reviewedBy

  レビューを作成したユーザーまたはクライアント・アプリケーションの詳細を取得します。

{
    "properties":{
        "id":{
            "description":"<p>Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "decision":{
            "description":"<p>Outcome of this review, either approve or reject the request.</p><p>Valid values are:\n<ul><li> <code>approved</code> - Associated request is approved</li><li> <code>rejected</code> - Associated request is rejected</li></p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "comment":{
            "description":"<p>A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "createdAt":{
            "description":"<p>Date and time that the review was created. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "reviewedBy":{
            "description":"<p>Get the details of the user or client application that created the review.</p>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        }
    }
}

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

レビューを作成したユーザーまたはクライアント・アプリケーションの詳細を取得します。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>Get the details of the user or client application that created the review.</p>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

型: object

サイトおよびセキュリティ・ポリシーのセキュリティ・レベルを定義します。 アクセス・レベルを、ポリシーに必要な最小レベルより低いレベルに設定することはできません。 「サイト管理者」のみがサイトのセキュリティ・ポリシーを変更できます。

ソースを表示

• access(optional): array access

  サイトが保護されているアクセス・レベルのセット。 ポリシーの制限に従い、サイトのマネージャが変更できます。 パブリック・サイトには、everyoneの値のみが含まれます。

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

  • named - 選択した名前付きユーザー
  • service - すべてのサービス・ユーザー
  • visitors - すべてのサービス・ビジター
  • cloud - ドメインにサインインするすべてのクラウド・ユーザー
  • everyone - サインインせずに誰でも

• policy(optional): policy

  サイト管理者によって設定された、サイトで必要なセキュリティの最小レベル。 サイトのアクセス・レベルを必要最小限のレベル以下に設定できません。 サイトのマネージャは、制限されたアクセスがあればそれ以上適用できます。

{
    "description":"<p>Defines the security level of a site and security policy. The access levels cannot be be set to below the minimum levels required by the policy. Only <strong>site administrators</strong> can change the security policy of a site.</p>",
    "properties":{
        "policy":{
            "description":"<p>The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SecurityPolicy"
                }
            ]
        },
        "access":{
            "description":"<p>The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.</p><p>Valid values are:\n<ul><li> <code>named</code> - Selected named users</li><li> <code>service</code> - All service users</li><li> <code>visitors</code> - All service visitors</li><li> <code>cloud</code> - All cloud users who sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

サイトが保護されているアクセス・レベルのセット。 ポリシーの制限に従い、サイトのマネージャが変更できます。 パブリック・サイトには、everyoneの値のみが含まれます。

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

• named - 選択した名前付きユーザー
• service - すべてのサービス・ユーザー
• visitors - すべてのサービス・ビジター
• cloud - ドメインにサインインするすべてのクラウド・ユーザー
• everyone - サインインせずに誰でも

ソースを表示

• Array of: string

{
    "description":"<p>The set of access levels the site is secured by. Can be changed by the managers of the site, subject to the restrictions of the policy. A public site will just contain the value of 'everyone'.</p><p>Valid values are:\n<ul><li> <code>named</code> - Selected named users</li><li> <code>service</code> - All service users</li><li> <code>visitors</code> - All service visitors</li><li> <code>cloud</code> - All cloud users who sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: policy

サイト管理者によって設定された、サイトで必要なセキュリティの最小レベル。 サイトのアクセス・レベルを必要最小限のレベル以下に設定できません。 サイトのマネージャは、制限されたアクセスがあればそれ以上適用できます。

すべてに一致

ソースを表示

• object SecurityPolicy

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

{
    "description":"<p>The minimum level of security required by the site as set by the Site Admin. The access levels of the site cannot be set to below the minimum levels required. The managers of the site can apply more restricted access if they choose.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SecurityPolicy"
        }
    ]
}

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

型: object

サイト・ページのオプション。

URL検証チェックの無効化やサーバー側レンダリングの有効化などのページ固有のオプション。

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

ソースを表示

• ssrEnabled(optional): boolean

  サイト・ページの配信時にサーバー側レンダリング(SSR)を有効にします。

  *リリース23.12.1の新機能。
• ssrReady(optional): boolean

  サイト・ページを配信するためにサーバー側レンダリング(SSR)を有効にする準備ができているかどうか。

  *リリース23.12.1の新機能。
• urlValidationDisabled(optional): boolean

  サイト・ページの配信時に発生するページURL検証チェックを無効にします。

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

{
    "description":"<p>Site page options.</p><p>For page specific options such as disable url validation check or enable server side rendering.</p><small>Introduced in release 23.2.1.</small>",
    "properties":{
        "urlValidationDisabled":{
            "description":"<p>Disable the page url validation check that occurs when delivering a site page.</p><small>Introduced in release 23.2.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "ssrEnabled":{
            "description":"<p>Enable server side rendering (SSR) when delivering a site page.</p><small><span style=\"color: red;\">&#42; </span>New in release 23.12.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "ssrReady":{
            "description":"<p>Whether it is ready to enable server side rendering (SSR) for delivering a site page.</p><small><span style=\"color: red;\">&#42; </span>New in release 23.12.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

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

型: object

静的なサイト配信オプション。

静的サイト(つまり、コンパイル済サイト)の場合、これらのサイトがキャッシュされる期間と、サイト・コンパイルでサポートされるアダプティブ・モバイル・レイアウトのモバイル・ユーザー・アジェントが呼び出す時間。

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

ソースを表示

• cachingResponseHeaders(optional): string
  最大長: 2000

  レスポンス・ヘッダーをキャッシュしています。 デフォルトのキャッシュ・ヘッダーをオーバーライドするためにサイト・ページに追加されるヘッダー。 デフォルトでは、コンパイル済サイトはユーザー・ブラウザに300秒(5分)キャッシュされます。 これは、有効なCache-controlヘッダーを入力して上書きできます。 Akamaiが使用されている場合、Edge-Controlヘッダーを使用してAkamaiキャッシュ構成をオーバーライドできます。

  リリース20.3.3で導入されました。
• compileSite(optional): boolean

  サイトをコンパイルします。 サイトを静的サイト配信用にコンパイルする必要があります。

  リリース20.3.3で導入されました。
• mobileUserAgents(optional): string
  最大長: 2000

  モバイル・ユーザー・エージェント。 モバイル・ページを生成するユーザー・エージェントを指定するユーザー・エージェント部分文字列のカンマ区切りリスト。 サイトをコンパイルする際、モバイル・ページを作成してアダプティブ・レイアウトをサポートできます。 部分文字列の一部がブラウザのユーザー・エージェント文字列と一致した場合、モバイル・ページが提供されます。

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

{
    "description":"<p>Static site delivery options.</p><p>For static sites i.e. compiled sites how long these sites are cached and what mobile user-agents call for adaptive mobile layouts supported by site compilation.</p><small>Introduced in release 20.3.3.</small>",
    "properties":{
        "compileSite":{
            "description":"<p>Compile Site. Should the site be compiled for static site delivery.</p><small>Introduced in release 20.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "cachingResponseHeaders":{
            "description":"<p>Caching response headers. Additional headers which are added to a site's page to override the default caching headers. By default compiled sites are cached on a user's browser for 300 seconds (5 minutes). This can be overriden by entering a valid <code>Cache-control</code> header. If Akamai is used an <code>Edge-Control</code> header can be used to override the Akamai caching configuration. </p><small>Introduced in release 20.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":2000
        },
        "mobileUserAgents":{
            "description":"<p>Mobile user agents. Comma separated list of user-agent substrings to specify the user agents to generate mobile pages for. When compiling a site, mobile pages can be created to support adaptive layouts. If any part of the substring matches the browser's user-agent string, then the mobile pages are served. </p><small>Introduced in release 20.3.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":2000
        }
    }
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• object SingularResource

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

• object Theme-allOf[1]

{
    "description":"<p>A theme defines the general look-and-feel and the overall style of a site, including color scheme, font size, font type, and page backgrounds. Themes provide visual consistency between the pages in the site. You adjust the design and add content to create a site that sells your style, your brand, and your vision.</p><small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Immutable identifier for the theme.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Human readable name for the theme. </p><small>Introduced in release 19.4.1.</small>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":255
                },
                "ownedBy":{
                    "description":"<p>User or client application that owns this theme.</p><small>Introduced in release 19.4.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "createdBy":{
                    "description":"<p>User or client application that created this theme.</p><small>Introduced in release 19.4.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "lastModifiedBy":{
                    "description":"<p>User, client application or service that last modified this theme.</p><small>Introduced in release 19.4.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "members":{
                    "description":"<p>Users and groups the theme has been shared with.</p><small>Introduced in release 19.4.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "allOf":[
                        {
                            "$ref":"#/definitions/CollectionResource"
                        }
                    ],
                    "properties":{
                        "items":{
                            "description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic",
                                "minimal"
                            ],
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-opaque":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic",
                                            "minimal"
                                        ],
                                        "type":"string"
                                    },
                                    "role":{
                                        "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "type":{
                                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "groupType":{
                                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "name":{
                                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-queryable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "displayName":{
                                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"string"
                                    },
                                    "isExternalUser":{
                                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "type":"boolean"
                                    },
                                    "user":{
                                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Identity"
                                            }
                                        ]
                                    },
                                    "group":{
                                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                                        "x-expandable":true,
                                        "x-returnedIn":[
                                            "representation",
                                            "default",
                                            "basic"
                                        ],
                                        "x-expandedIn":[
                                            "representation"
                                        ],
                                        "allOf":[
                                            {
                                                "$ref":"#/definitions/Group"
                                            }
                                        ]
                                    }
                                },
                                "required":[
                                    "id",
                                    "role",
                                    "type",
                                    "name"
                                ]
                            }
                        }
                    },
                    "required":[
                        "items"
                    ]
                },
                "permissions":{
                    "description":"<p>User permissions for the theme.</p><small>Introduced in release 22.7.2.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "type":"object",
                    "properties":{
                        "links":{
                            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Link"
                                    }
                                ]
                            }
                        },
                        "self":{
                            "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "file":{
                            "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "members":{
                            "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "shareLink":{
                            "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "annotation":{
                            "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "conversation":{
                            "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
                            "x-returnedIn":[
                                "representation",
                                "default",
                                "basic"
                            ],
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    }
                },
                "isDeleted":{
                    "description":"<p>Indicates that the theme has been soft deleted. The corresponding theme folder will be in the trash folder of the user that owned the theme.</p><small>Introduced in release 19.4.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "description":{
                    "description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 19.4.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "createdAt":{
                    "description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "lastModifiedAt":{
                    "description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "publishStatus":{
                    "description":"<p>Indicates whether the theme is published or not.</p><p>Valid values are:\n<ul><li> <code>unpublished</code> - Theme is unpublished</li><li> <code>published</code> - Theme is published</li></p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "job":{
                    "description":"<p>Status for current job assigned to the theme.</p><small>Introduced in release 21.9.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/SiteJobStatus"
                        }
                    ]
                },
                "isStarter":{
                    "description":"<p>Indicates that the theme is a starter theme. Starter themes are copies of existing themes for the purpose of experimentation when developing new sites.</p><small>Introduced in release 22.8.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                }
            }
        }
    ]
}

ネストされたスキーマ : Theme-allOf[1]

型: object

ソースを表示

• createdAt(optional): string(date-time)

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

  リリース19.4.1.での導入。
• createdBy(optional): createdBy

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

  リリース19.4.1.での導入。
• description(optional): string
  最大長: 1000

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

  リリース19.4.1.での導入。
• id(optional): string

  テーマの不変識別子。

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

  リリース19.4.1.での導入。
• isDeleted(オプション): boolean

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

  リリース19.4.1.での導入。
• isStarter(optional): boolean

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

  リリース22.8.1で導入されました。
• job(optional): job

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

  リリース21.9.1で導入されました。
• lastModifiedAt(optional): string(date-time)

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

  リリース19.4.1.での導入。
• lastModifiedBy(optional): lastModifiedBy

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

  リリース19.4.1.での導入。
• members(optional): object members

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

  リリース19.4.3での導入。
• name(optional): string
  最大長: 255

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

  リリース19.4.1.での導入。
• ownedBy(optional): ownedBy

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

  リリース19.4.1.での導入。
• permissions(optional): object permissions

  テーマのユーザー権限。

  リリース22.7.2で導入されました。
• publishStatus(optional): string

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

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

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

  リリース19.4.1.での導入。

{
    "properties":{
        "id":{
            "description":"<p>Immutable identifier for the theme.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Human readable name for the theme. </p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":255
        },
        "ownedBy":{
            "description":"<p>User or client application that owns this theme.</p><small>Introduced in release 19.4.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "createdBy":{
            "description":"<p>User or client application that created this theme.</p><small>Introduced in release 19.4.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "lastModifiedBy":{
            "description":"<p>User, client application or service that last modified this theme.</p><small>Introduced in release 19.4.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "members":{
            "description":"<p>Users and groups the theme has been shared with.</p><small>Introduced in release 19.4.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/CollectionResource"
                }
            ],
            "properties":{
                "items":{
                    "description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                                "x-opaque":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic",
                                    "minimal"
                                ],
                                "type":"string"
                            },
                            "role":{
                                "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "type":{
                                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "groupType":{
                                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "name":{
                                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                                "x-queryable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "displayName":{
                                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"string"
                            },
                            "isExternalUser":{
                                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "type":"boolean"
                            },
                            "user":{
                                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Identity"
                                    }
                                ]
                            },
                            "group":{
                                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                                "x-expandable":true,
                                "x-returnedIn":[
                                    "representation",
                                    "default",
                                    "basic"
                                ],
                                "x-expandedIn":[
                                    "representation"
                                ],
                                "allOf":[
                                    {
                                        "$ref":"#/definitions/Group"
                                    }
                                ]
                            }
                        },
                        "required":[
                            "id",
                            "role",
                            "type",
                            "name"
                        ]
                    }
                }
            },
            "required":[
                "items"
            ]
        },
        "permissions":{
            "description":"<p>User permissions for the theme.</p><small>Introduced in release 22.7.2.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "type":"object",
            "properties":{
                "links":{
                    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/Link"
                            }
                        ]
                    }
                },
                "self":{
                    "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "file":{
                    "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "members":{
                    "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "shareLink":{
                    "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "annotation":{
                    "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "conversation":{
                    "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "isDeleted":{
            "description":"<p>Indicates that the theme has been soft deleted. The corresponding theme folder will be in the trash folder of the user that owned the theme.</p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "description":{
            "description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "createdAt":{
            "description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedAt":{
            "description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 19.4.1.</small>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "publishStatus":{
            "description":"<p>Indicates whether the theme is published or not.</p><p>Valid values are:\n<ul><li> <code>unpublished</code> - Theme is unpublished</li><li> <code>published</code> - Theme is published</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "job":{
            "description":"<p>Status for current job assigned to the theme.</p><small>Introduced in release 21.9.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteJobStatus"
                }
            ]
        },
        "isStarter":{
            "description":"<p>Indicates that the theme is a starter theme. Starter themes are copies of existing themes for the purpose of experimentation when developing new sites.</p><small>Introduced in release 22.8.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application that created this theme.</p><small>Introduced in release 19.4.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

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

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

すべてに一致

ソースを表示

• allOf SiteJobStatus
  識別子: action

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

{
    "description":"<p>Status for current job assigned to the theme.</p><small>Introduced in release 21.9.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteJobStatus"
        }
    ]
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User, client application or service that last modified this theme.</p><small>Introduced in release 19.4.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

型: object

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

リリース19.4.3での導入。

ソースを表示

• items: array items

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

  リリース19.4.1.での導入。

{
    "description":"<p>Users and groups the theme has been shared with.</p><small>Introduced in release 19.4.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "role":{
                        "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "role",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

• allOf CollectionResource

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

{
    "description":"<p>Users and groups the theme has been shared with.</p><small>Introduced in release 19.4.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                        "x-opaque":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic",
                            "minimal"
                        ],
                        "type":"string"
                    },
                    "role":{
                        "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "type":{
                        "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "groupType":{
                        "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "name":{
                        "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                        "x-queryable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "displayName":{
                        "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "isExternalUser":{
                        "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"boolean"
                    },
                    "user":{
                        "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Identity"
                            }
                        ]
                    },
                    "group":{
                        "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                        "x-expandable":true,
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "x-expandedIn":[
                            "representation"
                        ],
                        "allOf":[
                            {
                                "$ref":"#/definitions/Group"
                            }
                        ]
                    }
                },
                "required":[
                    "id",
                    "role",
                    "type",
                    "name"
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application that owns this theme.</p><small>Introduced in release 19.4.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

ネストされたスキーマ : 許可

型: object

テーマのユーザー権限。

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

ソースを表示

• annotation(optional): array annotation

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

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

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

  リリース22.7.2で導入されました。
• conversation(optional): array conversation

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

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

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

  リリース22.7.2で導入されました。
• file(optional): array file

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

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

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

  リリース22.7.2で導入されました。
• links(optional): array links

  このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

• members(optional): array members

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

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

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

  リリース22.7.2で導入されました。
• self(optional): array self

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

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

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

  リリース22.7.2で導入されました。
• shareLink(optional): array shareLink

  ユーザーが持つ共有リンク・アクセス権のセット。

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

  • read - 共有リンクの読取りおよびリスト
  • create - 共有リンクの作成
  • update - 共有リンクの更新
  • delete - 共有リンクの削除

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

{
    "description":"<p>User permissions for the theme.</p><small>Introduced in release 22.7.2.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "self":{
            "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "file":{
            "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "members":{
            "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "shareLink":{
            "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "annotation":{
            "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "conversation":{
            "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

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

リリース19.4.1.での導入。

ソースを表示

• Array of: object items

{
    "description":"<p>Collection of <em>Theme Member</em> elements.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
                "x-opaque":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic",
                    "minimal"
                ],
                "type":"string"
            },
            "role":{
                "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "type":{
                "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "groupType":{
                "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "name":{
                "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
                "x-queryable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "displayName":{
                "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "isExternalUser":{
                "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"boolean"
            },
            "user":{
                "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Identity"
                    }
                ]
            },
            "group":{
                "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
                "x-expandable":true,
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "x-expandedIn":[
                    "representation"
                ],
                "allOf":[
                    {
                        "$ref":"#/definitions/Group"
                    }
                ]
            }
        },
        "required":[
            "id",
            "role",
            "type",
            "name"
        ]
    }
}

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

型: object

ソースを表示

• displayName(optional): string

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

  リリース19.4.1.での導入。
• group(optional): グループ

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

  リリース19.4.1.での導入。
• groupType(optional): string

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

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

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

  リリース20.1.1で導入されました。
• id: string

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

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

  リリース19.4.1.での導入。
• isExternalUser(optional): boolean

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

  リリース21.10.2で導入されました。
• name: string

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

  リリース19.4.1.での導入。
• role: string

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

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

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

  リリース19.4.1.での導入。
• type: string

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

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

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

  クライアント・アプリケーションであるメンバー。

  • group - メンバーはグループです

  リリース19.4.1.での導入。
• user(optional): user

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

  リリース19.4.1.での導入。

{
    "type":"object",
    "properties":{
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 19.4.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "role":{
            "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Indicates the member is a user, client application or group.</p><p>Valid values are:\n<ul><li> <code>user</code> - Member is a user or a client application. No distinction is made between a member that is a user or a</li></ul>member that is a client application.\n<ul><li> <code>group</code> - Member is a group</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "groupType":{
            "description":"<p>If the member is a group, then the type of group is specified. If the member is a user this field is not present.</p><p>Valid values are:\n<ul><li> <code>oce</code> - Content management group</li><li> <code>idp</code> - identity provider group</li></p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.</p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"<p>Display name for the user, client application or group.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isExternalUser":{
            "description":"<p>Will be set to true if the associated user or client application has only the external user role.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "user":{
            "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "group":{
            "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Group"
                }
            ]
        }
    },
    "required":[
        "id",
        "role",
        "type",
        "name"
    ]
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• allOf Group

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

  リリース19.3.1.での導入。

{
    "description":"<p>Group details of the member. Only available if the member has a type of <em>group</em>.</p><small>Introduced in release 19.4.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Group"
        }
    ]
}

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application details of the member. Only available if the member has a type of <em>user</em>. A member can be a user, client application or group. The details of both users and client applications can be read.</p><small>Introduced in release 19.4.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

ネストされたスキーマ : 注釈

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : 会話

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

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

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

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

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

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ユーザーが持つ共有リンク・アクセス権のセット。

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

• read - 共有リンクの読取りおよびリスト
• create - 共有リンクの作成
• update - 共有リンクの更新
• delete - 共有リンクの削除

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

ソースを表示

• Array of: string

{
    "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

すべてに一致

ソースを表示

• object 「リンク」

  REST HATEOASリンクおよび関連メタデータ。 レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

ネストされたスキーマ : イメージ

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

すべてに一致

ソースを表示

• object SingularResource

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

• object Image-allOf[1]

{
    "description":"<p>Site and site template thumbnail or preview image details.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "url":{
                    "description":"<p>URL of this image.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"uri"
                },
                "imageType":{
                    "description":"<p>Image type.</p><p>Valid values are:\n<ul><li> <code>thumbnail</code> - Thumbnail representation of a site or template</li><li> <code>preview</code> - Preview image of what the site or template looks like</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : Image-allOf[1]

型: object

ソースを表示

• imageType(optional): string

  イメージ・タイプ。

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

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

• url(optional): string(uri)

  このイメージのURL。

{
    "properties":{
        "url":{
            "description":"<p>URL of this image.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "imageType":{
            "description":"<p>Image type.</p><p>Valid values are:\n<ul><li> <code>thumbnail</code> - Thumbnail representation of a site or template</li><li> <code>preview</code> - Preview image of what the site or template looks like</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

型: array

「サイトの更新」要素のコレクション。

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

ソースを表示

• Array of: items

{
    "description":"<p>Collection of <em>Site Update</em> elements.</p><small>Introduced in release 21.9.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/SiteUpdate"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• allOf SiteUpdate

  更新は、現在のベース・サイトへの変更の名前付きコレクションです。 変更は、コミットするまで更新内に残り、ベース・サイトは完全に更新されます。

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

{
    "allOf":[
        {
            "$ref":"#/definitions/SiteUpdate"
        }
    ]
}

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

更新は、現在のベース・サイトへの変更の名前付きコレクションです。 変更は、コミットするまで更新内に残り、ベース・サイトは完全に更新されます。

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

すべてに一致

ソースを表示

• object SingularResource

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

• object SiteUpdate-allOf[1]

{
    "description":"<p>An update is a named collection of changes to the current base site. The changes remain in the update until you commit them and permanently update the base site.</p><small>Introduced in release 21.9.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Immutable identifier.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 21.9.1.</small>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Human readable name for the site update. </p><small>Introduced in release 21.9.1.</small>",
                    "x-queryable":true,
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":255
                },
                "description":{
                    "description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 21.9.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":1000
                },
                "ownedBy":{
                    "description":"<p>User or client application that owns this resource.</p><small>Introduced in release 21.9.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "createdAt":{
                    "description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 21.9.1.</small>",
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "createdBy":{
                    "description":"<p>User or client application that created this resource.</p><small>Introduced in release 21.9.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "lastModifiedAt":{
                    "description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 21.9.1.</small>",
                    "x-sortable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "lastModifiedBy":{
                    "description":"<p>User or client application that last modified this resource.</p><small>Introduced in release 21.9.1.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/Identity"
                        }
                    ]
                },
                "allowedActions":{
                    "description":"<p>Allowed user actions on the folder.</p><small>Introduced in release 22.7.2.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "isDeleted":{
                    "description":"<p>Indicates that the item has been soft deleted.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                }
            }
        }
    ]
}

ネストされたスキーマ : SiteUpdate-allOf[1]

型: object

ソースを表示

• allowedActions(optional): integer(int64)

  フォルダで許可されるユーザー・アクション。

  リリース22.7.2で導入されました。
• createdAt(optional): string(date-time)

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

  リリース21.9.1で導入されました。
• createdBy(optional): createdBy

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

  リリース21.9.1で導入されました。
• description(optional): string
  最大長: 1000

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

  リリース21.9.1で導入されました。
• id(optional): string

  不変識別子。

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

  リリース21.9.1で導入されました。
• isDeleted(オプション): boolean

  品目がソフト削除されたことを示します。

  リリース19.4.1.での導入。
• lastModifiedAt(optional): string(date-time)

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

  リリース21.9.1で導入されました。
• lastModifiedBy(optional): lastModifiedBy

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

  リリース21.9.1で導入されました。
• name(optional): string
  最大長: 255

  サイト更新の読みやすい名前。

  リリース21.9.1で導入されました。
• ownedBy(optional): ownedBy

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

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

{
    "properties":{
        "id":{
            "description":"<p>Immutable identifier.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 21.9.1.</small>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Human readable name for the site update. </p><small>Introduced in release 21.9.1.</small>",
            "x-queryable":true,
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":255
        },
        "description":{
            "description":"<p>Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p><small>Introduced in release 21.9.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "ownedBy":{
            "description":"<p>User or client application that owns this resource.</p><small>Introduced in release 21.9.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "createdAt":{
            "description":"<p>Date and time of creation. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 21.9.1.</small>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"<p>User or client application that created this resource.</p><small>Introduced in release 21.9.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "lastModifiedAt":{
            "description":"<p>Date and time of the last modification. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p><small>Introduced in release 21.9.1.</small>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "lastModifiedBy":{
            "description":"<p>User or client application that last modified this resource.</p><small>Introduced in release 21.9.1.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/Identity"
                }
            ]
        },
        "allowedActions":{
            "description":"<p>Allowed user actions on the folder.</p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "isDeleted":{
            "description":"<p>Indicates that the item has been soft deleted.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

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

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

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

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application that created this resource.</p><small>Introduced in release 21.9.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

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

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

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application that last modified this resource.</p><small>Introduced in release 21.9.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

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

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

すべてに一致

ソースを表示

• allOf 「アイデンティティ」
  識別子: type

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

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

{
    "description":"<p>User or client application that owns this resource.</p><small>Introduced in release 21.9.1.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/Identity"
        }
    ]
}

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

型: object

サイトで特定の権限を付与する必要があるかどうかなど、OCEユーザー・タイプに関連するセキュリティ設定を定義

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

ソースを表示

• externalUserEnabled(optional): boolean

  サイトで外部ユーザーを許可するかどうかを示します。 trueの場合、サイトでは、外部ユーザーに対する一部の(制限された)権限(管理されていない)メンバー・ロールをそのようなユーザーに付与できます。

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

{
    "description":"<p>Defines security settings relating to OCE user types, for instance whether the site should allow external users to be granted certain permissions</p><small>Introduced in release 21.10.2.</small>",
    "properties":{
        "externalUserEnabled":{
            "description":"<p>Indicates whether a site should allow external users. If true, the site will allow some (limited) privileges for external users, including (non-managing) member roles to be given to the such users.</p><small>Introduced in release 21.10.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

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

サイトのバニティ・ドメインを定義します。 構成すると、サイト・ドメインの代わりにバニティ・ドメインを使用してサイトにアクセスできます。

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

すべてに一致

ソースを表示

• object SingularResource

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

• object VanityDomain-allOf[1]

{
    "description":"<p>Defines a vanity domain for a site. Once configured, a vanity domain may be used in place of the site domain to access the site.</p><small>Introduced in release 21.5.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "name":{
                    "description":"<p>The vanity domain for this site.</p><small>Introduced in release 21.5.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "configurationStatus":{
                    "description":"<p>The configuration status of this vanity domain. The domain is not immediately available to users once set, configuration to make it available may take up to 60 mins to complete.</p><p>Valid values are:\n<ul><li> <code>processing</code> - Vanity domain configuration is in process</li><li> <code>completed</code> - Vanity domain configuration has completed</li><li> <code>failed</code> - Vanity domain configuration has failed</li></p><small>Introduced in release 21.5.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : VanityDomain-allOf[1]

型: object

ソースを表示

• configurationStatus(optional): string

  このバニティ・ドメインの構成ステータス。 ドメインは設定されるとすぐにユーザーが使用できなくなり、使用可能にするための構成が完了するまでに最大60分かかる場合があります。

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

  • processing - バニティ・ドメイン構成は処理中です
  • completed - バニティ・ドメインの構成が完了しました
  • failed - バニティ・ドメインの構成に失敗しました

  リリース21.5.1で導入されました。
• name(optional): string

  このサイトのバニティ・ドメイン。

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

{
    "properties":{
        "name":{
            "description":"<p>The vanity domain for this site.</p><small>Introduced in release 21.5.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "configurationStatus":{
            "description":"<p>The configuration status of this vanity domain. The domain is not immediately available to users once set, configuration to make it available may take up to 60 mins to complete.</p><p>Valid values are:\n<ul><li> <code>processing</code> - Vanity domain configuration is in process</li><li> <code>completed</code> - Vanity domain configuration has completed</li><li> <code>failed</code> - Vanity domain configuration has failed</li></p><small>Introduced in release 21.5.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

レスポンスの例 ()

{
    "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0",
    "name":"MyNewProduct",
    "isExpired":false,
    "isDeleted":false,
    "description":"A folder for my assets.",
    "createdAt":"2019-06-01T06:44:17.000Z",
    "lastModifiedAt":"2019-06-01T06:44:17.000Z",
    "thumbnail":{
        "url":"http://cloud.example.com/images/site.png",
        "imageType":"thumbnail"
    },
    "isEnterprise":false,
    "themeName":"value",
    "defaultLanguage":"en-US",
    "runtimeStatus":"offline",
    "offlineAt":"2019-06-01T06:44:17.000Z",
    "onlineAt":"2019-06-01T06:44:17.000Z",
    "publishStatus":"unpublished",
    "publishedAt":"2019-06-01T06:44:17.000Z",
    "unpublishedAt":"2019-06-01T06:44:17.000Z",
    "expiresAt":"2019-06-01T06:44:17.000Z",
    "security":{
        "policy":{
            "level":"service",
            "appliesTo":"named"
        },
        "access":[
            "named"
        ]
    },
    "userSecurity":{
        "externalUserEnabled":false
    },
    "sitePrefix":"News",
    "templateName":"value",
    "isIframeEmbeddingAllowed":false,
    "numberOfUpdates":1234,
    "job":{
        "action":"copy",
        "context":"37D1070720325969AC6C47ACE8B9BFF91533560416423",
        "startTime":"2018-05-21T12:01:15.123Z",
        "endTime":"2018-05-21T12:01:15.123Z",
        "progress":"pending",
        "completed":false,
        "requestStatus":200,
        "message":"Running",
        "completedPercentage":"50",
        "intervalToPoll":"2000",
        "error":{
            "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
            "title":"Internal Error",
            "status":"500",
            "detail":"An internal error occurred.",
            "o:errorCode":"ORA-999999"
        },
        "result":{
            "status":{
                "code":"200",
                "reason":"OK"
            },
            "headers":[
                {
                    "name":"Content-Type",
                    "value":"application/json"
                }
            ]
        }
    },
    "staticSiteDeliveryOptions":{
        "compileSite":false,
        "cachingResponseHeaders":"Cache-control: max-age=600",
        "mobileUserAgents":"Mobile"
    },
    "compilationStatus":"value",
    "sitePageOptions":{
        "urlValidationDisabled":false,
        "ssrEnabled":false,
        "ssrReady":false
    }
}

400レスポンス

不正なリクエスト

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf InvalidSecurityScopeExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/InvalidSecurityScopeExceptionDetail"
        }
    ]
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

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

• object InvalidSecurityScopeExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "level":{
                    "description":"<p>Specified site security level.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "specifiedScope":{
                    "description":"<p>Specified site security scope.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "requiredScope":{
                    "description":"<p>Required site security scope.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

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

ソースを表示

• detail(optional): string

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

• instance(optional): string(uri)

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

• o:errorCode(optional): string

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

• o:errorDetails(optional): array o:errorDetails

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

• o:errorPath(optional): string

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

• status(optional): integer(int32)

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

• title(optional): string

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

• type(optional): string(uri)

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

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : InvalidSecurityScopeExceptionDetail-allOf[1]

型: object

ソースを表示

• level(optional): string

  指定されたサイト・セキュリティ・レベル。

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

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

• requiredScope(optional): string

  必須のサイト・セキュリティ・スコープです。

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

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

• specifiedScope(optional): string

  指定したサイト・セキュリティ範囲。

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

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

{
    "properties":{
        "level":{
            "description":"<p>Specified site security level.</p><p>Valid values are:\n<ul><li> <code>service</code> - Only service users</li><li> <code>cloud</code> - Only cloud users who can sign in to your domain</li><li> <code>everyone</code> - Anyone without signing in</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "specifiedScope":{
            "description":"<p>Specified site security scope.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "requiredScope":{
            "description":"<p>Required site security scope.</p><p>Valid values are:\n<ul><li> <code>named</code> - Only named users within a specified level can access</li><li> <code>all</code> - All users within a specified level can access</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

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

ソースを表示

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(無効なセキュリティ・スコープ)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Security Scope",
    "status":"400",
    "detail":"Site security scope '{specifiedScope}' is not valid with a site security level of '{level}'. Use a security scope of '{requiredScope}'.",
    "o:errorCode":"OCE-SITEMGMT-009018",
    "level":"service",
    "specifiedScope":"named",
    "requiredScope":"all"
}

レスポンスの例(無効なサイト・セキュリティ・アクセス)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Security Access",
    "status":"400",
    "detail":"Site security access levels are not allowed by the security policy.",
    "o:errorCode":"OCE-SITEMGMT-009019",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

レスポンスの例(必須サイト・フィールド)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Mandatory Site Field",
    "status":"400",
    "detail":"Field '{fieldName}' should not be set to 'null'.",
    "o:errorCode":"OCE-SITEMGMT-009070",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "fieldName":"security"
}

レスポンスの例(無効なサイト名)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Name",
    "status":"400",
    "detail":"Site name '{siteName}' cannot be used to create a site.",
    "o:errorCode":"OCE-SITEMGMT-009012",
    "siteName":"MyNewProduct",
    "reason":"tooLong"
}

401レスポンス

未認可

403レスポンス

禁止

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf SiteOperationForbiddenExceptionDetail
  リリース19.1.5.での導入。

{
    "allOf":[
        {
            "$ref":"#/definitions/SiteOperationForbiddenExceptionDetail"
        }
    ]
}

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

リリース19.1.5.での導入。

すべてに一致

ソースを表示

• object ExceptionDetail

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

• object SiteOperationForbiddenExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.1.5.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site on which the operation is being performed.</p><small>Introduced in release 19.1.5.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

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

ソースを表示

• detail(optional): string

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

• instance(optional): string(uri)

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

• o:errorCode(optional): string

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

• o:errorDetails(optional): array o:errorDetails

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

• o:errorPath(optional): string

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

• status(optional): integer(int32)

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

• title(optional): string

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

• type(optional): string(uri)

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

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : SiteOperationForbiddenExceptionDetail-allOf[1]

型: object

ソースを表示

• site(optional): string

  操作が実行されているサイト。

  リリース19.1.5.での導入。

{
    "properties":{
        "site":{
            "description":"<p>Site on which the operation is being performed.</p><small>Introduced in release 19.1.5.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

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

ソースを表示

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(サイト操作禁止)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Operation Forbidden",
    "status":"403",
    "detail":"You do have a sharing role in this site, but your role does not allow you to use this operation.",
    "o:errorCode":"OCE-SITEMGMT-009026",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

レスポンスの例(ストレージ制限に達しました)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Storage Limit Reached",
    "status":"403",
    "detail":"Storage limit has been reached.",
    "o:errorCode":"OCE-SITEMGMT-009098",
    "used":1.23456789,
    "limit":1.23456789
}

レスポンスの例(サイト収集操作禁止)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Collection Operation Forbidden",
    "status":"403",
    "detail":"User, or client application, has insufficient privileges on the site collection.",
    "o:errorCode":"OCE-SITEMGMT-009153",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

404レスポンス

見つかりません

ヘッダー

• Cache-Control: string

  キャッシュ・メカニズムのディレクティブ。

• Content-Length: string

  レスポンス本文のサイズ。

• Content-Type: string

  レスポンスのコンテンツ・タイプ。

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf SiteNotFoundExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/SiteNotFoundExceptionDetail"
        }
    ]
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

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

• object SiteNotFoundExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site that does not exist or is not visible to the authenticated user.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

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

ソースを表示

• detail(optional): string

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

• instance(optional): string(uri)

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

• o:errorCode(optional): string

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

• o:errorDetails(optional): array o:errorDetails

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

• o:errorPath(optional): string

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

• status(optional): integer(int32)

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

• title(optional): string

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

• type(optional): string(uri)

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

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : SiteNotFoundExceptionDetail-allOf[1]

型: object

ソースを表示

• site(optional): string

  存在しないか、認証されたユーザーが参照できないサイトです。

{
    "properties":{
        "site":{
            "description":"<p>Site that does not exist or is not visible to the authenticated user.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

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

ソースを表示

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(サイトが見つかりません)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Not Found",
    "status":"404",
    "detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
    "o:errorCode":"OCE-SITEMGMT-009003",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

406レスポンス

受入れられない

409レスポンス

競合

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf SiteAlreadyExistsExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/SiteAlreadyExistsExceptionDetail"
        }
    ]
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

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

• object SiteAlreadyExistsExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "name":{
                    "description":"<p>Duplicate name. </p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":100
                }
            }
        }
    ]
}

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

型: object

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

ソースを表示

• detail(optional): string

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

• instance(optional): string(uri)

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

• o:errorCode(optional): string

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

• o:errorDetails(optional): array o:errorDetails

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

• o:errorPath(optional): string

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

• status(optional): integer(int32)

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

• title(optional): string

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

• type(optional): string(uri)

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

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : SiteAlreadyExistsExceptionDetail-allOf[1]

型: object

ソースを表示

• name(optional): string
  最大長: 100

  重複している名前です

{
    "properties":{
        "name":{
            "description":"<p>Duplicate name. </p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":100
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

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

ソースを表示

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

• object ExceptionDetail

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

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(サイトはすでに存在します)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Already Exists",
    "status":"409",
    "detail":"A site with the same name already exists.",
    "o:errorCode":"OCE-SITEMGMT-009004",
    "name":"Oracle Content and Experience"
}

レスポンスの例 (無効なサイト・パブリッシュ・ステータス)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Publish Status",
    "status":"409",
    "detail":"Operation cannot be performed on a site with publish status '{publishStatus}'.",
    "o:errorCode":"OCE-SITEMGMT-009031",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "publishStatus":"unpublished",
    "requiredStatus":[
        "unpublished"
    ]
}

レスポンスの例(無効なサイト・ステータス)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Status",
    "status":"409",
    "detail":"Operation cannot be performed on a site with status '{runtimeStatus}'.",
    "o:errorCode":"OCE-SITEMGMT-009013",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "runtimeStatus":"offline",
    "requiredStatus":"offline"
}

レスポンスの例(サイト削除)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the site has been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009059",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

レスポンスの例(サイト・コレクションはすでに存在します)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Collection Already Exists",
    "status":"409",
    "detail":"A collection with the same name already exists.",
    "o:errorCode":"OCE-SITEMGMT-009154",
    "name":"Oracle Content and Experience"
}

レスポンスの例(サイト・チャネルはすでに存在します)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Channel Already Exists",
    "status":"409",
    "detail":"A channel with the same name already exists.",
    "o:errorCode":"OCE-SITEMGMT-009155",
    "channelName":"Oracle Content and Experience"
}

レスポンスの例(サイト・コンテンツ・セキュリティ・グループはすでに存在します)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Content Security Group Already Exists",
    "status":"409",
    "detail":"Site rename cannot be performed as there is an existing content security group with the same name.",
    "o:errorCode":"OCE-SITEMGMT-009158",
    "groupName":"Oracle Content and Experience"
}

レスポンスの例(サイト・コンテンツ・セキュリティ・タクソノミ・ドラフトが存在)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Content Security Taxonomy Draft Exists",
    "status":"409",
    "detail":"Site operation cannot be performed as it has an existing content security taxonomy draft.",
    "o:errorCode":"OCE-SITEMGMT-009152",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "securityTaxonomyId":"value"
}

413 レスポンス

ペイロードが大きすぎます

415 レスポンス

サポート対象外のメディア・タイプ

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト

先頭に戻る