The TraceGains V7 SOAP Attributes API.
Click here for a complete list of operations.
Get
Returns a single Attribute.
The test form is only available for requests from the local machine.
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /v7/soap/Attributes.asmx HTTP/1.1 Host: api-test.tracegains.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.tracegains.net/v7/soap/Get" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Get xmlns="https://api.tracegains.net/v7/soap"> <appKey>guid</appKey> <sessionId>guid</sessionId> <attributeId>string</attributeId> <includeRules>boolean</includeRules> </Get> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetResponse xmlns="https://api.tracegains.net/v7/soap"> <GetResult> <Attribute> <ID>string</ID> <Name>string</Name> <Group>string</Group> <DataType>DateTime or Email or Float or Integer or Comment or Text or TrueFalse or Date or Derived or YesNo or Image or ActiveInactive or Measurement or RawHtml</DataType> <Use>string</Use> <StorageGroup>string</StorageGroup> <ColumnName>string</ColumnName> <Description>string</Description> <Script>string</Script> <IsSystem>boolean</IsSystem> <IsKey>boolean</IsKey> <IsComputed>boolean</IsComputed> <AppliesToAll>boolean</AppliesToAll> <BusinessRuleHeader> <ID>int</ID> <RuleType>DateTime or Email or Float or Integer or Comment or Text or TrueFalse or Date or Derived or YesNo or Image or ActiveInactive or Measurement or RawHtml</RuleType> <IsRestrictToList>boolean</IsRestrictToList> <IsRequired>boolean</IsRequired> <TrackChanges>boolean</TrackChanges> <UiControlType>None or DropDownList or RadioButtonGroup</UiControlType> <DefaultValue>string</DefaultValue> <ControlMin>string</ControlMin> <ControlMax>string</ControlMax> <IncludeInSpecPublishing>boolean</IncludeInSpecPublishing> <SpecificationName>string</SpecificationName> <SpecificationDescription>string</SpecificationDescription> <BusinessRules> <BusinessRule> <ID>int</ID> <Status>None or OutSpec or Warning</Status> <Action>None or Accept or Ask or Hold or Reject</Action> <Notification>string</Notification> <ForegroundColor>string</ForegroundColor> <BackgroundColor>string</BackgroundColor> <IsElseRule>boolean</IsElseRule> <Min>string</Min> <Max>string</Max> <Value>string</Value> </BusinessRule> <BusinessRule> <ID>int</ID> <Status>None or OutSpec or Warning</Status> <Action>None or Accept or Ask or Hold or Reject</Action> <Notification>string</Notification> <ForegroundColor>string</ForegroundColor> <BackgroundColor>string</BackgroundColor> <IsElseRule>boolean</IsElseRule> <Min>string</Min> <Max>string</Max> <Value>string</Value> </BusinessRule> </BusinessRules> <CreationDate>dateTime</CreationDate> <CreatedBy>string</CreatedBy> <UpdatedDate>dateTime</UpdatedDate> <UpdatedBy>string</UpdatedBy> </BusinessRuleHeader> <CreationDate>dateTime</CreationDate> <CreatedBy>string</CreatedBy> <UpdatedDate>dateTime</UpdatedDate> <UpdatedBy>string</UpdatedBy> </Attribute> </GetResult> </GetResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /v7/soap/Attributes.asmx HTTP/1.1 Host: api-test.tracegains.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <Get xmlns="https://api.tracegains.net/v7/soap"> <appKey>guid</appKey> <sessionId>guid</sessionId> <attributeId>string</attributeId> <includeRules>boolean</includeRules> </Get> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetResponse xmlns="https://api.tracegains.net/v7/soap"> <GetResult> <Attribute> <ID>string</ID> <Name>string</Name> <Group>string</Group> <DataType>DateTime or Email or Float or Integer or Comment or Text or TrueFalse or Date or Derived or YesNo or Image or ActiveInactive or Measurement or RawHtml</DataType> <Use>string</Use> <StorageGroup>string</StorageGroup> <ColumnName>string</ColumnName> <Description>string</Description> <Script>string</Script> <IsSystem>boolean</IsSystem> <IsKey>boolean</IsKey> <IsComputed>boolean</IsComputed> <AppliesToAll>boolean</AppliesToAll> <BusinessRuleHeader> <ID>int</ID> <RuleType>DateTime or Email or Float or Integer or Comment or Text or TrueFalse or Date or Derived or YesNo or Image or ActiveInactive or Measurement or RawHtml</RuleType> <IsRestrictToList>boolean</IsRestrictToList> <IsRequired>boolean</IsRequired> <TrackChanges>boolean</TrackChanges> <UiControlType>None or DropDownList or RadioButtonGroup</UiControlType> <DefaultValue>string</DefaultValue> <ControlMin>string</ControlMin> <ControlMax>string</ControlMax> <IncludeInSpecPublishing>boolean</IncludeInSpecPublishing> <SpecificationName>string</SpecificationName> <SpecificationDescription>string</SpecificationDescription> <BusinessRules> <BusinessRule> <ID>int</ID> <Status>None or OutSpec or Warning</Status> <Action>None or Accept or Ask or Hold or Reject</Action> <Notification>string</Notification> <ForegroundColor>string</ForegroundColor> <BackgroundColor>string</BackgroundColor> <IsElseRule>boolean</IsElseRule> <Min>string</Min> <Max>string</Max> <Value>string</Value> </BusinessRule> <BusinessRule> <ID>int</ID> <Status>None or OutSpec or Warning</Status> <Action>None or Accept or Ask or Hold or Reject</Action> <Notification>string</Notification> <ForegroundColor>string</ForegroundColor> <BackgroundColor>string</BackgroundColor> <IsElseRule>boolean</IsElseRule> <Min>string</Min> <Max>string</Max> <Value>string</Value> </BusinessRule> </BusinessRules> <CreationDate>dateTime</CreationDate> <CreatedBy>string</CreatedBy> <UpdatedDate>dateTime</UpdatedDate> <UpdatedBy>string</UpdatedBy> </BusinessRuleHeader> <CreationDate>dateTime</CreationDate> <CreatedBy>string</CreatedBy> <UpdatedDate>dateTime</UpdatedDate> <UpdatedBy>string</UpdatedBy> </Attribute> </GetResult> </GetResponse> </soap12:Body> </soap12:Envelope>