機械翻訳について

移動先

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

動的プロセス・ロールの一覧表示

get

/ic/api/process/v1/dp-roles

動的プロセス・ロールのリストを取得します。

リクエスト

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

• application/json

問合せパラメータ

• displayName: string
  プロセス・ロールの表示名でフィルタします。
• firstResult: integer
  結果のページ番号付け。 返される最初の結果のインデックスを指定します。

  デフォルト値: -1
• group: array[string]
  コレクション形式: multi

  グループ名
• maxResults: integer
  結果のページ番号付け。 返す結果の最大数を指定します。 これ以上結果が残っていない場合、戻される結果は少なくなります。

  デフォルト値: -1
• processDefinitionId: string
  プロセス定義IDでフィルタします。 完全一致。 processInstanceIdと組み合せて使用します。
• processInstanceId: string
  プロセス・インスタンスIDでフィルタします。 完全一致。 processDefinitionIdと組み合せて使用します。
• scopeType: array[string]
  コレクション形式: multi

  プロセス・ロールscopeTypeでフィルタします。

  • 許容値: [ "GLOBAL", "DEFINITION", "INSTANCE" ]

• type: string
  ロールのタイプ

  デフォルト値: all
• userId: string
  ユーザーID

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : ProcessRoles

型: object

すべてに一致

ソースを表示

• object CommonModel
  識別子: links
• object ProcessRoles-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessRole"
                    }
                }
            }
        }
    ]
}

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

型: object

識別子: links

ソースを表示

• links: array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: object

ソースを表示

• items: array items

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

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

型: array

ソースを表示

• Array of: object ProcessRole

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

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

型: object

すべてに一致

ソースを表示

• object CommonModel
  識別子: links
• object ProcessRole-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the process role."
                },
                "displayName":{
                    "type":"string",
                    "description":"The display name of the process role"
                },
                "overriddenRoleId":{
                    "type":"string",
                    "description":"The ID of the definition or global scope role overriden by this role"
                },
                "scopes":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "scopeType":{
                    "$ref":"#/definitions/ProcessRoleScopeType"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• displayName: string
  プロセス・ロールの表示名
• id: string
  プロセス・ロールのID。
• overriddenRoleId: string
  このロールによってオーバーライドされた定義またはグローバル・スコープ・ロールのID
• scopes: array scopes
• scopeType: string
  許容値: [ "GLOBAL", "DEFINITION", "INSTANCE" ]

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the process role."
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the process role"
        },
        "overriddenRoleId":{
            "type":"string",
            "description":"The ID of the definition or global scope role overriden by this role"
        },
        "scopes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "scopeType":{
            "$ref":"#/definitions/ProcessRoleScopeType"
        }
    }
}

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

型: array

ソースを表示

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400レスポンス

一部の問合せパラメータが有効でない場合に返されます。

401レスポンス

未認可

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

先頭に戻る