Transaction System API

TagManager

Manager for working with tags.

Method Summary
  deleteMessageTag(String messageId, String tagName)

Deletes the tag.

  deleteMessageTags(String messageId)

Deletes all tags for the message.

  deleteTransactionTag(String txId, String tagName)

Deletes the tag.

  deleteTransactionTags(String txId)

Deletes all tags for the transaction.

Tag getMessageTag(String messageId, String tagName)

Returns the specified tag.

SystemDataView getMessageTags()

Returns a view for access tags of type message.

Tag getTransactionTag(String txId, String tagName)

Returns the specified tag.

SystemDataView getTransactionTags()

Returns a view for access tags of type transaction.

Method Detail


deleteMessageTag(String messageId, String tagName)

Deletes the tag.

Parameters:

  • String   messageId Required parameter.
  • String   tagName Required parameter.

Since: 01-10-2013

top

deleteMessageTags(String messageId)

Deletes all tags for the message.

Parameters:

  • String   messageId Required parameter.

Since: 01-10-2013

top

deleteTransactionTag(String txId, String tagName)

Deletes the tag.

Parameters:

  • String   txId Required parameter.
  • String   tagName Required parameter.

Since: 01-10-2013

top

deleteTransactionTags(String txId)

Deletes all tags for the transaction.

Parameters:

  • String   txId Required parameter.

Since: 01-10-2013

top

Tag getMessageTag(String messageId, String tagName)

Returns the specified tag.

Parameters:

  • String   messageId Required parameter.
  • String   tagName Required parameter.

Returns:  Tag

Since: 01-10-2013

top

SystemDataView getMessageTags()

Returns a view for access tags of type message.

Returns:  SystemDataView


DataList Name: MessageTags
Tag Support: No
DataList Keys/Column Name Column Type Read Only
palId String  
tagId String  
tagName String  
tagValue String  
tagDate Date  
tagFloat  

Since: 01-10-2013

top

Tag getTransactionTag(String txId, String tagName)

Returns the specified tag.

Parameters:

  • String   txId Required parameter.
  • String   tagName Required parameter.

Returns:  Tag

Since: 01-10-2013

top

SystemDataView getTransactionTags()

Returns a view for access tags of type transaction.

Returns:  SystemDataView


DataList Name: TransactionTags
Tag Support: No
DataList Keys/Column Name Column Type Read Only
palId String  
tagId String  
tagName String  
tagValue String  
tagDate Date  
tagFloat  

Since: 01-10-2013

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM