POST api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}/alias

Create a compliance alias

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalUid

the portal we are creating the compliance alias in

globally unique identifier

Required

complianceGuid

the compliance item to create

globally unique identifier

Required

Body Parameters

The alias to create

ComplianceAlias
NameDescriptionTypeAdditional information
Name

The name of the skill.

string

Required

String length: inclusive between 0 and 255

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1"
}

application/xml, text/xml

Sample:
<ComplianceAlias xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Name>sample string 1</Name>
</ComplianceAlias>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

created compliance alias

ComplianceAliasViewModel
NameDescriptionTypeAdditional 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": "d4f64cf7-2d60-437e-8599-f68eaf424f3d",
  "ComplianceGuid": "95aa7843-8d81-442a-a7ac-0f1dfe7e50db",
  "Name": "sample string 3",
  "DateCreated": "2025-10-27T13:56:18.8825505+00:00",
  "DateUpdated": "2025-10-27T13:56:18.8825505+00:00",
  "Uid": "ca10a130-93e5-409d-b024-2600eaddfc35",
  "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:18.8825505+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>ca10a130-93e5-409d-b024-2600eaddfc35</Uid>
  <UpdatedBy>sample string 7</UpdatedBy>
  <ComplianceAliasGuid>d4f64cf7-2d60-437e-8599-f68eaf424f3d</ComplianceAliasGuid>
  <ComplianceGuid>95aa7843-8d81-442a-a7ac-0f1dfe7e50db</ComplianceGuid>
  <DateCreated>2025-10-27T13:56:18.8825505+00:00</DateCreated>
  <DateUpdated>2025-10-27T13:56:18.8825505+00:00</DateUpdated>
  <Name>sample string 3</Name>
</ComplianceAliasViewModel>