Jump to

• Request
• Response
• Examples

Perform Bulk Action on Tasks

put

/ic/api/process/v1/tasks

Performs action on multiple tasks based on the payload.

Request

Supported Media Types

• application/json

Body ()

Action Payload

Root Schema : actions

Type: object

Show Source

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

Nested Schema : action

Type: object

Show Source

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

Nested Schema : comment

Type: object

Show Source

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

Nested Schema : identities

Type: array

Show Source

• Array of: object identity
  Discriminator: type

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

Nested Schema : tasks

Type: array

Show Source

• Array of: string

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

Nested Schema : activityChanges

Type: array

Show Source

• Array of: object FlowChangeItemReq

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

Nested Schema : assignees

Type: array

Show Source

• Array of: object identity
  Discriminator: type

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

Nested Schema : correlationKeyChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : dataObjectChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : instanceAttributeChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : processes

Type: array

Show Source

• Array of: string

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

Nested Schema : FlowChangeItemReq

Type: object

Show Source

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

Nested Schema : correlationKeyChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : dataObjectChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : instanceAttributeChanges

Type: array

Show Source

• Array of: object DataVariable

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

Nested Schema : DataVariable

Type: object

Show Source

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

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

Nested Schema : QName

Type: object

Show Source

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

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

Nested Schema : identity

Type: object

Discriminator: type

Show Source

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

Nested Schema : Link

Type: object

Show Source

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

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : TaskCollection

Type: object

Show Source

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

Nested Schema : items

Type: array

Show Source

• Array of: object task

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

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

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

Nested Schema : task

Type: object

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task list not found

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to reassign set of tasks to a different user by using PUT request on the REST resource.

Send Request

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

Where,

• example.com is the host where Oracle Integration is running.

Example of Request Body

Example 1:

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

Where,

• <userId> is the user ID.

  <taskId> specifies the IDs of tasks on which you want to perform actions.

  To operate on multiple tasks, separate IDs with a ",".

  To get the task ID of the current user, see Retrieve a Task List.

Example 2:

The following example shows the request body when you approve two tasks.

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

Example of Response Header

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

Example of Response Body

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

Back to Top