機械翻訳について

移動先

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

プロセス・ロールへのメンバーの追加

post

/content/management/api/v1.1/workflowRoles/{id}/members

指定されたペイロードを使用してプロセス・ロールにメンバーを追加します。

リクエスト

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

• application/json

パス・パラメータ

• id: string
  idは、ワークフロー・ロールのOCEで生成された一意のIDを表します

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロードに指定された情報を持つメンバーをプロセス・ロールに追加します。 ペイロード内に指定されている場合でも、id, createdBy, createdDate, updatedBy, updatedDateおよびlinksフィールドは無視されます。

ルート・スキーマ : WorkflowRoleMembers

型: object

WorkflowRoleMembers

ソースを表示

• links(optional): array links
  リンク
• members(optional): array members
  ワークフロー・ロールのメンバー。

{
    "type":"object",
    "properties":{
        "members":{
            "type":"array",
            "description":"Members of the Workflow role.",
            "items":{
                "$ref":"#/definitions/Members."
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowRoleMembers"
}

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

型: array

リンク

ソースを表示

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

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

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

型: array

ワークフロー・ロールのメンバー。

ソースを表示

• Array of: object Members.
  メンバー

{
    "type":"array",
    "description":"Members of the Workflow role.",
    "items":{
        "$ref":"#/definitions/Members."
    }
}

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

ネストされたスキーマ : Members.

型: object

メンバー

ソースを表示

• groupType(optional): string
  許容値: [ "CEC", "IDP" ]

  グループ・タイプ
• memberId(optional): string
  メンバーのID。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• memberType(optional): string
  許容値: [ "user", "group" ]

  メンバー・タイプ

{
    "type":"object",
    "properties":{
        "memberId":{
            "type":"string",
            "description":"id of a member. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "memberType":{
            "type":"string",
            "description":"Member type.",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "description":"Group type",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    },
    "description":"Members"
}

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : WorkflowRoleMembersWithFailureDetails

型: object

WorkflowRoleMembersWithFailureDetails

ソースを表示

• failedMembers(optional): array failedMembers
  ロールへの追加中に失敗したメンバーのリスト
• links(optional): array links
  リンク
• members(optional): array members
  ワークフロー・ロールのメンバー。

{
    "type":"object",
    "properties":{
        "members":{
            "type":"array",
            "description":"Members of the Workflow role.",
            "items":{
                "$ref":"#/definitions/Members."
            }
        },
        "failedMembers":{
            "type":"array",
            "description":"List of failed members while adding them to a role",
            "items":{
                "$ref":"#/definitions/FailedUserId"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowRoleMembersWithFailureDetails"
}

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

型: array

ロールへの追加中に失敗したメンバーのリスト

ソースを表示

• Array of: object FailedUserId
  FailedUserId

{
    "type":"array",
    "description":"List of failed members while adding them to a role",
    "items":{
        "$ref":"#/definitions/FailedUserId"
    }
}

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

型: array

リンク

ソースを表示

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

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

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

型: array

ワークフロー・ロールのメンバー。

ソースを表示

• Array of: object Members.
  メンバー

{
    "type":"array",
    "description":"Members of the Workflow role.",
    "items":{
        "$ref":"#/definitions/Members."
    }
}

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

型: object

FailedUserId

ソースを表示

• groupType(optional): string
  許容値: [ "CEC", "IDP" ]
• message(optional): string
  失敗メッセージです。
• name(optional): string
• type(optional): string
  許容値: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        },
        "message":{
            "type":"string",
            "description":"failure message."
        }
    },
    "description":"FailedUserId"
}

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

ネストされたスキーマ : Members.

型: object

メンバー

ソースを表示

• groupType(optional): string
  許容値: [ "CEC", "IDP" ]

  グループ・タイプ
• memberId(optional): string
  メンバーのID。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• memberType(optional): string
  許容値: [ "user", "group" ]

  メンバー・タイプ

{
    "type":"object",
    "properties":{
        "memberId":{
            "type":"string",
            "description":"id of a member. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "memberType":{
            "type":"string",
            "description":"Member type.",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "description":"Group type",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    },
    "description":"Members"
}

400レスポンス

不正リクエスト

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る