메인 콘텐츠로 건너뛰기
POST
Get Profile

인증

X-EntityToken
string
header
필수

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

본문

application/json

Given an entity type and entity identifier will retrieve the profile from the entity store. If the profile being retrieved is the caller's, then the read operation is consistent, if not it is an inconsistent read. An inconsistent read means that we do not guarantee all committed writes have occurred before reading the profile, allowing for a stale read. If consistency is important the Version Number on the result can be used to compare which version of the profile any reader has.

Given an entity type and entity identifier will retrieve the profile from the entity store. If the profile being retrieved is the caller's, then the read operation is consistent, if not it is an inconsistent read. An inconsistent read means that we do not guarantee all committed writes have occurred before reading the profile, allowing for a stale read. If consistency is important the Version Number on the result can be used to compare which version of the profile any reader has.

IncludeStatistics
boolean
필수

Determines whether the entity statistics will be returned in the entity profile. Default is false.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

DataAsObject
boolean

Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON string.

Entity
object

The optional entity to perform this action on. Defaults to the currently logged in entity.

응답

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
예시:
마지막 수정일 2026년 10월 6일