[This is preliminary documentation and is subject to change.]
Enables a user to tag a document revision as being referenced by another system.
This tag shows in the Q-Pulse UI against the record.
Namespace:
QPulseWebServices.Contracts.ServiceAssembly: QPulseWebServices.Contracts (in QPulseWebServices.Contracts.dll) Version: 2.0.590.81
Syntax
| C# |
|---|
void AddDocumentRevisionTag( string token, int revisionID, string tagSource, string tagReference, string tagText ) |
Parameters
- token
- Type: System..::.String
An authentication token previously requested from the Core service.
- revisionID
- Type: System..::.Int32
the id of the document revision which is to be tagged
- tagSource
- Type: System..::.String
the name of the source system which has tagged the document
- tagReference
- Type: System..::.String
an identifier to the source item which has tagged the document
- tagText
- Type: System..::.String
a message which is displayed to the user
Return Value
void
Exceptions
| Exception | Condition |
|---|---|
| ServiceFaultCode..::.AuthenticationFailed | The token provided could not be authenticated. |
| ServiceFaultCode..::.SessionInvalid | The Q-Pulse session was invalid. |
| ServiceFaultCode..::.ItemNotFoundInDatabase | The revision id was invalid. |