SOAP Documentation: Items

Overview

This resource provides methods to manage your TraceGains Items.

Operations List

The Operations List for this resource: Items Operations List.

Resource WSDL

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

Endpoint URLs

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

Assign

Enterprise | SM QM

 Assigns a single Item to 1 or more Suppliers.


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 to assign.
supplierId
repeating		 String A list of 1 or more Supplier IDs to assign to the Item.

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

Create

Enterprise | SM QM

 Creates a new Item.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
item Item An Item object. Identical to the ItemResult object.

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 QM

 Deletes an Item by its ID.

Notes:

  • Linked Suppliers will be unmapped.
  • All documents for this Item will be deleted.
  • All TraceGains GatherTM data for this Item will be deleted.

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

 Returns a single Item by an ID.


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 to return.
includeAttributes Boolean False to not return attributes. True to return attributes.

Response:

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

List

Enterprise | SM QM

 Returns a paged list of Items using basic request parameters.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
includeInactive Boolean False to return only active Items. True to return both active and inactive Items.
fromModifiedDate DateTime ISO 8601 formatted date/time string. Returns Items that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string. Returns Items 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.
Item
repeating 		ItemResult The list of returned Items.

ListGroups

Enterprise | SM QM

 Lists all active Item 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.

Unassign

Enterprise | SM QM

 Unassigns a single Item from 1 or more Suppliers.

Notes:

  • All documents associated with each Supplier assignment will deleted.

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 to unassign.
supplierId
repeating		 String A list of 1 or more Supplier IDs to unassign from the Item.

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 QM

 Updates an existing Item.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String An existing Item ID.
item Item An Item object. Identical to the ItemResult object.

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.