Skip to main content
GET
Get Style Guide Association

Authorizations

Authorization
string
header
required

JWT from IDM (Authorization: Bearer )

Path Parameters

entityId
string
required

Entity ID (e.g. project ID)

Query Parameters

tenant
enum<string>
required

Tenant identifier. Allowable values: TMS, Strings, Studio.

Available options:
TMS,
Strings,
Studio
Example:

"TMS"

entityType
enum<string>

Entity type (e.g., PROJECT). Optional; defaults to PROJECT if omitted.

Available options:
PROJECT,
PROJECT_TEMPLATE
Example:

"PROJECT"

language
string

Language code used to create the association. At least one of language or languageId must be provided. languageId is optional and required only for tenants that use custom language variants (for example, Strings). If custom variants are not used, provide only language.

Example:

"en-US"

languageId
string

Language identifier (languageId). At least one of language or languageId must be provided. languageId is optional and required only for tenants that use custom language variants (for example, Strings). If custom variants are not used, provide only language. When languageId is not provided, language is used for the lookup. When both are provided, languageId is used for the lookup.

Example:

"en-US"

Response

Style guide association details for the association

Details of a single Style Guide association: language, style guide, association id, timestamps, and audit fields.

language
string

Language code (BCP 47 or custom)

Example:

"en-US"

languageId
string

Language ID (same as request or derived from language code). languageId is optional in request inputs and required only for tenants that use custom language variants (for example, Strings). If custom variants are not used, callers provide language and language is used as the effective language ID.

Example:

"en-US"

styleGuide
object

Associated Style Guide (id, name, description, language, version).

associationId
string<uuid>

UUID of the association (UUID v7). Null when this response was resolved via the organization's default Style Guide rather than an explicit association.

createdAt
string<date-time>

Timestamp when the association was created. Null when this response was resolved via the organization's default Style Guide.

Example:

"2024-01-15T10:30:00Z"

lastModifiedAt
string<date-time>

Timestamp when the association was last modified. Null when this response was resolved via the organization's default Style Guide.

Example:

"2024-01-15T10:30:00Z"

createdBy
string

User ID of the user who created the association. Null when this response was resolved via the organization's default Style Guide.

lastModifiedBy
string

User ID of the user who last modified the association. Null when this response was resolved via the organization's default Style Guide.