All product information in wiki.bizagi.com is only valid for Bizagi BPM Suite 9.1.X.
For newer Bizagi BPM Suite versions (10.X and up) please visit the User Guide.
 

Entity Manager Schemas for Web Services

From Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS

Jump to: navigation, search

Contents

Entity Manager Schemas for Web Services

getCaseDataUsingXPaths and getCaseDataUsingXPathsAsString

Request

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="BizAgiWSParam">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="CaseInfo" minOccurs="1" maxOccurs="1">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="IdCase" minOccurs="0" maxOccurs="1" type="xs:integer" />
							<xs:element name="CaseNumber" minOccurs="0" maxOccurs="1" type="xs:integer" />
							<xs:element name="TaskName" minOccurs="0" maxOccurs="1" type="xs:string" />
							<xs:element name="IdTask" minOccurs="0" maxOccurs="1" type="xs:integer" />
							<xs:element name="IdWorkItem" minOccurs="0" maxOccurs="1" type="xs:integer" />
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="XPaths" minOccurs="1" maxOccurs="1">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="XPath" minOccurs="1" maxOccurs="unbounded">
								<xs:complexType>
									<xs:attribute name="XPath" type="xs:string" />
								</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 attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="BizAgiWSResponse">
		<xs:complexType>
			<xs:sequence>
				<xs:choice maxOccurs="unbounded">
					<xs:element name="XPath">
						<xs:complexType mixed="true">
							<xs:sequence minOccurs="0">
								<xs:element name="Items">
									<xs:complexType>
										<xs:sequence>
											<xs:element maxOccurs="unbounded" name="Item">
												<xs:complexType>
													<xs:simpleContent>
														<xs:extension base="xs:string">
															<xs:attribute name="Id" type="xs:integer" use="optional" />
															<xs:attribute name="FileName" type="xs:string" use="optional" />
														</xs:extension>
													</xs:simpleContent>
												</xs:complexType>
											</xs:element>
										</xs:sequence>
									</xs:complexType>
								</xs:element>
							</xs:sequence>
							<xs:attribute name="XPath" type="xs:string" use="required" />
						</xs:complexType>
					</xs:element>
					<xs:element name="Error">
						<xs:complexType>
							<xs:sequence>
								<xs:element name="ErrorCode" type="xs:integer" />
								<xs:element name="ErrorMessage" type="xs:string" />
							</xs:sequence>
							<xs:attribute name="XPath" type="xs:string" use="required" />
						</xs:complexType>
					</xs:element>
				</xs:choice>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

getEntities, getEntitiesAsString, getEntitiesUsingSchema and getEntitiesUsingSchemaAsString

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="EntityData">
					<xs:complexType>
						<xs:sequence>
							<xs:choice>
								<xs:element name="EntityName" type="xs:string"/>
								<xs:element name="EntityID" type="xs:integer"/>
							</xs:choice>
							<xs:element name="FilterDisabled" type="xs:boolean" minOccurs="0" />
							<xs:element name="Filters" type="xs:string" nillable="true" 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 attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="BizAgiWSResponse">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="Entities" maxOccurs="1">
					<xs:complexType />
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

saveEntity and saveEntityAsString

Request

<?xml version="1.0"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="BizAgiWSParam">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="Entities" maxOccurs="1">
					<xs:complexType/>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
</xs:schema>

Response

<?xml version="1.0"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="Entities">
		<xs:complexType/>
	</xs:element>
</xs:schema>

<comments />