Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCalculatedAttributeForProfile

Retrieve a calculated attribute for a customer profile.

Request Syntax


GET /domains/DomainName/profile/ProfileId/calculated-attributes/CalculatedAttributeName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CalculatedAttributeName

The unique name of the calculated attribute.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

Required: Yes

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

ProfileId

The unique identifier of a customer profile.

Pattern: [a-f0-9]{32}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CalculatedAttributeName": "string",
   "DisplayName": "string",
   "IsDataPartial": "string",
   "Value": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CalculatedAttributeName

The unique name of the calculated attribute.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

DisplayName

The display name of the calculated attribute.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-\s]*$

IsDataPartial

Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Value

The value of the calculated attribute.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429