GET api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}/alias/{complianceAliasGuid}
Gets a specific compliance alias by uid.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
The portal UID we are looking in. |
globally unique identifier |
Required |
| complianceGuid |
The compliance GUID. |
globally unique identifier |
Required |
| complianceAliasGuid |
The compliance alias GUID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a specific compliance alias.
ComplianceAliasViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ComplianceAliasGuid |
The compliance alias guid |
globally unique identifier |
None. |
| ComplianceGuid |
The compliance item this alias is related to |
globally unique identifier |
None. |
| Name |
The alias for the compliance item |
string |
None. |
| DateCreated |
Date created |
date |
None. |
| DateUpdated |
Date last updated |
date |
None. |
| Uid |
The GUID. |
globally unique identifier |
None. |
| Links |
The links. |
Collection of Link |
None. |
| DateUpdated |
Last time the record was updated |
date |
None. |
| UpdatedBy |
Who updated the record last |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ComplianceAliasGuid": "27fedc9d-295d-403e-9dc5-e771b7e999b2",
"ComplianceGuid": "95b50b1a-e280-4b22-91ec-60e2933cef52",
"Name": "sample string 3",
"DateCreated": "2025-10-27T13:56:32.8287886+00:00",
"DateUpdated": "2025-10-27T13:56:32.8287886+00:00",
"Uid": "034c5c48-6eab-4776-82fb-49dfc75893d3",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"UpdatedBy": "sample string 7"
}
application/xml, text/xml
Sample:
<ComplianceAliasViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-10-27T13:56:32.8287886+00:00</DateUpdated>
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
</Links>
<Uid>034c5c48-6eab-4776-82fb-49dfc75893d3</Uid>
<UpdatedBy>sample string 7</UpdatedBy>
<ComplianceAliasGuid>27fedc9d-295d-403e-9dc5-e771b7e999b2</ComplianceAliasGuid>
<ComplianceGuid>95b50b1a-e280-4b22-91ec-60e2933cef52</ComplianceGuid>
<DateCreated>2025-10-27T13:56:32.8287886+00:00</DateCreated>
<DateUpdated>2025-10-27T13:56:32.8287886+00:00</DateUpdated>
<Name>sample string 3</Name>
</ComplianceAliasViewModel>