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

Use this method to transfer multiple task instances.

Sample method invocation

PUT /rest/bpm/federated/htm/v1/task/role/{role}[?domain={string}]&action={string}[&toUser={string}][&fromUser={string}][&toGroup={string}][&fromGroup={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
transfer	Transfer multiple task instances.

Optional Parameters

Name	Value Type	Description
toUser	string	ID of the user the task is transferred to.
fromUser	string	ID of the user the task is transferred from (administrator scenario only) - can only be specified with toUser.
toGroup	string	ID of the group the task is transferred to (administrator scenario only) - can only be specified with fromGroup.
fromGroup	string	ID of the group the task is transferred from (administrator scenario only) - can only be specified with toGroup.

Request Content

List of human tasks to be transferred.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Task Bulk Operation", 
   "type": "object",
   "properties":
   {  "tasks": 
      [
         {  "systemID": { "type": "string",
               "description": "System ID of the system hosting the task the operation is performed for."
            },
            "taskID": {"type": "string",
               "description": "Task ID of the task the operation is performed for."
            }
         }
      ]
   }
}

Response Content

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

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Task Bulk Operation 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."
            }
         }
      ],
      "failedOperations": 
      [
         {  "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."
            }
         }
      ],
      "description": "List of task IDs for which the operation has failed."
   }
}

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 Role Resource