The following table lists all generic API operations provided by the Human Task Manager component.
| EJB Java Interface HumanTaskManagerService |
Web Service WSDL Port Type HTMJAXWSPortType (V7) |
REST HTTP Base URL /rest/bpm/htm |
|---|---|---|
| Call Task - Synchronously calls a request-response operation provided by a human task. | ||
|
ClientObjectWrapper callTask( String tkiid, ClientObjectWrapper input ) ClientObjectWrapper callTask( TKIID tkiid, ClientObjectWrapper input ) [WSDL: callTask] |
Operation callTask - Input element callTask contents: -- Element tkiid of type xsd:string
-- Element input of type bct:UserDataType - Output element callTaskResponse contents: -- Element output of type bct:UserDataType
|
POST /rest/bpm/htm/task?taskTemplateID={taskTemplateID}&mode=sync[&relation={relation}][&parentTaskID={parentTaskID}] - Request message (optional) (XML): user-defined schema - Response message (JSON): HTM Task |
| Cancel Claim - Releases one or more claimed task instances. | ||
|
void cancelClaim( String tkiid ) void cancelClaim( TKIID tkiid ) void cancelClaim( String tkiid, boolean keepTaskData ) void cancelClaim( TKIID tkiid, boolean keepTaskData ) [WSDL: cancelClaim] List cancelClaim( String[] identifiers ) List cancelClaim( TKIID[] tkiids ) |
Operation cancelClaim - Input element cancelClaim contents: -- Element tkiid of type xsd:string
-- Element keepTaskData of type xsd:boolean - Output element cancelClaimResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=cancel PUT /rest/bpm/htm/task?action=cancel - Request message (JSON): HTM Task Bulk Operation - Response message (JSON): HTM Task Bulk Operation Response |
| Claim - Claims a ready to-do or collaboration task instance for user processing. | ||
|
ClientObjectWrapper claim( String tkiid ) [WSDL: claim] ClientObjectWrapper claim( TKIID tkiid ) Task claim( String whereClause, String orderByClause, java.util.TimeZone timeZone ) [WSDL: claimByQuery] ClaimResult claim( String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, List parameters, int maxRetryCount ) List claim( String[] identifiers ) List claim( TKIID[] tkiids ) |
Operation claim - Input element claim contents: -- Element tkiid of type xsd:string
- Output element claimResponse contents: -- Element input of type bct:UserDataType
Operation claimByQuery - Input element claimByQuery contents: -- Element whereClause of type xsd:string
-- Element orderByClause of type xsd:string -- Element timeZone of type xsd:string - Output element claimByQueryResponse contents: -- Element taskInstance of type htt:TaskInstanceType
|
PUT /rest/bpm/htm/task/{tkiid}?action=claim - Response message (XML): user-defined schema PUT /rest/bpm/htm/task?action=claim - Request message (JSON): HTM Task Bulk Operation - Response message (JSON): HTM Task Bulk Operation Response PUT /rest/bpm/htm/task?action=claimNext&query={query}&queryTableName={queryTableName}[&queryFilter={queryFilter}][&sortAttributes={sortAttributes}][&everybody={everybody}][&individual={individual}][&group={group}][&inherited={inherited}][&admin={admin}][&onBehalfUser={onBehalfUser}][&maxRetryCount={maxRetryCount}] - Response message (XML): HTM Claim Result PUT /rest/bpm/htm/task?action=getNext&query={query}[&queryFilter={queryFilter}][&sortAttributes={sortAttributes}][&everybody={everybody}][&individual={individual}][&group={group}][&inherited={inherited}][&admin={admin}][&onBehalfUser={onBehalfUser}][&maxRetryCount={maxRetryCount}] - Response message (JSON): HTM Task Get Next Response |
| CompleteComplete - Completes a claimed task instance. | ||
|
void complete( String tkiid ) [WSDL: complete] void complete( TKIID tkiid ) void complete( String tkiid, ClientObjectWrapper output ) [WSDL: completeWithOutput] void complete( TKIID tkiid, ClientObjectWrapper output ) void complete( String tkiid, String faultName, ClientObjectWrapper faultMessage ) [WSDL: completeWithFault] void complete( TKIID tkiid, String faultName, ClientObjectWrapper faultMessage ) List complete( String[] tkiids ) List complete( TKIID[] tkiids ) |
Operation complete - Input element complete contents: -- Element tkiid of type xsd:string
- Output element completeResponse contents: -- (none) Operation completeWithOutput - Input element completeWithOutput contents: -- Element tkiid of type xsd:string
-- Element output of type bct:UserDataType - Output element completeWithOutputResponse contents: -- (none) Operation completeWithFault - Input element completeWithFault contents: -- Element tkiid of type xsd:string
-- Element faultName of type xsd:string -- Element fault of type bct:UserDataType - Output element completeWithFaultResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=complete[&faultName={faultName}] - Request message (optional) (XML): user-defined schema |
| Complete With Follow-On Task - Completes a task instance and starts a follow-on task. | ||
|
void completeWithFollowOnTask( String tkiid, String followOnID, ClientObjectWrapper input ) void completeWithFollowOnTask( TKIID tkiid, TKIID followOnID, ClientObjectWrapper input ) [WSDL: completeWithFollowOnTask] |
Operation completeWithFollowOnTask - Input element completeWithFollowOnTask contents: -- Element tkiid of type xsd:string
-- Element followOnID of type xsd:string -- Element output of type bct:UserDataType (0..1) - Output element completeWithFollowOnTaskResponse contents: -- (none) |
(none) |
| Complete With New Follow-On Task - Completes a task instance and creates and starts a follow-on task. | ||
|
void completeWithNewFollowOnTask( String tkiid, String name, String namespace, ClientObjectWrapper input ) [WSDL: completeWithNewFollowOnTask] void completeWithNewFollowOnTask( TKIID tkiid, String name, String namespace, ClientObjectWrapper input ) void completeWithNewFollowOnTask( String tkiid, TaskModel taskModel, String applicationName, ClientObjectWrapper input ) void completeWithNewFollowOnTask( TKIID tkiid, TaskModel taskModel, String applicationName, ClientObjectWrapper input ) |
Operation completeWithNewFollowOnTask - Input element completeWithNewFollowOnTask contents: -- Element tkiid of type xsd:string
-- Element name of type xsd:string -- Element namespaceName of type xsd:string -- Element output of type bct:UserDataType (0..1) - Output element completeWithNewFollowOnTaskResponse contents: -- (none) |
(none) |
| Create And Call Task - Creates and synchronously executes an invocation task instance. | ||
|
ClientObjectWrapper createAndCallTask( String tktid, ClientObjectWrapper input ) ClientObjectWrapper createAndCallTask( TKTID tktid, ClientObjectWrapper input ) ClientObjectWrapper createAndCallTask( String name, String namespace, ClientObjectWrapper input ) [WSDL: createAndCallTask] |
Operation createAndCallTask - Input element createAndCallTask contents: -- Element name of type xsd:string
-- Element namespaceName of type xsd:string -- Element input of type bct:UserDataType - Output element createAndCallTaskResponse contents: -- Element output of type bct:UserDataType
|
POST /rest/bpm/htm/task?taskTemplateID={taskTemplateID}&mode=sync[&relation={relation}][&parentTaskID={parentTaskID}] - Request message (optional) (XML): user-defined schema - Response message (XML): user-defined schema |
| Create And Start Task - Creates and starts a task instance. | ||
|
TKIID createAndStartTask( String tktid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler ) TKIID createAndStartTask( TKTID tktid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler ) TKIID createAndStartTask( String name, String namespace, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler ) [WSDL: createAndStartTask] TKIID createAndStartTask( TaskModel taskModel, String applicationName, String parentContext, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler ) |
Operation createAndStartTask - Input element createAndStartTask contents: -- Element name of type xsd:string
-- Element namespaceName of type xsd:string -- Element input of type bct:UserDataType - Output element createAndStartTaskResponse contents: -- Element tKIID of type xsd:string
Operation callAsync - Input element callAsync contents: -- Element name of type xsd:string
-- Element namespaceName of type xsd:string -- Element input of type bct:UserDataType -- Element replyTo of type bct:ReplyToType - Output element callAsyncResponse contents: -- (none) |
POST /rest/bpm/htm/task?taskTemplateID={taskTemplateID}&mode=async[&relation={relation}][&parentTaskID={parentTaskID}] - Request message (optional) (XML): user-defined schema - Response message (JSON): HTM Task |
| Create And Start Task As SubTask - Creates and starts a task instance as a subtask of the specified parent task instance. | ||
|
TKIID createAndStartTaskAsSubTask( String tktid, String parentTaskID, ClientObjectWrapper input ) TKIID createAndStartTaskAsSubTask( TKTID tktid, TKIID parentTaskID, ClientObjectWrapper input ) TKIID createAndStartTaskAsSubTask( String name, String namespace, String parentTaskID, ClientObjectWrapper input ) [WSDL: createAndStartTaskAsSubTask] TKIID createAndStartTaskAsSubTask( String name, String namespace, TKIID parentTaskID, ClientObjectWrapper input ) TKIID createAndStartTaskAsSubTask( TaskModel taskModel, String applicationName, String parentTaskID, ClientObjectWrapper input ) TKIID createAndStartTaskAsSubTask( TaskModel taskModel, String applicationName, TKIID parentTaskID, ClientObjectWrapper input ) |
Operation createAndStartTaskAsSubTask - Input element createAndStartTaskAsSubTask contents: -- Element name of type xsd:string
-- Element namespaceName of type xsd:string -- Element parentTaskID of type xsd:string -- Element input of type bct:UserDataType - Output element createAndStartTaskAsSubTaskResponse contents: -- Element tKIID of type xsd:string
|
POST /rest/bpm/htm/task?taskTemplateID={taskTemplateID}&mode=async&relation=subtask&parentTaskID={tkiid} - Request message (optional) (XML): user-defined schema - Response message (JSON): HTM Task |
| Create Business Category - Creates a business category from the specified business category definition. | ||
|
BCID createBusinessCategory( BusinessCategoryDefinition businessCategoryDefinition ) BCID createBusinessCategory( BusinessCategoryDefinition businessCategoryDefinition, String parentNameOrID ) BCID createBusinessCategory( BusinessCategoryDefinition businessCategoryDefinition, BCID parentBCID ) |
(none) |
POST /rest/bpm/htm/businessCategory[?parentBusinessCategory={parentBusinessCategory}][&locale={locale}] - Request message (JSON): HTM Business Category Create - Response message (JSON): HTM Business Category |
| Create Fault Message - Creates a fault message for a fault that is defined by the specified task instance. | ||
|
ClientObjectWrapper createFaultMessage( String identifier, String faultName ) ClientObjectWrapper createFaultMessage( TKTID tktid, String faultName ) ClientObjectWrapper createFaultMessage( TKIID tkiid, String faultName ) |
(none) |
GET /rest/bpm/htm/task/{tkiid}/fault?new=true&faultName={faultName} - Response message (XML): user-defined schema |
| Create Input Message - Creates an input message for the specified task template or task instance. | ||
|
ClientObjectWrapper createInputMessage( String identifier ) ClientObjectWrapper createInputMessage( TKIID tkiid ) ClientObjectWrapper createInputMessage( TKTID tktid ) |
(none) |
GET /rest/bpm/htm/taskTemplate/{tktid}/input - Response message (XML): user-defined schema GET /rest/bpm/htm/task/{tkiid}/input?new=true - Response message (XML): user-defined schema |
| Create Output Message - Creates an output message for the specified task instance. | ||
|
ClientObjectWrapper createOutputMessage( String identifier ) ClientObjectWrapper createOutputMessage( TKTID tktid ) ClientObjectWrapper createOutputMessage( TKIID tkiid ) |
(none) |
GET /rest/bpm/htm/task/{tkiid}/output?new=true - Response message (XML): user-defined schema |
| Create Stored Query - Creates a query definition and persistently stores it in the database. | ||
|
void createStoredQuery( String storedQueryName, String selectClause, String whereClause, String orderByClause, Integer threshold, java.util.TimeZone timeZone ) void createStoredQuery( String storedQueryName, String selectClause, String whereClause, String orderByClause, Integer threshold, java.util.TimeZone timeZone, java.util.List storedQueryProperties, String clientType ) [WSDL: createStoredQuery] void createStoredQuery( String userID, String storedQueryName, String selectClause, String whereClause, String orderByClause, Integer threshold, java.util.TimeZone timeZone, java.util.List storedQueryProperties, String clientType ) |
Operation createStoredQuery - Input element createStoredQuery contents: -- Element storedQuery of type bct:StoredQueryType
- Output element createStoredQueryResponse contents: -- (none) |
(none) |
| Create Task - Creates a task instance. | ||
|
TKIID createTask( String tktid, ClientObjectWrapper input ) TKIID createTask( TKTID tktid, ClientObjectWrapper input ) TKIID createTask( String name, String namespace ) TKIID createTask( String name, String namespace, ClientObjectWrapper input ) [WSDL: createTask] TKIID createTask( TaskModel taskModel, String applicationName, String parentContext ) TKIID createTask( TaskModel taskModel, String applicationName, String parentContext, ClientObjectWrapper input ) |
Operation createTask - Input element createTask contents: -- Element name of type xsd:string
-- Element namespaceName of type xsd:string -- Element input of type bct:UserDataType (0..1) - Output element createTaskResponse contents: -- Element tkiid of type xsd:string
|
POST /rest/bpm/htm/task?taskTemplateID={taskTemplateID}&mode=createOnly[&relation={relation}][&parentTaskID={parentTaskID}] - Request message (optional) (XML): user-defined schema - Response message (JSON): HTM Task POST /rest/bpm/htm/task?action=createLeanTask - Request message (JSON): HTM Create Lean Task - Response message (JSON): HTM Task |
| Create Task Template - Creates a task template from the specified task model. | ||
|
TKTID createTaskTemplate( TaskModel taskModel, String applicationName ) |
(none) |
(none) |
| Create Work Basket - Creates a work basket from the specified work basket definition. | ||
|
WBID createWorkBasket( WorkBasketDefinition workBasketDefinition ) |
(none) |
POST /rest/bpm/htm/workBasket[?locale={locale}] - Request message (JSON): HTM Work Basket Create - Response message (JSON): HTM Work Basket |
| Create Work Item - Creates a user work item for the specified task or escalation instance. | ||
|
void createWorkItem( String identifier, int assignmentReason, String userID ) [WSDL: createWorkItem] void createWorkItem( TKIID tkiid, int assignmentReason, String userID ) void createWorkItem( ESIID esiid, int assignmentReason, String userID ) |
Operation createWorkItem - Input element createWorkItem contents: -- Element identifier of type xsd:string
-- Element assignmentReason of type xsd:integer -- Element userID of type xsd:string - Output element createWorkItemResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}/role/{role}?action=assign&newUser={newUser} |
| Delete'>Delete - Deletes the specified task instance. | ||
|
void delete( String tkiid ) [WSDL: deleteTask] void delete( TKIID tkiid ) void delete( String identifier, boolean deleteInstances ) void delete( TKTID tktid, boolean deleteInstances ) |
Operation deleteTask - Input element deleteTask contents: -- Element tkiid of type xsd:string
- Output element deleteTaskResponse contents: -- (none) |
DELETE /rest/bpm/htm/task/{tkiid} |
| Delete Business Category - Deletes the specified business category. | ||
|
List deleteBusinessCategory( String identifier, boolean recursive ) List deleteBusinessCategory( BCID bcid, boolean recursive ) |
(none) |
DELETE /rest/bpm/htm/businessCategory/{bcid}[?recursive={recursive}] - Response message (JSON): HTM Business Category Delete Response |
| Delete Stored Query - Deletes the specified stored query. | ||
|
void deleteStoredQuery( String storedQueryName ) [WSDL: deleteStoredQuery] void deleteStoredQuery( String userID, String storedQueryName ) |
Operation deleteStoredQuery - Input element deleteStoredQuery contents: -- Element storedQueryName of type xsd:string
- Output element deleteStoredQueryResponse contents: -- (none) |
(none) |
| Delete Work Basket - Deletes the specified work basket. | ||
|
void deleteWorkBasket( String identifier ) void deleteWorkBasket( WBID wbid ) |
(none) |
DELETE /rest/bpm/htm/workBasket/{wbid} |
| Delete Work Item - Deletes the specified user work item. | ||
|
void deleteWorkItem( String identifier, int assignmentReason, String userID ) [WSDL: deleteWorkItem] void deleteWorkItem( TKIID tkiid, int assignmentReason, String userID ) void deleteWorkItem( ESIID esiid, int assignmentReason, String userID ) |
Operation deleteWorkItem - Input element deleteWorkItem contents: -- Element identifier of type xsd:string
-- Element assignmentReason of type xsd:integer -- Element userID of type xsd:string - Output element deleteWorkItemResponse contents: -- (none) |
(none) |
| Distribute Tasks To Work Basket - Distributes the specified task instances to the specified work basket. | ||
|
List distributeTasksToWorkBasket( String[] tkiids, String identifier ) List distributeTasksToWorkBasket( TKIID[] tkiids, WBID wbid ) |
(none) |
PUT /rest/bpm/htm/workBasket/{wbid}?action=distributeToWorkBasket[&taskID={taskID}] - Request message (JSON): HTM Work Basket Bulk Task Operation - Response message (JSON): HTM Work Basket Bulk Task Operation Response |
| Find Query Table Metadata - Queries the metadata of query tables. | ||
|
List findQueryTableMetaData( MetaDataOptions metaDataOptions ) |
Operation findQueryTableMetaData - Input element findQueryTableMetaData contents: -- Element metaDataOptions of type bct:MetaDataOptionsType
- Output element findQueryTableMetaDataResponse contents: -- Element queryTableMetaDataSet of type bct:QueryTableMetaDataSetType
|
GET /rest/bpm/htm/businessCategories/queryTables[?sourceAttributes={sourceAttributes}][&userParametersAllowed={userParametersAllowed}][&authorizationType={authorizationType}][&kind={kind}] - Response message (JSON): HTM Query Table List GET /rest/bpm/htm/taskTemplates/queries[?sourceAttributes={sourceAttributes}][&content={content}][&userParametersAllowed={userParametersAllowed}][&authorizationType={authorizationType}][&kind={kind}] - Response message (JSON): HTM Queries GET /rest/bpm/htm/tasks/queries[?sourceAttributes={sourceAttributes}][&content={content}][&userParametersAllowed={userParametersAllowed}][&authorizationType={authorizationType}][&kind={kind}] - Response message (JSON): HTM Queries GET /rest/bpm/htm/escalations/queryTables[?sourceAttributes={sourceAttributes}][&userParametersAllowed={userParametersAllowed}][&authorizationType={authorizationType}][&kind={kind}] - Response message (JSON): HTM Query Table List GET /rest/bpm/htm/workBaskets/queryTables[?sourceAttributes={sourceAttributes}][&userParametersAllowed={userParametersAllowed}][&authorizationType={authorizationType}][&kind={kind}] - Response message (JSON): HTM Query Table List |
| Get Activity ID - Retrieves the object ID of the activity instance associated to the specified task instance. | ||
|
AIID getActivityID( String tkiid ) [WSDL: getActivityID] AIID getActivityID( TKIID tkiid ) |
Operation getActivityID - Input element getActivityID contents: -- Element tkiid of type xsd:string
- Output element getActivityIDResponse contents: -- Element aiid of type xsd:string
|
(none) |
| Get All Custom Properties - Retrieves all custom properties of the specified task template or task instance. | ||
|
List getAllCustomProperties( String identifier ) List getAllCustomProperties( TKTID tktid ) List getAllCustomProperties( TKIID tkiid ) |
(none) |
(none) |
| Get All Work Items - Returns all work item assignments associated to specified task or escalation instance. | ||
|
WorkItem[] getAllWorkItems( String identifier ) WorkItem[] getAllWorkItems( ESIID esiid ) WorkItem[] getAllWorkItems( TKIID tkiid ) |
(none) |
(none) |
| Get All Work Items For Business Category - Returns all work item assignments associated to the specified business category. | ||
|
WorkItem[] getAllWorkItemsForBusinessCategory( String identifier ) WorkItem[] getAllWorkItemsForBusinessCategory( BCID bcid ) |
(none) |
(none) |
| Get All Work Items For Work Basket - Returns all work item assignments associated to the specified work basket. | ||
|
WorkItem[] getAllWorkItemsForWorkBasket( String identifier ) WorkItem[] getAllWorkItemsForWorkBasket( WBID wbid ) |
(none) |
(none) |
| Get Application Component - Retrieves the specified application component. | ||
|
ApplicationComponent getApplicationComponent( String acoid ) ApplicationComponent getApplicationComponent( ACOID acoid ) |
(none) |
(none) |
| Get Available Action Flags - Returns the actions that can be called for the specified tasks or escalations. | ||
|
boolean[][] getAvailableActionFlags( String[] identifiers ) boolean[][] getAvailableActionFlags( ESIID[] esiids ) boolean[][] getAvailableActionFlags( TKIID[] tkiids ) |
(none) |
(none) |
| Get Available Action Flags For Business Categories - Returns the actions that can be called for the specified business categories by the logged-on user. | ||
|
boolean[][] getAvailableActionFlagsForBusinessCategories( String[] identifiers ) boolean[][] getAvailableActionFlagsForBusinessCategories( BCID[] bcids ) |
(none) |
(none) |
| Get Available Action Flags For Work Baskets - Returns the actions that can be called for the specified work baskets by the logged-on user. | ||
|
boolean[][] getAvailableActionFlagsForWorkBaskets( String[] identifiers ) boolean[][] getAvailableActionFlagsForWorkBaskets( WBID[] wbids ) |
(none) |
(none) |
| Get Available Actions - Returns the actions that can be called by the logged-on user for the specified task instance, task template, escalation instance, or escalation template. | ||
|
int[] getAvailableActions( String identifier ) int[] getAvailableActions( ESTID estid ) int[] getAvailableActions( ESIID esiid ) int[] getAvailableActions( TKIID tkiid ) int[] getAvailableActions( TKTID tktid ) |
(none) |
GET /rest/bpm/htm/task/actions?taskIDs={taskIDs}[&actions={actions}] - Response message (JSON): HTM Task Actions |
| Get Available Actions For Business Category - Returns the actions that can be called by the logged-on user for the specified business category. | ||
|
int[] getAvailableActionsForBusinessCategory( String identifier ) int[] getAvailableActionsForBusinessCategory( BCID bcid ) |
(none) |
(none) |
| Get Available Actions For Work Basket - Returns the actions that can be called by the logged-on user for the specified work basket. | ||
|
int[] getAvailableActionsForWorkBasket( String identifier ) int[] getAvailableActionsForWorkBasket( WBID wbid ) |
(none) |
(none) |
| Get Binary Custom Property - Retrieves the named binary custom property of the specified task or escalation instance. | ||
|
BinaryCustomProperty getBinaryCustomProperty( String identifier, String propertyName ) BinaryCustomProperty getBinaryCustomProperty( ESIID esiid, String propertyName ) BinaryCustomProperty getBinaryCustomProperty( TKIID tkiid, String propertyName ) |
(none) |
GET /rest/bpm/htm/task/{tkiid}/binaryCustomProperty/{name} - Response message: (user-defined) |
| Get Binary Custom Property Metadata - Retrieves metadata information of a binary custom property of a task. | ||
|
(none) |
(none) |
GET /rest/bpm/htm/task/{tkiid}/binaryCustomProperty/{name}/metadata - Response message (JSON): HTM Task Binary Custom Property Metadata |
| Get Binary Custom Property Names - Retrieves the names of all binary custom properties of the specified task or escalation instance. | ||
|
List getBinaryCustomPropertyNames( String identifier ) List getBinaryCustomPropertyNames( ESIID esiid ) List getBinaryCustomPropertyNames( TKIID tkiid ) |
(none) |
(none) |
| Get Business Category - Retrieves the specified business category. | ||
|
BusinessCategory getBusinessCategory( String identifier ) BusinessCategory getBusinessCategory( BCID bcid ) |
(none) |
GET /rest/bpm/htm/businessCategory/{bcid}?getDefinition=false[&locale={locale}] - Response message (JSON): HTM Business Category |
| Get Business Category Definition - Retrieves the specified business category definition. | ||
|
BusinessCategoryDefinition getBusinessCategoryDefinition( String identifier ) BusinessCategoryDefinition getBusinessCategoryDefinition( BCID bcid ) |
(none) |
GET /rest/bpm/htm/businessCategory/{bcid}?getDefinition=true[&locale={locale}] - Response message (JSON): HTM Business Category |
| Get Custom Properties - Retrieves all custom properties of the specified task template or task instance. | ||
|
List getCustomProperties( String identifier ) List getCustomProperties( ESTID estid ) List getCustomProperties( ESIID esiid ) List getCustomProperties( TKTID tktid ) [WSDL: getCustomPropertiesForTaskTemplate] List getCustomProperties( TKIID tkiid ) [WSDL: getCustomPropertiesForTaskInstance] |
Operation getCustomPropertiesForTaskTemplate - Input element getCustomPropertiesForTaskTemplate contents: -- Element tktid of type xsd:string
- Output element getCustomPropertiesForTaskTemplateResponse contents: -- Element customProperties of type bct:CustomPropertiesType (0..1)
Operation getCustomPropertiesForTaskInstance - Input element getCustomPropertiesForTaskInstance contents: -- Element tkiid of type xsd:string
- Output element getCustomPropertiesForTaskInstanceResponse contents: -- Element customProperties of type bct:CustomPropertiesType (0..1)
|
(none) |
| Get Custom Property - Retrieves the named custom property of the specified task instance, task template, escalation instance, or escalation template. | ||
|
String getCustomProperty( String identifier, String propertyName ) String getCustomProperty( ESTID estid, String propertyName ) String getCustomProperty( ESIID esiid, String propertyName ) String getCustomProperty( TKTID tktid, String propertyName ) String getCustomProperty( TKIID tkiid, String propertyName ) |
(none) |
(none) |
| Get Custom Property Info - Retrieves information about custom properties of the specified object types. | ||
|
List getCustomPropertyInfo( int objectType, String nameFilter, Integer threshold ) |
(none) |
(none) |
| Get Custom Property Names - Retrieves the names of all custom properties of the specified task instance, task template, escalation instance, or escalation template. | ||
|
List getCustomPropertyNames( String identifier ) List getCustomPropertyNames( ESTID estid ) List getCustomPropertyNames( ESIID esiid ) List getCustomPropertyNames( TKTID tktid ) List getCustomPropertyNames( TKIID tkiid ) |
(none) |
(none) |
| Get Distribution Targets - Retrieves the distribution targets of the specified work basket. | ||
|
List getDistributionTargets( String identifier ) List getDistributionTargets( WBID wbid ) |
(none) |
GET /rest/bpm/htm/workBasket/{wbid}/distributionTargets[?locale={locale}] - Response message (JSON): HTM Work Basket Distribution Targets |
| Get Documentation - Retrieves the documentation of the specified object. | ||
|
String getDocumentation( String identifier, Locale locale ) String getDocumentation( ESIID esiid, Locale locale ) String getDocumentation( ESTID estid, Locale locale ) String getDocumentation( TKIID tkiid, Locale locale ) String getDocumentation( TKTID tktid, Locale locale ) |
(none) |
(none) |
| Get Escalation - Retrieves the specified escalation instance. | ||
|
Escalation getEscalation( String tkiid, String escalationName ) Escalation getEscalation( String esiid ) [WSDL: getEscalation] Escalation getEscalation( ESIID esiid ) Escalation getEscalation( TKIID tkiid, String escalationName ) |
Operation getEscalation - Input element getEscalation contents: -- Element esiid of type xsd:string
- Output element getEscalationResponse contents: -- Element escalation of type htt:EscalationType
|
GET /rest/bpm/htm/escalation/{esiid} - Response message (JSON): HTM Escalation |
| Get Escalation Info - Retrieves the specified escalation information. | ||
|
EscalationInfo getEscalationInfo( String tkiid ) EscalationInfo getEscalationInfo( TKIID tkiid ) |
(none) |
GET /rest/bpm/htm/task/{tkiid}/escalationInfo - Response message (JSON): HTM Escalation Info |
| Get Escalation Template - Retrieves the specified escalation template. | ||
|
EscalationTemplate getEscalationTemplate( String estid ) [WSDL: getEscalationTemplate] EscalationTemplate getEscalationTemplate( ESTID estid ) |
Operation getEscalationTemplate - Input element getEscalationTemplate contents: -- Element estid of type xsd:string
- Output element getEscalationTemplateResponse contents: -- Element escalationTemplate of type htt:EscalationTemplateType
|
(none) |
| Get Fault Message - Retrieves the fault message of the specified task instance. | ||
|
ClientObjectWrapper getFaultMessage( String tkiid ) [WSDL: getFaultMessage] ClientObjectWrapper getFaultMessage( TKIID tkiid ) |
Operation getFaultMessage - Input element getFaultMessage contents: -- Element tkiid of type xsd:string
- Output element getFaultMessageResponse contents: -- Element fault of type bct:UserDataType
|
GET /rest/bpm/htm/task/{tkiid}/fault?new=false&faultName={faultName} - Response message (XML): user-defined schema |
| Get Fault Names - Retrieves the fault names defined for the specified task instance. | ||
|
List getFaultNames( String identifier ) List getFaultNames( TKTID tktid ) List getFaultNames( TKIID tkiid ) |
(none) |
(none) |
| Get Group Details - Returns details about the specified groups. | ||
|
List getGroupDetails( String[] groupNames, String[] groupProperties, String[] userProperties, String[] subGroupProperties, Integer threshold ) |
(none) |
(none) |
| Get Group Names - Returns the names of groups the logged-on user is part of. | ||
|
String[] getGroupNames( ) |
(none) |
(none) |
| Get HTM Configuration - Returns configuration settings of the Human Task Manager. | ||
|
HtmConfiguration getHtmConfiguration( ) [WSDL: getHtmConfiguration] |
Operation getHtmConfiguration - Input element getHtmConfiguration contents: -- (none) - Output element getHtmConfigurationResponse contents: -- Element htmConfiguration of type htt:HtmConfigurationType
|
GET /rest/bpm/htm/systems - Response message (JSON): HTM Systems |
| Get Inline Custom Property - Retrieves the named inline custom property of the specified task template or task instance. | ||
|
InlineCustomProperty getInlineCustomProperty( String identifier, String propertyName ) InlineCustomProperty getInlineCustomProperty( TKTID tktid, String propertyName ) InlineCustomProperty getInlineCustomProperty( TKIID tkiid, String propertyName ) |
(none) |
(none) |
| Get Input Message - Retrieves the input message of the specified task instance. | ||
|
ClientObjectWrapper getInputMessage( String tkiid ) [WSDL: getInputMessage] ClientObjectWrapper getInputMessage( TKIID tkiid ) |
Operation getInputMessage - Input element getInputMessage contents: -- Element tkiid of type xsd:string
- Output element getInputMessageResponse contents: -- Element input of type bct:UserDataType
|
GET /rest/bpm/htm/task/{tkiid}/input?new=false - Response message (XML): user-defined schema |
| Get Input UI Settings - Retrieves input client interface settings for the specified task instance. | ||
|
(none) |
(none) |
|
| Get Message Text Of Exception - Retrieves the message text associated to the specified message key and locale. | ||
|
String getMessageTextOfException( Locale locale, String messageKey, Object[] variableValues ) [WSDL: getMessageTextOfException] |
Operation getMessageTextOfException - Input element getMessageTextOfException contents: -- Element locale of type xsd:string
-- Element messageKey of type xsd:string -- Element messageParameters of type bct:MessageParametersType (0..1) - Output element getMessageTextOfExceptionResponse contents: -- Element messageText of type xsd:string
|
(none) |
| Get Operation Mode - Indicates whether the human task manager database is used as an archive. | ||
|
int getOperationMode( ) |
(none) |
(none) |
| Get Output Message - Retrieves the output message of the specified task instance. | ||
|
ClientObjectWrapper getOutputMessage( String tkiid ) [WSDL: getOutputMessage] ClientObjectWrapper getOutputMessage( TKIID tkiid ) |
Operation getOutputMessage - Input element getOutputMessage contents: -- Element tkiid of type xsd:string
- Output element getOutputMessageResponse contents: -- Element output of type bct:UserDataType
|
GET /rest/bpm/htm/task/{tkiid}/output?new=false - Response message (XML): user-defined schema |
| Get Output UI Settings - Retrieves output client interface settings for the specified task instance. | ||
|
(none) |
(none) |
|
| Get Process ID - Retrieves the object ID of the BPEL process instance that contains the specified task instance. | ||
|
PIID getProcessID( String tkiid ) [WSDL: getProcessID] PIID getProcessID( TKIID tkiid ) |
Operation getProcessID - Input element getProcessID contents: -- Element tkiid of type xsd:string
- Output element getProcessIDResponse contents: -- Element piid of type xsd:string
|
(none) |
| Get Query Table Metadata - Returns the definition of the specified query table. | ||
|
QueryTableMetaData getQueryTableMetaData( String queryTableName, Locale locale ) |
Operation getQueryTableMetaData - Input element getQueryTableMetaData contents: -- Element queryTableName of type xsd:string
-- Element locale of type xsd:string - Output element getQueryTableMetaDataResponse contents: -- Element queryTableMetaData of type bct:QueryTableMetaDataType
|
GET /rest/bpm/htm/businessCategories/queryTable/{queryTable}/attributes - Response message (JSON): HTM Query Table Attribute List GET /rest/bpm/htm/taskTemplates/query/{query}/attributes - Response message (JSON): HTM Query Attribute List GET /rest/bpm/htm/tasks/query/{query}/attributes - Response message (JSON): HTM Query Attribute List GET /rest/bpm/htm/escalations/queryTable/{queryTable}/attributes - Response message (JSON): HTM Query Table Attribute List GET /rest/bpm/htm/workBaskets/queryTable/{queryTable}/attributes - Response message (JSON): HTM Query Table Attribute List |
| Get Resource - Retrieves a client resource for a specified human task template. | ||
|
(none) |
(none) |
GET /rest/bpm/htm/taskTemplate/{tktid}/resource?clientType={clientType}&resourceName={resourceName} - Response message: (user-defined) |
| Get Stored Query - Retrieves the specified stored query definition. | ||
|
StoredQuery getStoredQuery( String storedQueryName ) [WSDL: getStoredQuery] StoredQuery getStoredQuery( String userID, String storedQueryName ) StoredQuery getStoredQuery( int kind, String storedQueryName ) |
Operation getStoredQuery - Input element getStoredQuery contents: -- Element storedQueryName of type xsd:string
- Output element getStoredQueryResponse contents: -- Element storedQuery of type bct:StoredQueryType
|
(none) |
| Get Stored Query Names - Retrieves the names of stored queries that are persistently stored in the database. | ||
|
String[] getStoredQueryNames( ) [WSDL: getStoredQueryNames] String[] getStoredQueryNames( String userID ) String[] getStoredQueryNames( int kind ) |
Operation getStoredQueryNames - Input element getStoredQueryNames contents: -- (none) - Output element getStoredQueryNamesResponse contents: -- Element storedQueryNames of type bct:StoredQueryNamesType (0..1)
|
(none) |
| Get SubTask IDs - Retrieves the object IDs of all task instances that are subtasks of the specified task instance | ||
|
List getSubTaskIDs( String tkiid ) [WSDL: getSubTaskIDs] List getSubTaskIDs( TKIID tkiid ) |
Operation getSubTaskIDs - Input element getSubTaskIDs contents: -- Element tkiid of type xsd:string
- Output element getSubTaskIDsResponse contents: -- Element subTaskIDs of type htt:SubTaskIDsType (0..1)
|
GET /rest/bpm/htm/task/{tkiid}/subtasks - Response message (JSON): HTM Task List |
| Get Task - Retrieves the specified task instance. | ||
|
Task getTask( String tkiid ) [WSDL: getTask] Task getTask( TKIID tkiid ) |
Operation getTask - Input element getTask contents: -- Element tkiid of type xsd:string
- Output element getTaskResponse contents: -- Element taskInstance of type htt:TaskInstanceType
|
GET /rest/bpm/htm/task/{tkiid} - Response message (JSON): HTM Task |
| Get Task And Mark Read - Retrieves the specified task instance and marks the task as read. | ||
|
Task getTaskAndMarkRead( String tkiid ) Task getTaskAndMarkRead( TKIID tkiid ) |
(none) |
(none) |
| Get Task History - Retrieves the history of a human task instance. | ||
|
List getTaskHistory( String tkiid ) List getTaskHistory( TKIID tkiid ) |
(none) |
GET /rest/bpm/htm/task/{tkiid}/history[?newEventType={newEventType}] - Response message (JSON): HTM Task History Log |
| Get Task Read - States whether the specified task instance is marked read. | ||
|
boolean getTaskRead( String tkiid ) boolean getTaskRead( TKIID tkiid ) |
(none) |
(none) |
| Get Task Template - Retrieves the specified task template. | ||
|
TaskTemplate getTaskTemplate( String tktid ) [WSDL: getTaskTemplate] TaskTemplate getTaskTemplate( TKTID tktid ) |
Operation getTaskTemplate - Input element getTaskTemplate contents: -- Element tktid of type xsd:string
- Output element getTaskTemplateResponse contents: -- Element taskTemplate of type htt:TaskTemplateType
|
GET /rest/bpm/htm/taskTemplate/{tktid} - Response message (JSON): HTM Task Template |
| Get UI Settings - Retrieves client interface settings for the specified task instance or template. | ||
|
CustomClientSettings getUISettings( String identifier ) CustomClientSettings getUISettings( TKTID tktid ) CustomClientSettings getUISettings( TKIID tkiid ) |
(none) |
GET /rest/bpm/htm/taskTemplate/{tktid}/clientSettings/{type} - Response message (JSON): HTM Task Template Client Settings GET /rest/bpm/htm/task/{tkiid}/clientSettings/{type} - Response message (JSON): HTM Task Client Settings |
| Get User Details - Returns details about the specified users. | ||
|
List getUserDetails( String[] userIDs, String[] userProperties ) |
(none) |
(none) |
| Get User Substitution Detail - Returns details about substitutions for the specified user. | ||
|
UserSubstitutionDetail getUserSubstitutionDetail( ) UserSubstitutionDetail getUserSubstitutionDetail( String userID ) |
Operation getUserSubstitutionDetail - Input element getUserSubstitutionDetail contents: -- Element userid of type xsd:string
- Output element getUserSubstitutionDetailResponse contents: -- Element userSubstitutionDetail of type htt:UserSubstitutionDetailType
|
(none) |
| Get Users In Role - Retrieves the users that are members of the specified role. | ||
|
StaffResultSet getUsersInRole( String identifier, int role ) StaffResultSet getUsersInRole( TKTID tktid, int role ) StaffResultSet getUsersInRole( TKIID tkiid, int role ) [WSDL: getUsersInRole] |
Operation getUsersInRole - Input element getUsersInRole contents: -- Element tkiid of type xsd:string
-- Element role of type xsd:string - Output element getUsersInRoleResponse contents: -- Element staffResultSet of type htt:StaffResultSetType
|
GET /rest/bpm/htm/task/{tkiid}/role/{role} - Response message (JSON): HTM Staff Result Set |
| Get Work Basket - Retrieves the specified work basket. | ||
|
WorkBasket getWorkBasket( String identifier ) WorkBasket getWorkBasket( WBID wbid ) |
(none) |
GET /rest/bpm/htm/workBasket/{wbid}?getDefinition=false[&locale={locale}] - Response message (JSON): HTM Work Basket |
| Get Work Basket Definition - Retrieves the specified work basket definition. | ||
|
WorkBasketDefinition getWorkBasketDefinition( String identifier ) WorkBasketDefinition getWorkBasketDefinition( WBID wbid ) |
(none) |
GET /rest/bpm/htm/workBasket/{wbid}?getDefinition=true[&locale={locale}] - Response message (JSON): HTM Work Basket |
| Get Work Items - Returns the work item assignments for the logged-on user and the specified task or escalation instance. | ||
|
WorkItem[] getWorkItems( String identifier ) WorkItem[] getWorkItems( ESIID esiid ) WorkItem[] getWorkItems( TKIID tkiid ) |
(none) |
(none) |
| Get Work Items For Business Category - Returns the work item assignments for the logged-on user and the specified business category. | ||
|
WorkItem[] getWorkItemsForBusinessCategory( String identifier ) WorkItem[] getWorkItemsForBusinessCategory( BCID bcid ) |
(none) |
(none) |
| Get Work Items For Work Basket - Returns the work item assignments for the logged-on user and the specified work basket. | ||
|
WorkItem[] getWorkItemsForWorkBasket( String identifier ) WorkItem[] getWorkItemsForWorkBasket( WBID wbid ) |
(none) |
(none) |
| Is Business Category System Administrator - States whether the logged-on user is a system administrator for business categories. | ||
|
boolean isBusinessCategorySystemAdministrator( ) |
(none) |
(none) |
| Is System Administrator - States whether the logged-on user is a system administrator for the Human Task Manager component. | ||
|
boolean isSystemAdministrator( ) |
(none) |
(none) |
| Is System Monitor - States whether the logged-on user is a task system monitor for the Human Task Manager component. | ||
|
boolean isSystemMonitor( ) |
(none) |
(none) |
| Is User In Role - States whether the specified user is a member of the specified role for the specified task instance or template | ||
|
boolean isUserInRole( String identifier, String userID, int role ) boolean isUserInRole( TKTID tktid, String userID, int role ) boolean isUserInRole( TKIID tkiid, String userID, int role ) |
(none) |
(none) |
| Is Work Basket System Administrator - States whether the logged-on user is a system administrator for work baskets. | ||
|
boolean isWorkBasketSystemAdministrator( ) |
(none) |
(none) |
| Query - Retrieves selected object properties persistently stored in the database. | ||
|
QueryResultSet query( String selectClause, String whereClause, String orderByClause, Integer threshold, java.util.TimeZone timeZone ) QueryResultSet query( String selectClause, String whereClause, String orderByClause, Integer skipTuples, Integer threshold, java.util.TimeZone timeZone ) [WSDL: query] QueryResultSet query( String storedQueryName, Integer skipTuples, List parameters ) QueryResultSet query( String storedQueryName, Integer skipTuples, Integer threshold, List parameters ) [WSDL: executeStoredQuery] QueryResultSet query( String userID, String storedQueryName, Integer skipTuples, Integer threshold, List parameters ) QueryResultSet query( int kind, String storedQueryName, Integer skipTuples, Integer threshold, List parameters ) |
Operation executeStoredQuery - Input element executeStoredQuery contents: -- Element storedQueryName of type xsd:string
-- Element skipTuples of type xsd:integer -- Element threshold of type xsd:integer -- Element parameters of type bct:ParametersType (0..1) - Output element executeStoredQueryResponse contents: -- Element queryResultSet of type bct:QueryResultSetType
Operation query - Input element query contents: -- Element selectClause of type xsd:string
-- Element whereClause of type xsd:string -- Element orderByClause of type xsd:string -- Element skipTuples of type xsd:integer -- Element threshold of type xsd:integer -- Element timeZone of type xsd:string - Output element queryResponse contents: -- Element queryResultSet of type bct:QueryResultSetType
|
GET /rest/bpm/htm/tasks/filter[?whereClause={whereClause}][&orderByClause={orderByClause}][&offset={offset}][&size={size}] - Response message (JSON): HTM Task List |
| Query All - Retrieves selected object properties of all objects persistently stored in the database. | ||
|
QueryResultSet queryAll( String selectClause, String whereClause, String orderByClause, Integer skipTuples, Integer threshold, java.util.TimeZone timeZone ) [WSDL: queryAll] |
Operation queryAll - Input element queryAll contents: -- Element selectClause of type xsd:string
-- Element whereClause of type xsd:string -- Element orderByClause of type xsd:string -- Element skipTuples of type xsd:integer -- Element threshold of type xsd:integer -- Element timeZone of type xsd:string - Output element queryAllResponse contents: -- Element queryResultSet of type bct:QueryResultSetType
|
(none) |
| Query Entities - Queries entities of a query table. | ||
|
EntityResultSet queryEntities( String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, List parameters ) |
Operation queryEntities - Input element queryEntities contents: -- Element queryTableName of type xsd:string
-- Element filterOptions of type bct:FilterOptionsType -- Element authorizationOptions of type bct:AuthorizationOptionsType -- Element parameters of type bct:QueryTableParametersType - Output element queryEntitiesResponse contents: -- Element entityResultSet of type bct:EntityResultSetType
|
GET /rest/bpm/htm/businessCategories/query?queryTableName={queryTableName}[&selectedAttributes={selectedAttributes}][&queryFilter={queryFilter}][&sortAttributes={sortAttributes}][&offset={offset}][&size={size}][&admin={admin}] - Response message (JSON): HTM Entity Result Set GET /rest/bpm/htm/taskTemplates/query/{query}[?interactionFilter={interactionFilter}][&selectedAttributes={selectedAttributes}][&queryFilter={queryFilter}][&sortAttributes={sortAttributes}][&offset={offset}][&size={size}][&admin={admin}] - Response message (JSON): HTM Query Result Set GET /rest/bpm/htm/tasks/query/{query}[?selectedAttributes={selectedAttributes}][&interactionFilter={interactionFilter}][&queryFilter={queryFilter}][&sortAttributes={sortAttributes}][&offset={offset}][&size={size}][&everybody={everybody}][&individual={individual}][&group={group}][&inherited={inherited}][&admin={admin}][&onBehalfUser={onBehalfUser}] - Response message (JSON): HTM Query Result Set GET /rest/bpm/htm/escalations/query?queryTableName={queryTableName}[&selectedAttributes={selectedAttributes}][&queryFilter={queryFilter}][&sortAttributes={sortAttributes}][&offset={offset}][&size={size}][&admin={admin}] - Response message (JSON): HTM Entity Result Set GET /rest/bpm/htm/workBaskets/query?queryTableName={queryTableName}[&selectedAttributes={selectedAttributes}][&queryFilter={queryFilter}][&sortAttributes={sortAttributes}][&offset={offset}][&size={size}][&admin={admin}] - Response message (JSON): HTM Entity Result Set |
| Query Entity Count - Counts qualifying entities of a potential query for entities. | ||
|
int queryEntityCount( String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, List parameters ) |
Operation queryEntityCount - Input element queryEntityCount contents: -- Element queryTableName of type xsd:string
-- Element filterOptions of type bct:FilterOptionsType -- Element authorizationOptions of type bct:AuthorizationOptionsType -- Element parameters of type bct:QueryTableParametersType - Output element queryEntityCountResponse contents: -- Element entityCount of type xsd:integer
|
GET /rest/bpm/htm/businessCategories/queryCount?queryTableName={queryTableName}[&queryFilter={queryFilter}][&admin={admin}] - Response message (JSON): HTM Entity Result Set Count GET /rest/bpm/htm/taskTemplates/query/{query}/count[?interactionFilter={interactionFilter}][&queryFilter={queryFilter}][&admin={admin}] - Response message (JSON): HTM Query Result Set Count GET /rest/bpm/htm/tasks/query/{query}/count[?interactionFilter={interactionFilter}][&queryFilter={queryFilter}][&everybody={everybody}][&individual={individual}][&group={group}][&inherited={inherited}][&admin={admin}][&onBehalfUser={onBehalfUser}] - Response message (JSON): HTM Query Result Set Count GET /rest/bpm/htm/escalations/queryCount?queryTableName={queryTableName}[&queryFilter={queryFilter}][&admin={admin}] - Response message (JSON): HTM Entity Result Set Count GET /rest/bpm/htm/workBaskets/queryCount?queryTableName={queryTableName}[&queryFilter={queryFilter}][&admin={admin}] - Response message (JSON): HTM Entity Result Set Count |
| Query Rows - Queries selected attributes of a query table. | ||
|
RowResultSet queryRows( String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, List parameters ) |
(none) |
(none) |
| Query Row Count - Counts qualifying objects of a potential query table query. | ||
|
int queryRowCount( String queryTableName, FilterOptions filterOptions, AuthorizationOptions authorizationOptions, List parameters ) |
(none) |
(none) |
| Query Task Templates - Retrieves task templates that are persistently stored in the database. | ||
|
TaskTemplate[] queryTaskTemplates( String whereClause, String orderByClause, Integer threshold, TimeZone timeZone ) [WSDL: queryTaskTemplates] |
Operation queryTaskTemplates - Input element queryTaskTemplates contents: -- Element whereClause of type xsd:string
-- Element orderByClause of type xsd:string -- Element threshold of type xsd:integer -- Element timeZone of type xsd:string - Output element queryTaskTemplatesResponse contents: -- Element taskTemplates of type htt:TaskTemplatesType (0..1)
|
GET /rest/bpm/htm/taskTemplates/filter[?whereClause={whereClause}][&orderByClause={orderByClause}][&size={size}] - Response message (JSON): HTM Task Template List |
| Remove As Distribution Target - Removes the specified work basket as a distribution target from all referencing work baskets. | ||
|
List removeAsDistributionTarget( String identifier ) List removeAsDistributionTarget( WBID wbid ) |
(none) |
PUT /rest/bpm/htm/workBasket/{wbid}?action=removeAsDistributionTarget - Response message (JSON): HTM Work Basket Remove As Distribution Target Result |
| Resolve Staff Query - Tentatively resolves the specified people assignment criteria and returns the qualifying users or groups. | ||
|
StaffResultSet resolveStaffQuery( String parameterizedPeopleAssignmentCriteria, String jndiNameOfStaffPluginProvider, int substitutionPolicy, Map contextVariables ) [WSDL: resolveStaffQuery] |
Operation resolveStaffQuery - Input element resolveStaffQuery contents: -- Element parameterizedPeopleAssignmentCriteria of type xsd:string
-- Element jndiNameOfStaffPluginProvider of type xsd:string -- Element substitutionPolicy of type xsd:string -- Element contextVariables of type htt:ContextVariablesType (0..1) - Output element resolveStaffQueryResponse contents: -- Element staffResultSet of type htt:StaffResultSetType
|
(none) |
| Restart - Restarts the specified task instance. | ||
|
void restart( String tkiid, ClientObjectWrapper input, boolean keepResultMessages ) void restart( TKIID tkiid, ClientObjectWrapper input, boolean keepResultMessages ) |
(none) |
(none) |
| Resume - Resumes the execution of the specified suspended collaboration or to-do task instance. | ||
|
void resume( String tkiid ) [WSDL: resume] void resume( TKIID tkiid ) |
Operation resume - Input element resume contents: -- Element tkiid of type xsd:string
- Output element resumeResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=resume PUT /rest/bpm/htm/task?action=resume - Request message (JSON): HTM Task Bulk Operation - Response message (JSON): HTM Task Bulk Operation Response |
| Search Group Details - Returns details about the groups searched for. | ||
|
List searchGroupDetails( String searchCondition, String[] groupProperties, String[] userProperties, String[] subGroupProperties, Integer threshold ) |
(none) |
(none) |
| Search User Details - Returns details about the users searched for. | ||
|
List searchUserDetails( String searchCondition, String[] userProperties, Integer threshold ) |
(none) |
(none) |
| Set Custom Properties - Stores custom-specific values for the specified task instance. | ||
|
void setCustomProperties( String tkiid, List customProperties ) void setCustomProperties( TKIID tkiid, List customProperties ) |
Operation setCustomPropertiesForTaskInstance - Input element setCustomPropertiesForTaskInstance contents: -- Element tkiid of type xsd:string
-- Element propertyName of type xsd:string -- Element propertyValue of type xsd:string - Output element setCustomPropertiesForTaskInstanceResponse contents: -- (none) |
(none) |
| Set Custom Property - Stores custom-specific values for the specified task or escalation instance. | ||
|
void setCustomProperty( String identifier, String propertyName, String propertyValue ) void setCustomProperty( ESIID esiid, String propertyName, String propertyValue ) void setCustomProperty( TKIID tkiid, String propertyName, String propertyValue ) [WSDL: setCustomPropertiesForTaskInstance] List setCustomProperty( String[] tkiids, String propertyName, String propertyValue ) List setCustomProperty( TKIID[] tkiids, String propertyName, String propertyValue ) |
(none) |
(none) |
| Set Binary Custom Property - Setter for binary custom properties. | ||
|
void setBinaryCustomProperty( String identifier, BinaryCustomProperty property ) void setBinaryCustomProperty( TKIID tkiid, BinaryCustomProperty property ) void setBinaryCustomProperty( ESIID esiid, BinaryCustomProperty property ) |
(none) |
POST /rest/bpm/htm/task/{tkiid}/binaryCustomProperty/{name}[?type={type}][&query={query}][&allowUpdate={allowUpdate}] - Request message (optional): (user-defined) PUT /rest/bpm/htm/task/{tkiid}/binaryCustomProperty/{name}[?type={type}][&query={query}][&allowCreate={allowCreate}] - Request message: (user-defined) |
| Set Business Category On Tasks - Sets the business category of the specified tasks. | ||
|
List setBusinessCategoryOnTasks( String[] tkiids, String identifier ) List setBusinessCategoryOnTasks( TKIID[] tkiids, BCID bcid ) |
(none) |
(none) |
| Set Fault Message - Stores the specified fault message for the specified task instance into the database. | ||
|
void setFaultMessage( String tkiid, String faultName, ClientObjectWrapper faultMessage ) [WSDL: setFaultMessage] void setFaultMessage( TKIID tkiid, String faultName, ClientObjectWrapper faultMessage ) |
Operation setFaultMessage - Input element setFaultMessage contents: -- Element tkiid of type xsd:string
-- Element faultName of type xsd:string -- Element fault of type bct:UserDataType - Output element setFaultMessageResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}/fault?faultName={faultName} - Request message (XML): user-defined schema |
| Set Inline Custom Properties - Stores custom-specific values for the specified task instance. | ||
|
void setInlineCustomProperties( String tkiid, List customProperties ) void setInlineCustomProperties( TKIID tkiid, List customProperties ) void setInlineCustomProperty( String tkiid, InlineCustomProperty property ) void setInlineCustomProperty( TKIID tkiid, InlineCustomProperty property ) List setInlineCustomProperty( String[] tkiids, InlineCustomProperty property ) List setInlineCustomProperty( TKIID[] tkiids, InlineCustomProperty property ) |
(none) |
(none) |
| Set Input Message - Stores the specified input message for the specified task instance into the database. | ||
|
void setInputMessage( String tkiid, ClientObjectWrapper inputMessage ) void setInputMessage( TKIID tkiid, ClientObjectWrapper inputMessage ) |
Operation setInputMessage - Input element setInputMessage contents: -- Element tkiid of type xsd:string
-- Element input of type bct:UserDataType - Output element setInputMessageResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}/input - Request message (XML): user-defined schema |
| Set Output Message - Stores the specified output message for the specified task instance into the database. | ||
|
void setOutputMessage( String tkiid, ClientObjectWrapper outputMessage ) [WSDL: setOutputMessage] void setOutputMessage( TKIID tkiid, ClientObjectWrapper outputMessage ) |
Operation setOutputMessage - Input element setOutputMessage contents: -- Element tkiid of type xsd:string
-- Element output of type bct:UserDataType - Output element setOutputMessageResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}/output - Request message (XML): user-defined schema |
| Set Parent Business Category - Sets the parent of the specified business category. | ||
|
void setParentBusinessCategory( String identifier, String parentIdentifier ) void setParentBusinessCategory( BCID bcid, BCID parentBCID ) |
(none) |
PUT /rest/bpm/htm/businessCategory/{bcid}?action=setParent[&parentBusinessCategory={parentBusinessCategory}] |
| Set Priority Of Business Categories - Sets the priority of the specified business categories. | ||
|
List setPriorityOfBusinessCategories( String[] identifier, Integer priority ) List setPriorityOfBusinessCategories( BCID[] bcids, Integer priority ) |
(none) |
PUT /rest/bpm/htm/businessCategory?action=setPriority[&priority={priority}] - Request message (JSON): HTM Business Category Bulk Operation - Response message (JSON): HTM Business Category Bulk Operation Response |
| Set Task Read - Specifies whether the specified task instance is to be marked as read. | ||
|
void setTaskRead( String tkiid, boolean newValue ) void setTaskRead( TKIID tkiid, boolean newValue ) |
(none) |
(none) |
| Set User Substitution Detail - Sets details about substitutions for the specified user. | ||
|
void setUserSubstitutionDetail( UserSubstitutionDetail substitutionDetail ) void setUserSubstitutionDetail( String userID, UserSubstitutionDetail substitutionDetail ) |
Operation setUserSubstitutionDetail - Input element setUserSubstitutionDetail contents: -- Element userid of type xsd:string
-- Element userSubstitutionDetail of type htt:UserSubstitutionDetailType - Output element setUserSubstitutionDetailResponse contents: -- (none) |
(none) |
| Start Task - Asynchronously executes a previously created task. | ||
|
void startTask( String tkiid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler ) void startTask( TKIID tkiid, ClientObjectWrapper input, ReplyHandlerWrapper replyHandler ) |
Operation startTask - Input element startTask contents: -- Element tkiid of type xsd:string
-- Element input of type bct:UserDataType (0..1) -- Element replyTo of type bct:ReplyToType (0..1) - Output element startTaskResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=start&mode=async[&relation={relation}][&parentTaskID={parentTaskID}] - Request message (optional) (XML): user-defined schema - Response message (XML): user-defined schema |
| Start Task As SubTask - Asynchronously executes a previously created task as a subtask of the specified parent task instance. | ||
|
void startTaskAsSubTask( String tkiid, String parentTaskID, ClientObjectWrapper input ) void startTaskAsSubTask( TKIID tkiid, TKIID parentTaskID, ClientObjectWrapper input ) [WSDL: startTaskAsSubTask] |
Operation startTaskAsSubTask - Input element startTaskAsSubTask contents: -- Element tkiid of type xsd:string
-- Element parentTaskID of type xsd:string -- Element input of type bct:UserDataType (0..1) - Output element startTaskAsSubTaskResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=start&mode=async&relation=subtask&parentTaskID={tkiid} - Request message (optional) (XML): user-defined schema - Response message (XML): user-defined schema |
| >Start Task Template - This method starts a task template that has been created at runtime. | ||
|
void startTaskTemplate( String tktid ) void startTaskTemplate( TKTID tktid ) |
(none) |
(none) |
| Stop Task Template - This method stops a task template that has been created at runtime. | ||
|
void stopTaskTemplate( String tktid ) void stopTaskTemplate( TKTID tktid ) |
(none) |
(none) |
| Suspend - Suspends the specified collaboration or to-do task instance. | ||
|
void suspend( String tkiid ) [WSDL: suspend] void suspend( TKIID tkiid ) void suspend( String tkiid, String duration ) void suspend( TKIID tkiid, String duration ) [WSDL: suspendFor] void suspend( String tkiid, int duration ) void suspend( TKIID tkiid, int duration ) void suspend( String tkiid, Calendar deadline ) void suspend( TKIID tkiid, Calendar deadline ) [WSDL: suspendUntil] |
Operation suspend - Input element suspend contents: -- Element tkiid of type xsd:string
- Output element suspendResponse contents: -- (none) Operation suspendFor - Input element suspendFor contents: -- Element tkiid of type xsd:string
-- Element duration of type xsd:duration - Output element suspendForResponse contents: -- (none) Operation suspendUntil - Input element suspendUntil contents: -- Element tkiid of type xsd:string
-- Element deadline of type xsd:dateTime - Output element suspendUntilResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=suspend[&deadline={deadline}][&duration={duration}] PUT /rest/bpm/htm/task?action=suspend[&deadline={deadline}][&duration={duration}] - Request message (JSON): HTM Task Bulk Operation - Response message (JSON): HTM Task Bulk Operation Response |
| Suspend And Cancel Claim - Suspends the specified collaboration or to-do task instance and cancels the claim of the task instance when execution is resumed. | ||
|
void suspendAndCancelClaim( String tkiid, String duration, boolean keepTaskData ) void suspendAndCancelClaim( TKIID tkiid, String duration, boolean keepTaskData ) [WSDL: suspendForAndCancelClaim] void suspendAndCancelClaim( String tkiid, int duration, boolean keepTaskData ) void suspendAndCancelClaim( TKIID tkiid, int duration, boolean keepTaskData ) void suspendAndCancelClaim( String tkiid, Calendar deadline, boolean keepTaskData ) void suspendAndCancelClaim( TKIID tkiid, Calendar deadline, boolean keepTaskData ) [WSDL: suspendUntilAndCancelClaim] |
Operation suspendForAndCancelClaim - Input element suspendForAndCancelClaim contents: -- Element tkiid of type xsd:string
-- Element duration of type xsd:duration -- Element keepTaskData of type xsd:boolean - Output element suspendForAndCancelClaimResponse contents: -- (none) Operation suspendUntilAndCancelClaim - Input element suspendUntilAndCancelClaim contents: -- Element tkiid of type xsd:string
-- Element deadline of type xsd:dateTime -- Element keepTaskData of type xsd:boolean - Output element suspendUntilAndCancelClaimResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=suspendAndCancelClaim&keepTaskData={keepTaskData}[&deadline={deadline}][&duration={duration}] PUT /rest/bpm/htm/task?action=suspendAndCancelClaim&keepTaskData={keepTaskData}[&deadline={deadline}][&duration={duration}] - Request message (JSON): HTM Task Bulk Operation - Response message (JSON): HTM Task Bulk Operation Response |
| Terminate - Terminates the specified task instance. | ||
|
void terminate( String tkiid ) [WSDL: terminate] void terminate( TKIID tkiid ) |
Operation terminate - Input element terminate contents: -- Element tkiid of type xsd:string
- Output element terminateResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=terminate |
| Transfer Tasks To Work Basket - Transfers the specified task instances to the specified work basket. | ||
|
List transferTasksToWorkBasket( String[] tkiids, String identifier, boolean cancelClaimIfNeeded ) List transferTasksToWorkBasket( TKIID[] tkiids, WBID wbid, boolean cancelClaimIfNeeded ) List transferToWorkBasket( String[] tkiids, String workBasketName ) List transferToWorkBasket( TKIID[] tkiids, String workBasketName ) |
(none) |
PUT /rest/bpm/htm/workBasket/{wbid}?action=transferToWorkBasket[&taskID={taskID}][&cancelClaimIfNeeded={cancelClaimIfNeeded}] - Request message (JSON): HTM Work Basket Bulk Task Operation - Response message (JSON): HTM Work Basket Bulk Task Operation Response |
| Transfer Work Item - Transfers one or more work items to another user or group in a single transaction. | ||
|
void transferWorkItem( String identifier, int assignmentReason, String fromOwner, String toOwner ) [WSDL: transferWorkItem] void transferWorkItem( ESIID esiid, int assignmentReason, String fromOwner, String toOwner ) void transferWorkItem( TKIID tkiid, int assignmentReason, String fromOwner, String toOwner ) List transferWorkItem( String[] identifiers, int assignmentReason, String fromOwner, String toOwner ) List transferWorkItem( ESIID[] esiids, int assignmentReason, String fromOwner, String toOwner ) List transferWorkItem( TKIID[] tkiids, int assignmentReason, String fromOwner, String toOwner ) List bulkTransferWorkItem( String[] identifiers, int assignmentReason, String fromOwner, String toOwner ) List bulkTransferWorkItem( ESIID[] esiids, int assignmentReason, String fromOwner, String toOwner ) List bulkTransferWorkItem( TKIID[] tkiids, int assignmentReason, String fromOwner, String toOwner ) |
Operation transferWorkItem - Input element transferWorkItem contents: -- Element identifier of type xsd:string
-- Element assignmentReason of type xsd:integer -- Element fromOwner of type xsd:string -- Element toOwner of type xsd:string - Output element transferWorkItemResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}/role/{role}?action=transfer[&toUser={toUser}][&fromUser={fromUser}][&toGroup={toGroup}][&fromGroup={fromGroup}] PUT /rest/bpm/htm/task/role/{role}?action=transfer[&toUser={toUser}][&fromUser={fromUser}][&toGroup={toGroup}][&fromGroup={fromGroup}] - Request message (JSON): HTM Task Bulk Operation - Response message (JSON): HTM Task Bulk Operation Response |
| Trigger Escalation - Trigger an escalation for a specified task. | ||
|
void triggerEscalation( String esiid ) void triggerEscalation( ESIID esiid ) |
(none) |
PUT /rest/bpm/htm/escalation/{esiid}?action=trigger |
| Update Business Category - Updates a business category with values from the specified business category definition. | ||
|
void updateBusinessCategory( BusinessCategoryDefinition businessCategoryDefinition ) |
(none) |
PUT /rest/bpm/htm/businessCategory/{bcid}?action=update[&locale={locale}] - Request message (JSON): HTM Business Category Update |
| Update Task or Escalation - Updates a persistently stored task or escalation instance. | ||
|
void update( Task task ) [WSDL: update] void update( String tkiid, TaskModel taskModel, String applicationName, String parentContext, ClientObjectWrapper input ) void update( TKIID tkiid, TaskModel taskModel, String applicationName, String parentContext, ClientObjectWrapper input ) void update( Escalation escalation ) |
Operation update - Input element update contents: -- Element task of type htt:TaskInstanceType
- Output element updateResponse contents: -- (none) |
PUT /rest/bpm/htm/task/{tkiid}?action=update - Request message (JSON): HTM Task Update PUT /rest/bpm/htm/task?action=update - Request message (JSON): HTM Task Bulk Update - Response message (JSON): HTM Task Bulk Update Response PUT /rest/bpm/htm/escalation/{esiid}?action=update - Request message (JSON): HTM Escalation Update |
| Update Work Basket - Updates a work basket with values from the specified work basket definition. | ||
|
void updateWorkBasket( WorkBasketDefinition workBasketDefinition ) |
(none) |
PUT /rest/bpm/htm/workBasket/{wbid}?action=update[&locale={locale}] - Request message (JSON): HTM Work Basket Update |