SOAP Documentation: Specifications

Overview

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

Operations List

The Operations List for this resource: Specifications Operations List.

Resource WSDL

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

Endpoint URLs

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

Create

Enterprise | SM

 Creates a new Specification record.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String The ID of the Item.
specType String The Type of the Specification.
version String The version number of the Specification.
attributeList
repeating		 AttributeValue A list of attribute-value pairs to add/update for the Specification. Attributes must be of type Specification as defined in AttributeUseType. All others will be ignored.

When including measurement attributes, use the following format for the attribute's value:
<Value>Low:x High:y Target:z Uom: Other: Method:</Value>
(where x, y, and z are placeholders for actual values).


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 | SPM

 Returns a paged list of Specification 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 Specification 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 Specification 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.

Response:

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

ListDocuments

Enterprise | SPM

 Returns a paged list of documents for a Specification ID.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
specId Integer The ID of a Specification data record.
includeArchived Boolean Indicates whether to return archived documents in the result.
pageCriteria PagingCriteria Row index paging criteria.

Response:

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

Query

Enterprise | SPM

 Returns a paged list of Specification 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 Specification 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 Specification 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 Specification data records. Attributes must be of type Specification as defined in AttributeUseType. All others will be ignored.

Response:

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

Share

Enterprise | SPM

 Shares a Specification with the specified supplier.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
emailProfile String The email profile to use when sending the notification to the supplier that the Specification has been shared with them.
specId Integer The ID of the Specification to be shared.
supplierId String The ID of the Supplier with which the Specification is to be shared.

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

Update

Enterprise | SM

 Updates an existing Specification.


Request:

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

When including measurement attributes, use the following format for the attribute's value:
<Value>Low:x High:y Target:z Uom: Other: Method:</Value>
(where x, y, and z are placeholders for actual values).


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

Upload

Enterprise | SPM

 Creates or updates Specification data records.

This method will create or update existing Specification data records based on the attributes provided in the specData attribute list.


   When creating a new specification, these attributes are required:

  • Item ID_SpecMgmt
  • Specification Type_SpecMgmt
  • Version Name_SpecMgmt

   When updating an existing specification, these attributes are required:

  • Item ID_SpecMgmt
  • Version_SpecMgmt

Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
specData
repeating		 AttributeValue A list of attribute-value pairs to add/update for the Specification. Attributes must be of type Specification as defined in AttributeUseType. All others will be ignored.
tableData
repeating		 TableDataValue Data structured as Table:Section:Row:Cell to be imported into one or more Table Templates configured for the specification.

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.