The method deletes entities.
Request
Delete
Parameters
username (String): Name of the user (syntax: system name / client number / user name / department)
When only one client is installed, the system name is optional.
password (String): Password of the user specified in username
mainType (String): Name of the main type of the entities you want to delete
format (String): Data format, must be XML or CSV
Siehe auch: Formats in Serialization.
failOnError (optional, Boolean): Flag indicating whether the processing of the command shall continue or abort in case of an error:If ‑failonerror option set to true, the processing of the command will stop if an error occurs.If ‑failonerror option set as false (default value), the processing will continue even in the case of an error.
data (XML or CSV): Data in the specified format (XML or CSV) listing the entities you want to delete
The entity you want to delete has to be uniquely identifiable via its identity properties.
See examples (XML or CSV) below.
Example: XML Data
<Sync xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="sync.xsd">
<Entity mainType="Workflow" customType="Install" typeVersion="1.0">
<Property name="system_name" isIdentity="true">
<Value>Install</Value>
</Property>
<Property name="system_application.system_name" isIdentity="true">
<Value>CRM</Value>
</Property>
</Entity>
<Entity mainType="Workflow" customType="Uninstall" typeVersion="1.0">
<Property name="system_name" isIdentity="true">
<Value>Uninstall</Value>
</Property>
<Property name="system_application.system_name" isIdentity="true">
<Value>CRM</Value>
</Property>
</Entity>
</Sync>
Example CSV Data
system_identity_properties,system_name,system_application.system_name system_name#;#system_application.system_name,Install,CRM
Response
See section Result object on WebService
Pre-Conditions
To delete a entity, the entity itself must fulfill certain conditions. Otherwise, an error message will appear. The specific conditions depend on the entity type.
Conditions to delete entities of type PackageEin Package ist eine Instanz (eine Version, eine Revision, ein Tag, ...) Ihrer Applikation und definiert den Content, den Sie deployen möchten. Hier entscheiden Sie, ob Sie die gesamte Applikation oder nur einige spezifische Komponenten deployen möchten. :
Conditions to delete entities of type Release:
Conditions to delete entities of type Environment:
Conditions to delete entities of type ReleaseStage:
Conditions to delete entities of type DeploymentDas Deployment einer einzelnen Applikationsrevision in eine Umgebung innerhalb einer einzelnen Aktivität. Profile:
Conditions to delete entities of type Application:
Conditions to delete entities of type DeploymentTarget:
Conditions to delete entities of type Reservation:
Conditions to delete entities of type Activity:
Conditions to delete entities of type Component:
Conditions to delete entities of type ComponentLink:
Conditions to delete entities of type workflow:
Conditions to delete entities of type User:
Conditions to delete entities of type UserGroup:
Conditions to delete entities of type TemplateActivity:
Conditions to delete entities of type Email Template:
Conditions to delete entities of type LoginObject:
Conditions to delete entities of type Queue:
Conditions to delete entities of type QueueRun:
Conditions to delete entities of type EnvironmentComparison: