PwsAamIntegrationRef
- Bettina Borces
Overview
This structure represents all of the unique identifying fields associated with an Advanced Analytical Module (AAM) integration.
Advanced Analytical Module (AAM) integration can be identified by AamIntegrationId, AamIntegrationName or AamIntegrationUid. When specifying a PwsAamIntegrationRef as an input to a web service, you may specify any combination of one or more of these fields. However, if you do specify values for multiple fields, they must all refer to the same Aam integration or it will not be considered valid. When a PwsAamIntegrationRef is returned in the response to a web service, the AamIntegrationId, AamIntegrationName or AamIntegrationUid will be populated, and guaranteed to refer to a single Aam Integration.
Format
- PwsAamIntegrationRef
- AamIntegrationId: Int32
- AamIntegrationName: String
- AamIntegrationUid: Int64
Elements
Element | Data Type | Required? | Description | Sample Data |
|---|---|---|---|---|
AamIntegrationId | Int32 | One of AamIntegrationId, AamIntegrationName or AamIntegrationUid is required | The Aam Integration Id is a unique identifier for an Aam Integration. For internal use only | |
AamIntegrationName | String | See above | The Aam Integration name is a unique identifier for an Aam Integration. |
|
AamIntegrationUid | Int64 | See above | A unique and immutable identifier for an Aam Integration. |
|
Usage Example(s)
<req:AamIntegrationIdentity>
<com:AamIntegrationName>Projector BI</com:AamIntegrationName>
<com:AamIntegrationUid>1152921504606847099</com:AamIntegrationUid>
</req:AamIntegrationIdentity>