サイト管理用のREST API

新規サイト更新の作成

post

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

COLLECTION

サイト更新は、現在のベース・サイトに対する変更の名前付きコレクションです。変更は、コミットするまで更新内に残り、ベース・サイトは完全に更新されます。この操作では、サイトの新しい空の更新が作成されます。この更新のためにサイトに変更が加えられたら、更新をコミットまたは破棄できます。

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

認可

この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:

所有者
マネージャ
貢献者

サイト更新の削除

更新の変更をコミットせずに、サイト更新を削除できます。

詳細は、「サイト更新の削除」を参照してください。

サイト更新のコミット

サイト更新の変更が準備できたら、コミット操作を使用してベース・サイトに公開できます。

詳細は、「サイトへの更新のコミット」を参照してください。

パス代替識別子

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

nameサイト名

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

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

リリース19.4.1.での導入。

成功したレスポンスの例

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

200OK

リクエスト

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

リクエスト本文

{
  "name": "Edit1",
  "description": "A folder for my assets."
}

200OK

リクエスト

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

レスポンス本文

{
  "id": "FC274A0A4E18CD651C0EDD7DT0000DEFAULT00000000",
  "name": "Edit1",
  "description": "A folder for my assets.",
  "createdAt": "2019-06-01T06:44:17.000Z",
  "lastModifiedAt": "2019-06-01T06:44:17.000Z",
  "allowedActions": 1234567890,
  "isDeleted": false
}

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

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

400不正なリクエスト - 無効なサイト更新名

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

エラー・コード

OCE-SITEMGMT-009124

解決 - スペースの削除

スペースを含まないように名前を変更します。

解決 - チェック文字

名前には、文字、数字、ハイフンおよびアンダースコアのみを使用してください。

例外詳細フィールド

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

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

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Update Name",
  "status": "400",
  "detail": "Site update name '{updateName}' cannot be used.",
  "o:errorCode": "OCE-SITEMGMT-009124",
  "updateName": "value",
  "reason": "tooLong"
}

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

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.での導入。

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

409競合 - サイト更新はすでに存在

同じ名前のサイト更新がサイトに対してすでに存在するため、サイト更新を作成できません。

エラー・コード

OCE-SITEMGMT-009123

解決 - サイト更新名の変更

別のサイト更新名を使用してください。

解決 - 競合するサイト更新の削除

既存のサイト更新を削除して再試行してください。

例外詳細フィールド

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

フィールド名	説明
`name`	すでに使用されているサイト更新名。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Update Already Exists",
  "status": "409",
  "detail": "Site update already exists.",
  "o:errorCode": "OCE-SITEMGMT-009123",
  "name": "value"
}

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

リクエスト

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

application/json

パス・パラメータ

id: string

サイトの不変の識別子。

サイト更新の名前など、新しい更新の詳細を指定します。

ルート・スキーマ: schema

型: object

ソースを表示

description(optional): string

最大長: 1000

オプションの説明。説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。
リリース21.9.1で導入されました。
links(optional): array links

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

最大長: 255

サイト更新の読みやすい名前。
リリース21.9.1で導入されました。

{
    "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 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
        }
    },
    "required":[
        "name"
    ],
    "example":{
        "name":"Edit1",
        "description":"A folder for my assets."
    }
}

例:

{
    "name":"Edit1",
    "description":"A folder for my assets."
}

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

すべてに一致

認可

サイト更新の削除

サイト更新のコミット

パス代替識別子

nameサイト名

成功したレスポンスの例

200OK

リクエスト

リクエスト本文

200OK

リクエスト

レスポンス本文

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

400不正なリクエスト - 無効なサイト更新名

エラー・コード

解決 - スペースの削除

解決 - チェック文字

例外詳細フィールド

レスポンス本文の例

403Forbidden - Site Operation Forbidden

エラー・コード

解決 - 共有ロールの変更

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

例外詳細フィールド

レスポンス本文の例

404Not Found - Site Not Found

エラー・コード

解決 - 識別子のチェック

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

例外詳細フィールド

レスポンス本文の例

409競合 - サイト更新はすでに存在

エラー・コード

解決 - サイト更新名の変更

解決 - 競合するサイト更新の削除

例外詳細フィールド

レスポンス本文の例

リクエスト

レスポンス

201レスポンス

400レスポンス

401レスポンス

403レスポンス

404レスポンス

406レスポンス

409レスポンス

413 レスポンス

415 レスポンス

416 レスポンス

429 レスポンス

500レスポンス

501レスポンス

502 レスポンス

503レスポンス

504レスポンス