機械翻訳について

移動先

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

バッチ・タクソノミ権限操作

post

/content/management/api/v1.1/taxonomies/{id}/permissions/.batch

同期起動のみをサポートします。
リクエスト・ペイロードには最大25個のアイテムを指定できます。 各アイテムは個別に処理されます。

リクエスト

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

• application/json

パス・パラメータ

• id: string
  タクソノミのId。

問合せパラメータ

• links(optional): string
  これはオプションのパラメータです。 このパラメータは、レスポンスで返されるリンクのカンマ区切りリストを受け入れます。

  許容値: [ "results" ]
• operations: string
  このパラメータは、操作名のカンマ区切りリストを受け入れます。 許可される値はaddです

ヘッダー・パラメータ

• Prefer(optional): string
  このパラメータは、リクエストの相互作用のタイプ(同期/非同期)を制御するために使用されます。 ヘッダーの値がレスポンス/同期で指定されている場合は、非同期相互作用が優先されることを示します。 それ以外の場合は、同期相互作用が優先されます。 非同期リクエストは、ロケーション・ヘッダーにステータス・リンクがある202ステータスで応答します。 同期リクエストは、レスポンス本文とともに200で応答します。

  許容値: [ "respond-sync" ]
• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内の指定された情報を使用して、権限操作のバッチを実行します。

リクエスト本文に権限操作addが含まれます
ペイロードの追加ブロックは、作成される権限のリストを受け入れます。

ルート・スキーマ : BatchJobBeanResourcePermissionCreate

型: object

BatchJobBean

ソースを表示

• errorCount(optional): integer(int32)
  読取り専用: true

  失敗したアイテムの数。
• id(optional): string
  読取り専用: true

  ジョブのID。
• itemsCount(optional): integer(int32)
  読取り専用: true

  処理済アイテムの合計数。
• links(optional): array links
  読取り専用: true

  リンク
• operations: array operations
  実行する操作。これはポスト・リクエストの必須プロパティです。
• successCount(optional): integer(int32)
  読取り専用: true

  正常に処理された品目の件数。

{
    "type":"object",
    "required":[
        "operations"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the job.",
            "readOnly":true
        },
        "successCount":{
            "type":"integer",
            "format":"int32",
            "description":"count of successfully processed items.",
            "readOnly":true
        },
        "errorCount":{
            "type":"integer",
            "format":"int32",
            "description":"count of failed items.",
            "readOnly":true
        },
        "itemsCount":{
            "type":"integer",
            "format":"int32",
            "description":"total count of processed items.",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "description":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "operations":{
            "type":"array",
            "description":"Operations to perform, It is a required property in the post request.",
            "items":{
                "$ref":"#/definitions/JobOperationBeanResourcePermissionCreate"
            }
        }
    },
    "description":"BatchJobBean"
}

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

型: array

読取り専用: true

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

実行する操作。これはポスト・リクエストの必須プロパティです。

ソースを表示

• Array of: object JobOperationBeanResourcePermissionCreate

{
    "type":"array",
    "description":"Operations to perform, It is a required property in the post request.",
    "items":{
        "$ref":"#/definitions/JobOperationBeanResourcePermissionCreate"
    }
}

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

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

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

型: object

ソースを表示

• add(optional): array add

{
    "type":"object",
    "properties":{
        "add":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResourcePermissionCreate"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object ResourcePermissionCreate
  ResourcePermissionCreate

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

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

型: object

ResourcePermissionCreate

ソースを表示

• email(optional): string
  ユーザーの電子メール。
• fullName(optional): string
  ユーザーの完全名。
• groupType(optional): string
  許容値: [ "CEC", "IDP" ]

  グループのタイプ。
• id(optional): string
  ユーザーのuserIdログイン名。
• links(optional): array links
  読取り専用: true

  リンク
• message(optional): string
• role(optional): object PermissionRole
  PermissionRole
• roleName(optional): string
  リソース上のロールの名前。 非推奨。 'role'プロパティに置き換えられます。
• type(optional): string
  許容値: [ "user", "group" ]

  ユーザーのタイプ。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"userId login name of the user."
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource. Deprecated. Replaced by the 'role' property."
        },
        "type":{
            "type":"string",
            "description":"type of the user.",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "description":"type of the group.",
            "enum":[
                "CEC",
                "IDP"
            ]
        },
        "message":{
            "type":"string"
        },
        "role":{
            "description":"role on the resource.",
            "$ref":"#/definitions/PermissionRole"
        },
        "email":{
            "type":"string",
            "description":"email of the user."
        },
        "fullName":{
            "type":"string",
            "description":"full name of the user."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ResourcePermissionCreate"
}

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

型: array

読取り専用: true

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

PermissionRole

ソースを表示

• description(optional): string
  ロールの説明。 カスタムの編集ロールまたは公開ロールにのみ適用されます。
• id(optional): string
  ロールのID。 権限セット、カスタム編集ロールまたは公開ロールにのみ適用されます。
• links(optional): array links
  リンク
• name(optional): string
  ロールの名前。
• type(optional): string
  許容値: [ "standard", "custom", "editorial", "publishing" ]

  ロールのタイプ。 値は、'standard'、'custom'、'editorial'および'publishing'です。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the role. Only applicable to permission sets and custom editorial or publishing roles."
        },
        "name":{
            "type":"string",
            "description":"Name of the role."
        },
        "type":{
            "type":"string",
            "description":"Type of the role. Values are 'standard', 'custom', 'editorial', and 'publishing'.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "description":{
            "type":"string",
            "description":"Description of the role. Only applicable to custom editorial or publishing roles."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PermissionRole"
}

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

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る