機械翻訳について

移動先

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

タスクに関する一括アクションの実行

put

/ic/api/process/v1/tasks

ペイロードに基づいて複数のタスクに関するアクションを実行します。

リクエスト

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

• application/json

本文()

アクション・ペイロード

ルート・スキーマ : actions

型: object

ソースを表示

• action: object action
• comment: object comment
• identities: array identities
• priority: integer(int32)
• tasks: array tasks

{
    "type":"object",
    "properties":{
        "identities":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"identities"
                },
                "$ref":"#/definitions/Identity"
            }
        },
        "action":{
            "$ref":"#/definitions/Action"
        },
        "comment":{
            "$ref":"#/definitions/Comment"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "tasks":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"actions",
        "namespace":"http://xmlns.oracle.com/bpm/rest/payloads"
    }
}

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

型: object

ソースを表示

• abortType: string
• activityChanges: array activityChanges
• assignees: array assignees
• comments: string
• correlationKeyChanges: array correlationKeyChanges
• dataObjectChanges: array dataObjectChanges
• faultActionType: string
• flowId: integer(int64)
• id: string
• instanceAttributeChanges: array instanceAttributeChanges
• processes: array processes
• type: string

{
    "type":"object",
    "properties":{
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Identity"
            }
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "processes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "faultActionType":{
            "type":"string"
        },
        "flowId":{
            "type":"integer",
            "format":"int64"
        },
        "abortType":{
            "type":"string"
        },
        "comments":{
            "type":"string"
        },
        "activityChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FlowChangeItemReq"
            }
        },
        "dataObjectChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "instanceAttributeChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "correlationKeyChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        }
    },
    "xml":{
        "name":"action",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

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

型: object

ソースを表示

• commentScope: string
• commentStr: string
• updatedBy: string
• updateddDate: string
• userId: string

{
    "type":"object",
    "properties":{
        "commentStr":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "updateddDate":{
            "type":"string"
        },
        "commentScope":{
            "type":"string"
        }
    },
    "xml":{
        "name":"comment",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

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

型: array

ソースを表示

• Array of: object identity
  識別子: type

{
    "type":"array",
    "items":{
        "xml":{
            "name":"identities"
        },
        "$ref":"#/definitions/Identity"
    }
}

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

型: array

ソースを表示

• Array of: string

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

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

型: array

ソースを表示

• Array of: object FlowChangeItemReq

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

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

型: array

ソースを表示

• Array of: object identity
  識別子: type

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

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

型: array

ソースを表示

• Array of: object DataVariable

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

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

型: array

ソースを表示

• Array of: object DataVariable

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

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

型: array

ソースを表示

• Array of: object DataVariable

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

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

型: array

ソースを表示

• Array of: string

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

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

型: object

ソースを表示

• correlationKeyChanges: array correlationKeyChanges
• dataObjectChanges: array dataObjectChanges
• instanceAttributeChanges: array instanceAttributeChanges
• sourceActivityId: string
• targetActivityId: string

{
    "type":"object",
    "properties":{
        "sourceActivityId":{
            "type":"string"
        },
        "targetActivityId":{
            "type":"string"
        },
        "dataObjectChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "instanceAttributeChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        },
        "correlationKeyChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariable"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object DataVariable

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

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

型: array

ソースを表示

• Array of: object DataVariable

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

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

型: array

ソースを表示

• Array of: object DataVariable

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

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

型: object

ソースを表示

• correlationKeyPropertyName: object QName
• name: string
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "correlationKeyPropertyName":{
            "$ref":"#/definitions/QName"
        }
    }
}

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

型: object

ソースを表示

• localPart: string
• namespaceURI: string
• prefix: string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

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

型: object

識別子: type

ソースを表示

• id: string
• identity: object Link
• levels: integer(int32)
• links: array links
• title: string
• type: string

{
    "type":"object",
    "discriminator":"type",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "identity":{
            "$ref":"#/definitions/Link"
        }
    },
    "xml":{
        "name":"identity",
        "namespace":"http://xmlns.oracle.com/bpm/rest/identities"
    }
}

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

型: object

ソースを表示

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

成功

本文()

ルート・スキーマ : TaskCollection

型: object

ソースを表示

• count: integer(int32)
• hasMore: boolean
• items: array items
• limit: integer(int32)
• links: array links
• offset: integer(int32)
• totalResult: boolean
• totalResults: integer(int32)
• userLink: object Link

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "userLink":{
            "xml":{
                "name":"user"
            },
            "$ref":"#/definitions/Link"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Task"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "totalResult":{
            "type":"boolean"
        }
    }
}

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

型: array

ソースを表示

• Array of: object task

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

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

型: array

ソースを表示

• Array of: object Link

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

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

型: object

ソースを表示

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

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

型: object

400レスポンス

不正リクエスト

401レスポンス

未認可

404レスポンス

タスク・リストが見つからない

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、RESTリソースに対するPUTリクエストを使用することによって、一連のタスクを別のユーザーに再割当てする方法を示しています。

リクエストの送信

https://example.com/ic/api/process/v1/tasks 

説明

• example.com は、Oracle Integrationが実行されているホストです。

リクエスト本文の例

例1:

{
   "action":{"id":"REASSIGN"},
   "tasks":["<taskId>"],
   "identities":
  [
   {"id":"<userId>","type":"user"}
  ]
}

説明

• <userId>はユーザーIDです。

  <taskId>は、アクションを実行するタスクのIDを指定します。

  複数のタスクを操作するには、","でIDを区切ります。

  現在のユーザーのタスクIDを取得するには、「タスク・リストの取得」を参照してください。

例2:

次の例では、2つのタスクを承認する場合のリクエスト本文を示します。

{
   "action":{"id":"APPROVE" , "type":"CUSTOM"},
   "comment":{"commentStr":"test" , "commentScope":"BPM"},
   "priority" : 1,:
   "tasks":[ "200002", "200006"]
 }

レスポンス・ヘッダーの例

Status Code: 200 OK
Date: Wed, 27 Apr 2016 00:53:16 GMT
Content-Type: application/json

レスポンス本文の例

{
   "totalResult": false,
   "hasMore": false,
   "items": 
  [ 
    {"href": "http://example.com/ic/api/process/v1/tasks/200002", 
     "length": 0, 
     "rel": "self", 
     "title": "Approver to review request and approve, reject, or request additional information", 
     "hasSubTasksFlag": false,
     "isDocsEnabledFlag": false,
     "isConversationEnabledFlag": false,
     "hasSubTasks": false 
     } 
   ], 
 "user": 
   { 
     "href": "http://example.com/ic/api/process/v1/identities/user/jsmith", 
      "length": 0,
      "rel": "user" 
    }
 }

先頭に戻る