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

Use this method to transfer a task to another user or group.

Sample method invocation

PUT /rest/bpm/federated/htm/v1/task/{tkiid}/role/{role}?systemID={string}&action={string}[&toUser={string}][&fromUser={string}][&toGroup={string}][&fromGroup={string}]

Parameters

Required Federation Parameter

Name	Value Type	Description
systemID	string	ID of the BPEL runtime system hosting the resource.

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified task.

Value	Description
transfer	Transfer a task to another user.

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

None

Response Content

None

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	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The task does not exist.
409 Conflict	A conflict exists with the current state of the resource.
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 Instance Role Resource