SOAP Documentation: Item Datasheets

Overview

This resource provides methods to manage your TraceGains Item Datasheets.

Operations List

The Operations List for this resource: Item Datasheets Operations List.

Resource WSDL

The WSDL for this resource can be found here: Item Datasheets WSDL.

Endpoint URLs

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

Create

Enterprise | FM

 Creates a new Item Datasheet.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String The ID of an existing configuration Item.
version UInteger A number used as the version of the datasheet.
attributeList
repeating		 AttributeValue A list of attribute-value pairs to add to the new Item Datasheet. Attributes must be of type Item Datasheet 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.

Delete

Enterprise | FM

 Deletes an Item Datasheet by Item ID and version.

Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String The ID of an existing configuration Item.
version UInteger The version number of the Item Datasheet to remove from configuration.

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

 Returns a single Item Datsheet by Item ID and version number.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String The ID of an existing configuration Item.
version UInteger The version number of the Item Datasheet to return.
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.
Datasheet DatasheetResult The returned Item Datasheet record.

GetAll

Enterprise | FM

 Returns all active Item Datsheets for an Item ID.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String The ID of an existing configuration Item.
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.
Datasheet
repeating		 DatasheetResult The list of returned Item Datasheet records.

GetLatest

Enterprise | FM

 Returns a single Item Datsheet by Item ID and version number.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String The ID of an existing configuration Item.
version UInteger The version number of the Item Datasheet to return.
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.
Datasheet DatasheetResult The returned Item Datasheet record.

List

Enterprise | FM

 Returns a paged list of Item Datasheets 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 Item Datssheets that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns Item Datasheets 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.
Datasheet
repeating		 DatasheetResult The list of returned Item Datasheet records.

Update

Enterprise | FM

 Updates an existing Item Datasheet.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
itemId String The ID of an existing configuration Item.
version UInteger The version number of an existing Item Datasheet.
attributeList
repeating		 AttributeValue A list of attribute-value pairs to add to the new Item Datasheet. Attributes must be of type Item Datasheet 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.