Jump to

• Request
• Response
• Examples

Perform an Action on a Task

put

/ic/api/process/v1/tasks/{id}

Performs an action based on payload on a given task Number.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Task number

Body ()

Payload

Root Schema : payload

Type: object

Show Source

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

{
    "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"
        }
    },
    "xml":{
        "name":"payload",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : action

Type: object

Show Source

• abortType(optional): string
• activityChanges(optional): array activityChanges
• assignees(optional): array assignees
• comments(optional): string
• correlationKeyChanges(optional): array correlationKeyChanges
• dataObjectChanges(optional): array dataObjectChanges
• faultActionType(optional): string
• flowId(optional): integer(int64)
• id(optional): string
• instanceAttributeChanges(optional): array instanceAttributeChanges
• processes(optional): array processes
• type(optional): 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(optional): string
• commentStr(optional): string
• updatedBy(optional): string
• updateddDate(optional): string
• userId(optional): 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 : 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(optional): array correlationKeyChanges
• dataObjectChanges(optional): array dataObjectChanges
• instanceAttributeChanges(optional): array instanceAttributeChanges
• sourceActivityId(optional): string
• targetActivityId(optional): 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(optional): object QName
• name(optional): string
• value(optional): string

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

Nested Schema : QName

Type: object

Show Source

• localPart(optional): string
• namespaceURI(optional): string
• prefix(optional): string

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

Nested Schema : identity

Type: object

Discriminator: type

Show Source

• id(optional): string
• identity(optional): object Link
• levels(optional): integer(int32)
• links(optional): array links
• title(optional): string
• type(optional): 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(optional): string
• mediaType(optional): string
• rel(optional): 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 : task

Type: object

400 Response

The tasknumber is invalid.No action will be performed.

401 Response

Unauthorized

404 Response

Task not found.

409 Response

Conflict.

500 Response

Internal Server Error

Back to Top

Examples

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

Send Request

https://example.com/ic/api/process/v1/tasks/<taskId>

Where,

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

• <taskId> is the ID of task on which you want to perform the action.

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

Note: When you reassign to another user, delegate to another user, or request more information from another user, you need to add the Identities element in the request. When you claim(acquire) the task, do not specify the Identities attribute in the payload. Only the current user can claim the task.

Example of Request Body

Example 1:

The following example shows the request body when you reassign a task ID:

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

Where, <userId> is the user ID.

Example 2:

The following example shows the request body when you escalate or approve the task ID with a comment:

{ 
   "identities":[{"id":"jstein","type":"user" }],
   "action":{"id":"ESCALATE","type":"SYSTEM"}, 
   "comment":{"commentStr":"Some comment","commentScope":"BPM"}
 }

Example 3:

The following example shows the request body when you approve a task:

{
   "action":{"id":"APPROVE"} 
}

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