Workflow Engine Schemas for Web Services
From Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS
Workflow Engine Schemas for Web Services
abortCases, abortCasesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="domain" type="xs:string" minOccurs="0"/> <xs:element name="userName" type="xs:string" minOccurs="0"/> <xs:element name="cases"> <xs:complexType> <xs:sequence> <xs:element name="case" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="radNumber" type="xs:unsignedShort"/> <xs:element name="abortReason" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="qualified"> <xs:element name="processes"> <xs:complexType> <xs:sequence> <xs:element name="process" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:integer"/> <xs:element name="processRadNumber" type="xs:string"/> <xs:element name="processCreationDate" type="xs:dateTime"/> <xs:element name="processSolutionDate" type="xs:dateTime"/> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:integer"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassHelpURL" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:unsignedByte"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:integer"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode" type="xs:integer"/> <xs:element name="errorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
assignActivity, assignActivityAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="CaseInfo"> <xs:complexType> <xs:sequence> <xs:choice> <xs:element name="AssignedByIdUser" type="xs:integer"/> <xs:element name="AssignedByUserName" type="xs:string"/> </xs:choice> <xs:choice> <xs:element name="IdUser" type="xs:integer"/> <xs:element name="UserName" type="xs:string"/> </xs:choice> <xs:choice> <xs:element name="IdWorkItem" minOccurs="0" type="xs:integer"/> <xs:choice> <xs:element name="IdCase" type="xs:integer"/> <xs:element name="CaseNumber" type="xs:string"/> </xs:choice> <xs:choice> <xs:element name="IdTask" type="xs:integer"/> <xs:element name="TaskName" type="xs:string"/> </xs:choice> </xs:choice> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="process"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:unsignedShort" /> <xs:element name="processRadNumber" type="xs:unsignedShort" /> <xs:element name="savedMessage"> <xs:complexType> <xs:sequence> <xs:element name="Entities" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:unsignedByte" /> <xs:element name="workflowClassName" type="xs:string" /> <xs:element name="workflowClassDisplayName" type="xs:string" /> <xs:element name="workflowClassDescription" type="xs:string" /> <xs:element name="workflowClassHelpText" type="xs:string" /> <xs:element name="workflowClassDisplayOrder" type="xs:unsignedByte" /> <xs:element name="workflowClassCreationDate" type="xs:string" /> <xs:element name="workflowClassGlobalForm" type="xs:unsignedByte" /> <xs:element name="workflowClassAllocationPrinciple" type="xs:string" /> <xs:element name="workflowClassProcessType" type="xs:string" /> <xs:element name="workflowClassDisplay" type="xs:string" /> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode" type="xs:string" /> <xs:element name="errorMessage"> <xs:complexType mixed="true"> <xs:sequence minOccurs="0"> <xs:element name="Entities"> <xs:complexType> <xs:sequence> <xs:element name="Path" type="xs:string" /> <xs:element name="Atrib" type="xs:string" /> <xs:element name="Value" type="xs:string" /> <xs:element name="ErrorMessage" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="CurrentWorkItems"> <xs:complexType> <xs:sequence> <xs:element name="workItem"> <xs:complexType> <xs:sequence> <xs:element name="workItemId" type="xs:unsignedShort" /> <xs:element name="workItemState" type="xs:string" /> <xs:element name="workItemEntryDate" type="xs:string" /> <xs:element name="workItemDuration" type="xs:unsignedByte" /> <xs:element name="workItemEstimatedSolutionDate" type="xs:string" /> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:unsignedByte" /> <xs:element name="taskName" type="xs:string" /> <xs:element name="taskDisplayName" type="xs:string" /> <xs:element name="taskDescription" type="xs:string" /> <xs:element name="taskHelpText" type="xs:string" /> <xs:element name="taskEstimatedDuration" type="xs:unsignedByte" /> <xs:element name="taskType" type="xs:string" /> <xs:element name="taskCost" type="xs:unsignedByte" /> <xs:element name="taskPriority" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
createCases, createCasesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="domain" type="xs:string"/> <xs:element name="userName" type="xs:string"/> <xs:element name="Cases"> <xs:complexType> <xs:sequence> <xs:element name="Case" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="Process" type="xs:string"/> <xs:element name="Entities"> <xs:complexType/> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="processes"> <xs:complexType> <xs:sequence> <xs:element name="process" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:integer"/> <xs:element name="processRadNumber" type="xs:string" minOccurs="0"/> <xs:element name="savedMessage" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="Entities" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processWorkflowClass" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:integer"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:integer"/> <xs:element name="workflowClassCreationDate" type="xs:string"/> <xs:element name="workflowClassGlobalForm" type="xs:integer"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:string"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode" type="xs:string"/> <xs:element name="errorMessage"> <xs:complexType mixed="true"> <xs:sequence minOccurs="0"> <xs:element name="Entities"> <xs:complexType> <xs:sequence> <xs:element name="Path" type="xs:string"/> <xs:element name="Atrib" type="xs:string"/> <xs:element name="Value" type="xs:string"/> <xs:element name="ErrorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="CurrentWorkItems"> <xs:complexType mixed="true"> <xs:sequence minOccurs="0"> <xs:element name="workItem"> <xs:complexType> <xs:sequence> <xs:element name="workItemId" type="xs:integer"/> <xs:element name="workItemState" type="xs:string"/> <xs:element name="workItemEntryDate" type="xs:string"/> <xs:element name="workItemDuration" type="xs:integer"/> <xs:element name="workItemEstimatedSolutionDate" type="xs:string"/> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:integer"/> <xs:element name="taskName" type="xs:string"/> <xs:element name="taskDisplayName" type="xs:string"/> <xs:element name="taskDescription" type="xs:string"/> <xs:element name="taskHelpText" type="xs:string"/> <xs:element name="taskEstimatedDuration" type="xs:integer"/> <xs:element name="taskType" type="xs:string"/> <xs:element name="taskCost" type="xs:integer"/> <xs:element name="taskPriority" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
getActivities, getActivitiesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="domain" type="xs:string" minOccurs="0"/> <xs:element name="userName" type="xs:string" minOccurs="0"/> <xs:element name="radNumber" type="xs:string" minOccurs="0"/> <xs:element name="applicationName" type="xs:string" minOccurs="0"/> <xs:element name="categoryName" type="xs:string" minOccurs="0"/> <xs:element name="processName" type="xs:string" minOccurs="0"/> <xs:element name="idCase" type="xs:integer" minOccurs="0"/> <xs:element name="subprocessDepth" type="xs:integer" minOccurs="0"/> <xs:element name="creationDate" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="From" type="xs:dateTime" minOccurs="0"/> <xs:element name="To" type="xs:dateTime" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="expirationDate" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="From" type="xs:dateTime" minOccurs="0"/> <xs:element name="To" type="xs:dateTime" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> <xs:element name="workItems"> <xs:complexType> <xs:sequence> <xs:element name="workItem" type="workItemType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:complexType name="workItemType"> <xs:sequence> <xs:element name="workItemId" type="xs:integer"/> <xs:element name="workItemState" type="xs:string"/> <xs:element name="workItemEntryDate" type="xs:dateTime"/> <xs:element name="workItemDuration" type="xs:integer"/> <xs:element name="workItemSubprocesses"> <xs:complexType> <xs:sequence> <xs:element name="workItems" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="workItem" type="workItemType" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="workItemEstimatedSolutionDate" type="xs:dateTime"/> <xs:element name="workItemSolutionDate" type="xs:dateTime"/> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:integer"/> <xs:element name="taskName" type="xs:string"/> <xs:element name="taskDisplayName" type="xs:string"/> <xs:element name="taskDescription" type="xs:string"/> <xs:element name="taskHelpText" type="xs:string"/> <xs:element name="HelpURL" type="xs:string"/> <xs:element name="taskEstimatedDuration" type="xs:integer"/> <xs:element name="taskType" type="xs:string"/> <xs:element name="taskCost" type="xs:integer"/> <xs:element name="taskPriority" type="xs:string"/> <xs:element name="taskTransactional" type="xs:boolean"/> <xs:element name="taskCompensation" type="xs:boolean"/> <xs:element name="taskTimerEventDuration" type="xs:integer"/> <xs:element name="AllowsReassign" type="xs:boolean"/> <xs:element name="SendNotification" type="xs:boolean"/> <xs:element name="SendAlarms" type="xs:boolean"/> <xs:element name="ExtendedEstimatedDuration" type="xs:integer"/> <xs:element name="Form" type="xs:integer"/> <xs:element name="IsAsynchTask" type="xs:boolean"/> <xs:element name="NumberOfRetries" type="xs:integer"/> <xs:element name="RetryInterval" type="xs:integer"/> <xs:element name="ShowFeedback" type="xs:boolean"/> <xs:element name="TimeoutSeconds" type="xs:integer"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="process"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:integer"/> <xs:element name="processRadNumber" type="xs:integer"/> <xs:element name="processCreationDate" type="xs:dateTime"/> <xs:element name="processSolutionDate" type="xs:dateTime"/> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:integer"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassHelpURL" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:integer"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:integer"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode" type="xs:string"/> <xs:element name="errorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:schema>
getApplications
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="applications"> <xs:complexType> <xs:sequence> <xs:element name="application" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="applicationId" type="xs:unsignedByte"/> <xs:element name="applicationName" type="xs:string"/> <xs:element name="applicationDisplayName" type="xs:string"/> <xs:element name="applicationCreationDate" type="xs:dateTime"/> <xs:element name="applicationAllocationPrinciple" type="xs:string"/> <xs:element name="applicationOrganizationId" type="xs:unsignedByte"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
getCases, getCasesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="domain" type="xs:string" minOccurs="0"/> <xs:element name="userName" type="xs:string" minOccurs="0"/> <xs:element name="radNumber" type="xs:string" minOccurs="0"/> <xs:element name="applicationName" type="xs:string" minOccurs="0"/> <xs:element name="categoryName" type="xs:string" minOccurs="0"/> <xs:element name="processName" type="xs:string" minOccurs="0"/> <xs:element name="idCase" type="xs:integer" minOccurs="0"/> <xs:element name="subprocessDepth" type="xs:integer" minOccurs="0"/> <xs:element name="creationDate" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="From" type="xs:dateTime" minOccurs="0"/> <xs:element name="To" type="xs:dateTime" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="expirationDate" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="From" type="xs:dateTime" minOccurs="0"/> <xs:element name="To" type="xs:dateTime" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="processes"> <xs:complexType> <xs:sequence> <xs:element name="process"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:unsignedShort"/> <xs:element name="processRadNumber" type="xs:unsignedShort"/> <xs:element name="savedMessage"> <xs:complexType> <xs:sequence> <xs:element name="Entities" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processCreationDate" type="xs:dateTime"/> <xs:element name="processSolutionDate" type="xs:dateTime"/> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:unsignedByte"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription"/> <xs:element name="workflowClassHelpText"/> <xs:element name="workflowClassHelpURL"/> <xs:element name="workflowClassDisplayOrder" type="xs:unsignedByte"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:unsignedByte"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode"/> <xs:element name="errorMessage"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="CurrentWorkItems"> <xs:complexType> <xs:sequence> <xs:element name="workItem"> <xs:complexType> <xs:sequence> <xs:element name="workItemId" type="xs:unsignedShort"/> <xs:element name="workItemState" type="xs:string"/> <xs:element name="workItemEntryDate" type="xs:dateTime"/> <xs:element name="workItemDuration" type="xs:unsignedByte"/> <xs:element name="workItemSubprocesses"/> <xs:element name="workItemEstimatedSolutionDate" type="xs:dateTime"/> <xs:element name="workItemSolutionDate" type="xs:dateTime"/> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:unsignedByte"/> <xs:element name="taskName" type="xs:string"/> <xs:element name="taskDisplayName" type="xs:string"/> <xs:element name="taskDescription"/> <xs:element name="taskHelpText"/> <xs:element name="taskEstimatedDuration" type="xs:unsignedByte"/> <xs:element name="taskType" type="xs:string"/> <xs:element name="taskCost" type="xs:unsignedByte"/> <xs:element name="taskPriority" type="xs:string"/> <xs:element name="taskTransactional" type="xs:boolean"/> <xs:element name="taskCompensation" type="xs:boolean"/> <xs:element name="taskTimerEventDuration" type="xs:unsignedByte"/> <xs:element name="AllowsReassign" type="xs:boolean"/> <xs:element name="SendNotification" type="xs:boolean"/> <xs:element name="SendAlarms" type="xs:boolean"/> <xs:element name="ExtendedEstimatedDuration" type="xs:unsignedByte"/> <xs:element name="Form" type="xs:unsignedByte"/> <xs:element name="IsAsynchTask" type="xs:boolean"/> <xs:element name="NumberOfRetries" type="xs:unsignedByte"/> <xs:element name="RetryInterval" type="xs:unsignedByte"/> <xs:element name="ShowFeedback" type="xs:boolean"/> <xs:element name="TimeoutSeconds" type="xs:unsignedByte"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
getCategories, getCategoriesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="application" type="xs:string"/> <xs:element name="language" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="categories"> <xs:complexType> <xs:sequence> <xs:element name="category"> <xs:complexType> <xs:sequence> <xs:element name="categoryId" type="xs:unsignedByte"/> <xs:element name="categoryName" type="xs:string"/> <xs:element name="categoryDisplayName" type="xs:string"/> <xs:element name="categoryDescription"/> <xs:element name="categoryHelpText"/> <xs:element name="categoryDisplayOrder" type="xs:unsignedByte"/> <xs:element name="categoryCreationDate" type="xs:dateTime"/> <xs:element name="parentCategoryId" type="xs:unsignedByte"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
getCategoriesFromApplicationName
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="categories"> <xs:complexType> <xs:sequence> <xs:element name="category"> <xs:complexType> <xs:sequence> <xs:element name="categoryId" type="xs:unsignedByte"/> <xs:element name="categoryName" type="xs:string"/> <xs:element name="categoryDisplayName" type="xs:string"/> <xs:element name="categoryDescription"/> <xs:element name="categoryHelpText"/> <xs:element name="categoryDisplayOrder" type="xs:unsignedByte"/> <xs:element name="categoryCreationDate" type="xs:dateTime"/> <xs:element name="parentCategoryId" type="xs:unsignedByte"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
getClosedActivities, getClosedActivitiesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="idCase" type="xs:integer" minOccurs="0"/> <xs:element name="subprocessDepth" type="xs:integer" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> <xs:element name="workItems"> <xs:complexType> <xs:sequence> <xs:element name="workItem" type="workItemType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:complexType name="workItemType"> <xs:sequence> <xs:element name="workItemId" type="xs:integer"/> <xs:element name="workItemState" type="xs:string"/> <xs:element name="workItemEntryDate" type="xs:dateTime"/> <xs:element name="workItemDuration" type="xs:integer"/> <xs:element name="workItemSubprocesses"> <xs:complexType> <xs:sequence> <xs:element name="workItems" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="workItem" type="workItemType" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="workItemEstimatedSolutionDate" type="xs:dateTime"/> <xs:element name="workItemSolutionDate" type="xs:dateTime"/> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:integer"/> <xs:element name="taskName" type="xs:string"/> <xs:element name="taskDisplayName" type="xs:string"/> <xs:element name="taskDescription" type="xs:string"/> <xs:element name="taskHelpText" type="xs:string"/> <xs:element name="HelpURL" type="xs:string"/> <xs:element name="taskEstimatedDuration" type="xs:integer"/> <xs:element name="taskType" type="xs:string"/> <xs:element name="taskCost" type="xs:integer"/> <xs:element name="taskPriority" type="xs:string"/> <xs:element name="taskTransactional" type="xs:boolean"/> <xs:element name="taskCompensation" type="xs:boolean"/> <xs:element name="taskTimerEventDuration" type="xs:integer"/> <xs:element name="AllowsReassign" type="xs:boolean"/> <xs:element name="SendNotification" type="xs:boolean"/> <xs:element name="SendAlarms" type="xs:boolean"/> <xs:element name="ExtendedEstimatedDuration" type="xs:integer"/> <xs:element name="Form" type="xs:integer"/> <xs:element name="IsAsynchTask" type="xs:boolean"/> <xs:element name="NumberOfRetries" type="xs:integer"/> <xs:element name="RetryInterval" type="xs:integer"/> <xs:element name="ShowFeedback" type="xs:boolean"/> <xs:element name="TimeoutSeconds" type="xs:integer"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="process"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:integer"/> <xs:element name="processRadNumber" type="xs:integer"/> <xs:element name="processCreationDate" type="xs:dateTime"/> <xs:element name="processSolutionDate" type="xs:dateTime"/> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:integer"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassHelpURL" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:integer"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:integer"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode" type="xs:string"/> <xs:element name="errorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:schema>
getEvent, getEventsAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="domain" type="xs:string" minOccurs="0"/> <xs:element name="userName" type="xs:string" minOccurs="0"/> <xs:element name="radNumber" type="xs:string" minOccurs="0"/> <xs:element name="processName" type="xs:string" minOccurs="0"/> <xs:element name="idCase" type="xs:integer" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> <xs:element name="workItems"> <xs:complexType> <xs:sequence> <xs:element name="workItem" type="workItemType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:complexType name="workItemType"> <xs:sequence> <xs:element name="workItemId" type="xs:integer"/> <xs:element name="workItemState" type="xs:string"/> <xs:element name="workItemEntryDate" type="xs:dateTime"/> <xs:element name="workItemDuration" type="xs:integer"/> <xs:element name="workItemEstimatedSolutionDate" type="xs:dateTime"/> <xs:element name="workItemSolutionDate" type="xs:dateTime"/> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:integer"/> <xs:element name="taskName" type="xs:string"/> <xs:element name="taskDisplayName" type="xs:string"/> <xs:element name="taskDescription" type="xs:string"/> <xs:element name="taskHelpText" type="xs:string"/> <xs:element name="HelpURL" type="xs:string"/> <xs:element name="taskEstimatedDuration" type="xs:integer"/> <xs:element name="taskType" type="xs:string"/> <xs:element name="taskCost" type="xs:integer"/> <xs:element name="taskPriority" type="xs:string"/> <xs:element name="taskTransactional" type="xs:boolean"/> <xs:element name="taskCompensation" type="xs:boolean"/> <xs:element name="taskTimerEventDuration" type="xs:integer"/> <xs:element name="AllowsReassign" type="xs:boolean"/> <xs:element name="SendNotification" type="xs:boolean"/> <xs:element name="SendAlarms" type="xs:boolean"/> <xs:element name="ExtendedEstimatedDuration" type="xs:integer"/> <xs:element name="Form" type="xs:integer"/> <xs:element name="IsAsynchTask" type="xs:boolean"/> <xs:element name="NumberOfRetries" type="xs:integer"/> <xs:element name="RetryInterval" type="xs:integer"/> <xs:element name="ShowFeedback" type="xs:boolean"/> <xs:element name="TimeoutSeconds" type="xs:integer"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:schema>
getWorkflowClasses, getWorkflowClassesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="category" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="workflowClasses"> <xs:complexType> <xs:sequence> <xs:element name="workflowClass" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:unsignedByte"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription"/> <xs:element name="workflowClassHelpText"/> <xs:element name="workflowClassHelpURL"/> <xs:element name="workflowClassDisplayOrder" type="xs:unsignedByte"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:unsignedByte"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
getWorkflowClassesFromCategoryName
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="workflowClasses"> <xs:complexType> <xs:sequence> <xs:element name="workflowClass" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:unsignedByte"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription"/> <xs:element name="workflowClassHelpText"/> <xs:element name="workflowClassHelpURL"/> <xs:element name="workflowClassDisplayOrder" type="xs:unsignedByte"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:unsignedByte"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
performActivity, performActivityAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="domain" type="xs:string"/> <xs:element name="userName" type="xs:string"/> <xs:element name="ActivityData"> <xs:complexType> <xs:sequence> <xs:choice> <xs:element name="idCase" type="xs:integer"/> <xs:element name="radNumber" type="xs:string"/> </xs:choice> <xs:choice> <xs:element name="taskId" type="xs:integer"/> <xs:element name="taskName" type="xs:string"/> </xs:choice> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="Entities"> <xs:complexType/> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="process"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:unsignedShort"/> <xs:element name="processRadNumber" type="xs:unsignedShort"/> <xs:element name="savedMessage"> <xs:complexType> <xs:sequence> <xs:element name="Entities" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:unsignedByte"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:unsignedByte"/> <xs:element name="workflowClassCreationDate" type="xs:string"/> <xs:element name="workflowClassGlobalForm" type="xs:unsignedByte"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:string"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode" type="xs:string"/> <xs:element name="errorMessage"> <xs:complexType mixed="true"> <xs:sequence minOccurs="0"> <xs:element name="Entities"> <xs:complexType> <xs:sequence> <xs:element name="Path" type="xs:string"/> <xs:element name="Atrib" type="xs:string"/> <xs:element name="Value" type="xs:string"/> <xs:element name="ErrorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="CurrentWorkItems"> <xs:complexType> <xs:sequence> <xs:element name="workItem"> <xs:complexType> <xs:sequence> <xs:element name="workItemId" type="xs:unsignedShort"/> <xs:element name="workItemState" type="xs:string"/> <xs:element name="workItemEntryDate" type="xs:string"/> <xs:element name="workItemDuration" type="xs:unsignedByte"/> <xs:element name="workItemEstimatedSolutionDate" type="xs:string"/> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:unsignedByte"/> <xs:element name="taskName" type="xs:string"/> <xs:element name="taskDisplayName" type="xs:string"/> <xs:element name="taskDescription" type="xs:string"/> <xs:element name="taskHelpText" type="xs:string"/> <xs:element name="taskEstimatedDuration" type="xs:unsignedByte"/> <xs:element name="taskType" type="xs:string"/> <xs:element name="taskCost" type="xs:unsignedByte"/> <xs:element name="taskPriority" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
resumeCases, resumeCasesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="Cases"> <xs:complexType> <xs:sequence> <xs:element name="idCase" type="xs:integer" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="qualified"> <xs:element name="processes"> <xs:complexType> <xs:sequence> <xs:element name="process" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:integer"/> <xs:element name="processRadNumber" type="xs:string"/> <xs:element name="processCreationDate" type="xs:dateTime"/> <xs:element name="processSolutionDate" type="xs:dateTime"/> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:integer"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassHelpURL" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:integer"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:integer"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode" type="xs:integer"/> <xs:element name="errorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
saveActivity, saveActivityAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="domain" type="xs:string"/> <xs:element name="userName" type="xs:string"/> <xs:element name="ActivityData"> <xs:complexType> <xs:sequence> <xs:element name="radNumber" type="xs:string"/> <xs:element name="taskName" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="Entities"> <xs:complexType/> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="process"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:integer"/> <xs:element name="processRadNumber" type="xs:string"/> <xs:element name="savedMessage"> <xs:complexType> <xs:sequence> <xs:element name="Entities" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processCreationDate" type="xs:dateTime"/> <xs:element name="processSolutionDate" type="xs:dateTime"/> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:integer"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassHelpURL" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:integer"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:integer"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode"/> <xs:element name="errorMessage"> <xs:complexType mixed="true"> <xs:sequence minOccurs="0"> <xs:element name="Entities"> <xs:complexType> <xs:sequence> <xs:element name="Path" type="xs:string"/> <xs:element name="Atrib" type="xs:string"/> <xs:element name="Value" type="xs:string"/> <xs:element name="ErrorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="CurrentWorkItems"> <xs:complexType> <xs:sequence> <xs:element name="workItem"> <xs:complexType> <xs:sequence> <xs:element name="workItemId" type="xs:integer"/> <xs:element name="workItemState" type="xs:string"/> <xs:element name="workItemEntryDate" type="xs:dateTime"/> <xs:element name="workItemDuration" type="xs:integer"/> <xs:element name="workItemSubprocesses"/> <xs:element name="workItemEstimatedSolutionDate" type="xs:dateTime"/> <xs:element name="workItemSolutionDate" type="xs:dateTime"/> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:integer"/> <xs:element name="taskName" type="xs:string"/> <xs:element name="taskDisplayName" type="xs:string"/> <xs:element name="taskDescription" type="xs:string"/> <xs:element name="taskHelpText" type="xs:string"/> <xs:element name="taskEstimatedDuration" type="xs:integer"/> <xs:element name="taskType" type="xs:string"/> <xs:element name="taskCost" type="xs:integer"/> <xs:element name="taskPriority" type="xs:string"/> <xs:element name="taskTransactional" type="xs:boolean"/> <xs:element name="taskCompensation" type="xs:boolean"/> <xs:element name="taskTimerEventDuration" type="xs:integer"/> <xs:element name="AllowsReassign" type="xs:boolean"/> <xs:element name="SendNotification" type="xs:boolean"/> <xs:element name="SendAlarms" type="xs:boolean"/> <xs:element name="ExtendedEstimatedDuration" type="xs:integer"/> <xs:element name="Form" type="xs:integer"/> <xs:element name="IsAsynchTask" type="xs:boolean"/> <xs:element name="NumberOfRetries" type="xs:integer"/> <xs:element name="RetryInterval" type="xs:integer"/> <xs:element name="ShowFeedback" type="xs:boolean"/> <xs:element name="TimeoutSeconds" type="xs:integer"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
setEvent, setEventAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="domain" type="xs:string"/> <xs:element name="userName" type="xs:string"/> <xs:element name="Events"> <xs:complexType> <xs:sequence> <xs:element name="Event" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="EventData"> <xs:complexType> <xs:sequence> <xs:choice> <xs:element name="idCase" type="xs:integer" minOccurs="0"/> <xs:element name="radNumber" type="xs:string" minOccurs="0"/> </xs:choice> <xs:choice> <xs:element name="idTask" type="xs:integer" minOccurs="0"/> <xs:element name="eventName" type="xs:string" minOccurs="0"/> </xs:choice> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="Entities"> <xs:complexType/> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="processes"> <xs:complexType> <xs:sequence> <xs:element name="process"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:integer"/> <xs:element name="processRadNumber" type="xs:string"/> <xs:element name="savedMessage"> <xs:complexType> <xs:sequence> <xs:element name="Entities" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processCreationDate" type="xs:dateTime"/> <xs:element name="processSolutionDate" type="xs:dateTime"/> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:integer"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassHelpURL" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:integer"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:integer"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode"/> <xs:element name="errorMessage"> <xs:complexType mixed="true"> <xs:sequence minOccurs="0"> <xs:element name="Entities"> <xs:complexType> <xs:sequence> <xs:element name="Path" type="xs:string"/> <xs:element name="Atrib" type="xs:string"/> <xs:element name="Value" type="xs:string"/> <xs:element name="ErrorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="CurrentWorkItems"> <xs:complexType> <xs:sequence> <xs:element name="workItem"> <xs:complexType> <xs:sequence> <xs:element name="workItemId" type="xs:integer"/> <xs:element name="workItemState" type="xs:string"/> <xs:element name="workItemEntryDate" type="xs:dateTime"/> <xs:element name="workItemDuration" type="xs:integer"/> <xs:element name="workItemSubprocesses"/> <xs:element name="workItemEstimatedSolutionDate" type="xs:dateTime"/> <xs:element name="workItemSolutionDate" type="xs:dateTime"/> <xs:element name="task"> <xs:complexType> <xs:sequence> <xs:element name="taskId" type="xs:integer"/> <xs:element name="taskName" type="xs:string"/> <xs:element name="taskDisplayName" type="xs:string"/> <xs:element name="taskDescription" type="xs:string"/> <xs:element name="taskHelpText" type="xs:string"/> <xs:element name="taskEstimatedDuration" type="xs:integer"/> <xs:element name="taskType" type="xs:string"/> <xs:element name="taskCost" type="xs:integer"/> <xs:element name="taskPriority" type="xs:string"/> <xs:element name="taskTransactional" type="xs:boolean"/> <xs:element name="taskCompensation" type="xs:boolean"/> <xs:element name="taskTimerEventDuration" type="xs:integer"/> <xs:element name="AllowsReassign" type="xs:boolean"/> <xs:element name="SendNotification" type="xs:boolean"/> <xs:element name="SendAlarms" type="xs:boolean"/> <xs:element name="ExtendedEstimatedDuration" type="xs:integer"/> <xs:element name="Form" type="xs:integer"/> <xs:element name="IsAsynchTask" type="xs:boolean"/> <xs:element name="NumberOfRetries" type="xs:integer"/> <xs:element name="RetryInterval" type="xs:integer"/> <xs:element name="ShowFeedback" type="xs:boolean"/> <xs:element name="TimeoutSeconds" type="xs:integer"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
suspendCases, suspendCasesAsString
Request
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="BizAgiWSParam"> <xs:complexType> <xs:sequence> <xs:element name="Cases"> <xs:complexType> <xs:sequence> <xs:element name="idCase" type="xs:integer" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Response
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="qualified"> <xs:element name="processes"> <xs:complexType> <xs:sequence> <xs:element name="process" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="processId" type="xs:integer"/> <xs:element name="processRadNumber" type="xs:string"/> <xs:element name="processCreationDate" type="xs:dateTime"/> <xs:element name="processSolutionDate" type="xs:dateTime"/> <xs:element name="processWorkflowClass"> <xs:complexType> <xs:sequence> <xs:element name="workflowClassId" type="xs:integer"/> <xs:element name="workflowClassName" type="xs:string"/> <xs:element name="workflowClassDisplayName" type="xs:string"/> <xs:element name="workflowClassDescription" type="xs:string"/> <xs:element name="workflowClassHelpText" type="xs:string"/> <xs:element name="workflowClassHelpURL" type="xs:string"/> <xs:element name="workflowClassDisplayOrder" type="xs:integer"/> <xs:element name="workflowClassCreationDate" type="xs:dateTime"/> <xs:element name="workflowClassGlobalForm" type="xs:integer"/> <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/> <xs:element name="workflowClassProcessType" type="xs:string"/> <xs:element name="workflowClassDisplay" type="xs:boolean"/> <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/> <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="processError"> <xs:complexType> <xs:sequence> <xs:element name="errorCode" type="xs:integer"/> <xs:element name="errorMessage" type="xs:string"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
<comments />