SOAP Documentation: Attributes

Overview

This resource provides methods to manage your TraceGains Attributes.

Operations List

The Operations List for this resource: Attributes Operations List.

Resource WSDL

The WSDL for this resource can be found here: Attributes WSDL.

Endpoint URLs

All requests should be sent to one of the following:
      Production Environment: https://api.tracegains.net/v7/soap/Attributes.asmx.
      Test Environment: https://api-test.tracegains.net/v7/soap/Attributes.asmx.

Create

Enterprise | SM SC SPM FM QM

 Creates a new Attribute.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
attribute Attribute The Attribute definition to create.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Delete

Enterprise | SM SC SPM FM QM

 Deletes an Attribute by its ID.

Notes:

All data collected for the Attribute is also deleted!


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
attributeId String The ID of the Attribute to delete.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Get

Enterprise | SM SC SPM FM QM

 Gets a single Attribute.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
attributeId String The ID of the Attribute to return.
includeRules Boolean Determines if the assigned Business Rules are returned with the Attribute.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Attribute AttributeResult The returned Attribute.

ListGroups

Enterprise | SM SC SPM FM QM

 Lists all active Attribute Groups.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.

Response:
ListResult This response could take on a different XML element name by method.

ListUses

Enterprise | SM SC SPM FM QM

 Lists all active Attribute Use types.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.

Response:
ListResult This response could take on a different XML element name by method.

ListStorageGroups

Enterprise | SM SC SPM FM QM

 Lists all active Attribute Storage Groups.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.

Response:
ListResult This response could take on a different XML element name by method.

Update

Enterprise | SM SC SPM FM QM

 Updates an existing Attribute.

Notes:

  • Properties that can be updated via the API after an Attribute has been created.
    • Name, Group, Description, Script, IsKey, IsComputed, AppliesToAll

Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
attribute Attribute The Attribute definition to update.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Version

 Reports the version information of this resource.


Request:

No Parameters


Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP Status Code
Message String A log friendly message that can be used in troubleshooting a failed response.
Version String The major, minor, and build number of this resource.