REST interface for federated IBM BPM resources - Task Resource - PUT (Bulk Update) Method

Use this method to update the task properties, for example, the priority, category, or a custom property, for multiple task instances.

Sample method invocation

PUT /rest/bpm/federated/htm/v1/task[?domain={string}]&action={string}

Parameters

Optional Federation Parameter

Name	Value Type	Description
domain	string	Name of the domain containing the BPEL runtime systems that host the distributed resource.

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified tasks.

Value	Description
update	Change task properties (for example, priority, category, or a custom property).

Request Content

List of human tasks to be updated and updated field values.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Task Bulk Update", 
   "type": "object",
   "properties":
   {  "tasks": 
      [
         {  "systemID": { "type": "string",
               "description": "System ID of the system hosting the task the update operation is performed for."
            },
            "taskID": {"type": "string",
               "description": "Task ID of the task the update operation is performed for."
            }
         }
      ],
      "updatedPropertyValues" : 
      {  "businessRelevance": {"type": "boolean", "optional": true,
            "description": "States whether the task is a business relevant or an 'auxiliary' step."
         },
         "contextAuthorizationOfOwner": { "type": "string", "optional": true,
            "description": "Authorization rights of the task owner to the associated context."
         },
         "customProperties": { "type": "object", "optional": true, "additionalProperties": {"type": "string"},
            "description": "List of custom property names and values."
         },
         "deletionTime":  {"type": "string", "format": "date-time", "optional": true,
            "description": "Time when the task is deleted."
         },
         "description": {"type": "string", "optional": true,
            "description": "Description of the task."
         },
         "displayName": {"type": "string", "optional": true,
            "description": "Display name of the task."
         },
         "dueTime":  {"type": "string", "format": "date-time", "optional": true,
            "description": "Time when the task is due."
         },
         "durationUntilDeleted": {"type": "string", "optional": true,
            "description": "Duration that the task is kept after it has reached an end state."
         },
         "durationUntilDue": {"type": "string", "optional": true,
            "description": "Duration when the task becomes due."
         },
         "durationUntilExpires": {"type": "string", "optional": true,
            "description": "Duration when the task expires once it is activated."
         },
         "eventHandlerName": {"type": "string", "optional": true,
            "description": "Name of the associated event handler."
         },
         "expirationTime": {"type": "string", "format": "date-time", "optional": true,
            "description": "Time when the task instance will expire or was due to expire."
         },
         "isEscalated": {"type": "boolean", "optional": true,
            "description": "States whether an escalation occurred."
         },
         "isRead": {"type": "boolean", "optional": true,
            "description": "States whether the task instance is marked read."
         },
         "name": {"type": "string", "optional": true,
            "description": "Name of the task instance."
         },
         "namespace": {"type": "string", "optional": true,
            "description": "Namespace that categorizes the task instance."
         },
         "parentContextID": {"type": "string", "optional": true,
            "description": "ID of the parent context of the task instance."
         },
         "priority": {"type": "integer", "optional": true,
            "description": "Priority of the task instance."
         },
         "supportsClaimIfSuspended":{"type": "boolean", "optional": true,
            "description": "States whether the task can be claimed even if it is suspended."
         },
         "supportsDelegation": {"type": "boolean", "optional": true,
            "description": "States whether the task supports delegation, for example, by transferring work items."
         },
         "supportsFollowOnTasks": {"type": "boolean", "optional": true,
            "description": "States whether the task supports the creation of follow-on tasks."
         },
         "supportsSubTasks": {"type": "boolean", "optional": true,
            "description": "States whether the task supports the creation of subtasks."
         },
         "type": {"type": "string", "optional": true,
            "description": "Type of the task."
         },
         "workBasketName": {"type": "string", "optional": true,
            "description": "The name of the work basket the task belongs to."
         }
      }
   }
}

Response Content

Empty if all updates succeed. For failed individual updates, a report is returned.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Task Bulk Update Response", 
   "type": "object",
   "properties":
   {  "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description":"Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "description":"Message text of the exception."
            },
            "errorMessageParameters": {"type": ["string"], "optional": true,
               "description":"Message text parameters of the exception."
            },
            "programmersDetails": {"type": "object", "optional": true,
               "description":"Additional, exception details, for example, a stack trace."
            }
         }
      ],
      "failedUpdates": 
      [
         {  "systemID": {"type": "string",
               "description": "System ID of the system hosting the task."
            },
            "tkiid": {"type": "string",
               "description": "ID of a task where the operation has failed."
            },
            "errorNumber": {"type": "string",
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string",
               "description": "Message text of the exception."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "description": "Message text of the exception."
            },
            "errorMessageParameters": {"type": ["string"], "optional": true,
               "description": "Message text parameters of the exception."
            },
            "programmersDetails": {"type": "object", "optional": true,
               "description": "Additional, exception details, for example, a stack trace."
            },
            "status": {"type": "string", "optional": true,
               "description": "Status of the request."
            },
            "exceptionType": {"type": "string", "optional": true,
               "description": "Type of the exception."
            }      
         }
      ], 
      "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description": "Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "Additional, exception details, for example, a stack trace."
      },
      "status": {"type": "string", "optional": true,
         "description": "Status of the request."
      },
      "exceptionType": {"type": "string", "optional": true,
         "description": "Type of the exception."
      }      
   }
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful completion. A detailed report is returned.
400 Bad Request	The parameters are not valid or they are missing.
406 Not Acceptable	The requested content type or content encoding is not supported.
415 Unsupported Media Type	The content type or content encoding of the request is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.
503 Service Unavailable	The federated request could not be delivered to individual federation targets.
504 Gateway Timeout	The federated response has partial content because of missing individual responses.

Available since

7.5

Parent topic: Task Resource