DocumentObj 2.5 Delete
Deletes a particular version and language of an InfoShare object.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| psAuthContext | String | InOut | Deprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services, making this parameter redundant. |
| psLogicalId | String | In | The logical identifier of the object. |
| psVersion | String | In | The version of the object. This version number has to be an exact number. |
| psLanguage | String | In | The language of the object. |
| psResolution | String | In | The resolution of the object. Only used for illustrations: this parameter should be empty for any other object types. |
| psXMLRequiredCurrentMetadata | String | In | Metadata XML structure with the metadata that object is required to have set currently. The update of the object is only carried out when the object has exactly the same metadata specification, i.e. the metadata was not changed by someone else. |
Requirements are:
- The user must have write access for the folder in which the object is going to be deleted.
The table describes the behavior depending on your starting situation. [SRQ-3834]
| Action | Delete will fail... | Result |
|---|---|---|
| Delete the map starting from the logical object |
| The complete map is deleted including all versions and languages |
| Delete one version of a map |
| The version including all languages is deleted Note that: if the version is the last in the logical object - logical object also will be deleted. |
| Delete one language of a map |
| This language is deleted. Note that: if the language is the last in the version - version also will be deleted. |
Note that:
- All logical identifiers within Content Manager are in uppercase.
- The parameter
psXMLRequiredCurrentMetaDatacan be used to require that the delete only is carried out when the object is still in the same state as the users thinks it is. - Deleting logical object that is referenced by the other object (as a link, hyperlink etc.) is not allowed.
- Deleting logical object that is used as a resource on a publication is not allowed.
- Deleting logical object that is used as a master on a publication is not allowed.
- Deleting version object that has a branch started from it is not allowed.
- Deleting version object is not allowed if one of the language objects is not allowed to be deleted.
- Deleting language object that is a part of a released publication output is not allowed.
- When the language object is in a released status type, only administrators can delete the language object.
- Deleting language object that is checked out is not allowed.