SOAP Documentation: QM Controls

Overview

This resource provides methods to create, read, update and delete attribute data from the Controls data collection object in a Quality Management instance of TraceGains.

Operations List

The Operations List for this resource: QM Controls Operations List.

Resource WSDL

The WSDL for this resource can be found here: QM Controls WSDL.

Endpoint URLs

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

Delete

Enterprise | QM

 Deletes a Controls data record by its ID.

The methods List or Query can be used to retrieve the IDs of Controls data records.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
recordId String The ID of the Control data record 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.

List

Enterprise | QM

 Returns a paged list of Controls data records using basic request parameters.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Controls data records that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Controls data records that have been modified before this date and time.
pageCriteria PagingCriteria Row index paging criteria.
attributeType AttributeRequestType Determines what type of Attributes to return.
attributeIds
repeating		 String A list of Attribute IDs that you would like the method to consider for return.

Notes:
This parameter is optional and used in combination with AttributeRequestType. If your Quality Management instance is configured with extended attribute storage, you can improve the performance of this method by limiting the attributes considered for return by providing this parameter.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Controls
repeating 		Control The list of returned Controls data records.

Query

Enterprise | QM

 Returns a paged list of Controls data records using more advanced request parameters.

Notes:

This method queries raw record data in your TraceGains instance using contains or partial match filtering for all attribute data provided in the filterValues parameter. This behavior is consistent with grid view filtering in the TraceGains UI and reduces the amount of calls to the method required to find similarly sequenced data.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Controls data records that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Controls data records that have been modified before this date and time.
pageCriteria PagingCriteria Row index paging criteria.
attributeType AttributeRequestType Determines what type of Attributes to return.
filterValues
repeating		 AttributeValue A list of attribute-value pairs to filter returned Controls data records. Attributes must be of type DataCollection as defined in AttributeUseType. All others will be ignored.
attributeIds
repeating		 String A list of Attribute IDs that you would like the method to consider for return.

Notes:
This parameter is optional and used in combination with AttributeRequestType. If your Quality Management instance is configured with extended attribute storage, you can improve the performance of this method by limiting the attributes considered for return by providing this parameter.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Controls
repeating 		Control The list of returned Controls data records.

Upload

Enterprise | QM

 Creates/updates Controls data records based on key attribute configuration.

This method will create or update existing Controls data records based on the key attributes provided in the controlsData attribute list. It is recommend that all currently configured key attributes be included in each call to this method, or unexpected results could occur.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
controlsData
repeating		 AttributeValue A list of attribute-value pairs to add/update for the Controls record. Attributes must be of type DataCollection as defined in AttributeUseType. All others will be ignored.

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.