source |
<wsdl:portType name="WorkItemSchedulerService">
<wsdl:documentation>Perform scheduling of work items, currently rescheduleWorkItem is the only supported public operation.</wsdl:documentation>
<wsdl:operation name="scheduleWorkItem">
<wsdl:documentation>**PRIVATE API - Reserved for Internal Use ** - Add a new work item to the work list</wsdl:documentation>
<wsdl:input name="scheduleWorkItemRequest" message="impl:scheduleWorkItemRequest">
<wsdl:documentation>Request message (uses dto:scheduleWorkItem element): containing the work item details, context and body</wsdl:documentation>
</wsdl:input>
<wsdl:output name="scheduleWorkItemResponse" message="impl:scheduleWorkItemResponse">
<wsdl:documentation>Request message (uses dto:scheduleWorkItemResponse element): containing the ID of the scheduled work item</wsdl:documentation>
</wsdl:output>
<wsdl:fault name="InvalidWorkType" message="impl:invalidWorkTypeFault">
<wsdl:documentation>Work type id is not specified or does not exist</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InvalidWorkGroup" message="impl:invalidWorkGroupFault">
<wsdl:documentation>Work group id specified does not exist</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="WorkItemFault" message="impl:workItemFault">
<wsdl:documentation>Unable to create, find or load work item model</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InvalidEntityFault" message="impl:invalidEntityFault">
<wsdl:documentation>Specified entity is invalid</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InternalServiceFault" message="impl:internalServiceFault"/>
<wsdl:fault name="SecurityFault" message="impl:securityFault">
<wsdl:documentation>Error message (uses deex:SecurityFault): The request failed due to authentication or authorisation failure.</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
<wsdl:operation name="scheduleWorkItemWithWorkModel">
<wsdl:documentation>**PRIVATE API - Reserved for Internal Use ** - Add a new work item with an optional model to the work list</wsdl:documentation>
<wsdl:input name="scheduleWorkItemWithWorkModelRequest" message="impl:scheduleWorkItemWithWorkModelRequest">
<wsdl:documentation>Contains the work item to be scheduled</wsdl:documentation>
</wsdl:input>
<wsdl:output name="scheduleWorkItemWithWorkModelResponse" message="impl:scheduleWorkItemWithWorkModelResponse">
<wsdl:documentation>Reply element for the scheduling of a work item </wsdl:documentation>
</wsdl:output>
<wsdl:fault name="InvalidWorkModelFault" message="impl:invalidWorkModelFault">
<wsdl:documentation>Work model id is not specified or does not exist</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InvalidWorkGroup" message="impl:invalidWorkGroupFault">
<wsdl:documentation>Work group id specified does not exist</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="WorkItemFault" message="impl:workItemFault">
<wsdl:documentation>Unable to create, find or load work item model</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InvalidEntityFault" message="impl:invalidEntityFault">
<wsdl:documentation>Specified entity is invalid</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InternalServiceFault" message="impl:internalServiceFault"/>
<wsdl:fault name="WorkItemAPIScriptCancelFault" message="impl:workItemAPIScriptCancelFault">
<wsdl:documentation>Problem occurred in the execution of the associated script</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="SecurityFault" message="impl:securityFault">
<wsdl:documentation>Error message (uses deex:SecurityFault): The request failed due to authentication or authorisation failure.</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
<wsdl:operation name="enableWorkItem">
<wsdl:documentation>Entry point for the enabling of a work item</wsdl:documentation>
<wsdl:input name="enableWorkItemRequest" message="impl:enableWorkItemRequest">
<wsdl:documentation>Contains the work item to be enabled</wsdl:documentation>
</wsdl:input>
<wsdl:output name="enableWorkItemResponse" message="impl:enableWorkItemResponse">
<wsdl:documentation>Reply element for the enabling of a work item </wsdl:documentation>
</wsdl:output>
<wsdl:fault name="WorkItemFault" message="impl:workItemFault">
<wsdl:documentation>Unable to create, find or load work item model</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InvalidWorkItemFault" message="impl:invalidWorkItemFault">
<wsdl:documentation>Work item id does not exist</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InternalServiceFault" message="impl:internalServiceFault"/>
</wsdl:operation>
<wsdl:operation name="rescheduleWorkItem">
<wsdl:documentation>Change the scheduling information and optionally the work item data for an existing work item</wsdl:documentation>
<wsdl:input name="rescheduleWorkItemRequest" message="impl:rescheduleWorkItemRequest">
<wsdl:documentation>Request message (uses dto:rescheduleWorkItem): Contains the details, reschedule data and any changed data of the work item to be rescheduled.</wsdl:documentation>
</wsdl:input>
<wsdl:output name="rescheduleWorkItemResponse" message="impl:rescheduleWorkItemResponse">
<wsdl:documentation>Response message (uses dto:rescheduleWorkItemResponse): Contains the ID of the rescheduled work item.</wsdl:documentation>
</wsdl:output>
<wsdl:fault name="InvalidWorkItemFault" message="impl:invalidWorkItemFault">
<wsdl:documentation>Error message (uses ex:InvalidWorkItemFault): The specified work item does not exist.</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InternalServiceFault" message="impl:internalServiceFault">
<wsdl:documentation>Error message (uses ex:InternalServiceFault): An internal service fault occurred. </wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="SecurityFault" message="impl:securityFault">
<wsdl:documentation>Error message (uses deex:SecurityFault): The request failed due to authentication or authorisation failure.</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
<wsdl:operation name="cancelWorkItem">
<wsdl:documentation>Cancel a work item (because the parent application has been cancelled</wsdl:documentation>
<wsdl:input name="cancelWorkItemRequest" message="impl:cancelWorkItemRequest">
<wsdl:documentation>Contains the work item to be cancelled</wsdl:documentation>
</wsdl:input>
<wsdl:output name="cancelWorkItemResponse" message="impl:cancelWorkItemResponse">
<wsdl:documentation>Reply element for the cancelling of a work item </wsdl:documentation>
</wsdl:output>
<wsdl:fault name="InvalidWorkItemFault" message="impl:invalidWorkItemFault">
<wsdl:documentation>Work item id does not exist</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InternalServiceFault" message="impl:internalServiceFault"/>
<wsdl:fault name="WorkItemAPIScriptCancelFault" message="impl:workItemAPIScriptCancelFault">
<wsdl:documentation>Problem occurred in the execution of the associated script</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="SecurityFault" message="impl:securityFault">
<wsdl:documentation>Error message (uses deex:SecurityFault): The request failed due to authentication or authorisation failure.</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
<wsdl:operation name="suspendWorkItem">
<wsdl:documentation>**PRIVATE API - Reserved for Internal Use ** - Suspend a work item (because the parent application has been suspended)</wsdl:documentation>
<wsdl:input name="suspendWorkItemRequest" message="impl:suspendWorkItemRequest">
<wsdl:documentation>Contains the work item to be suspended</wsdl:documentation>
</wsdl:input>
<wsdl:output name="suspendWorkItemResponse" message="impl:suspendWorkItemResponse">
<wsdl:documentation>Reply element for the suspending of a work item </wsdl:documentation>
</wsdl:output>
<wsdl:fault name="InvalidWorkItemFault" message="impl:invalidWorkItemFault">
<wsdl:documentation>Work item id does not exist</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InternalServiceFault" message="impl:internalServiceFault"/>
<wsdl:fault name="SecurityFault" message="impl:securityFault">
<wsdl:documentation>Error message (uses deex:SecurityFault): The request failed due to authentication or authorisation failure.</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
<wsdl:operation name="resumeWorkItem">
<wsdl:documentation>**PRIVATE API - Reserved for Internal Use ** - Resume a currently suspended work item (because the parent application has been resumed)</wsdl:documentation>
<wsdl:input name="resumeWorkItemRequest" message="impl:resumeWorkItemRequest">
<wsdl:documentation>Contains the work item to be resumed</wsdl:documentation>
</wsdl:input>
<wsdl:output name="resumeWorkItemResponse" message="impl:resumeWorkItemResponse">
<wsdl:documentation>Reply element for the resuming of a work item </wsdl:documentation>
</wsdl:output>
<wsdl:fault name="InvalidWorkItemFault" message="impl:invalidWorkItemFault">
<wsdl:documentation>Work item id does not exist</wsdl:documentation>
</wsdl:fault>
<wsdl:fault name="InternalServiceFault" message="impl:internalServiceFault"/>
<wsdl:fault name="SecurityFault" message="impl:securityFault">
<wsdl:documentation>Error message (uses deex:SecurityFault): The request failed due to authentication or authorisation failure.</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
</wsdl:portType> |