Skip to main content
POST
Link an object to the content group

Path Parameters

groupId
string
required

Content group identifier. The literal value SYSTEM may be used as an alias for the organization's SYSTEM content group.

Body

application/json
objectType
enum<string>
required

Type of platform object being linked.

PLATFORM_STYLE_GUIDE, TMS_PROJECT and TMS_PROJECT_TEMPLATE cannot be linked to the organization's SYSTEM content group — the request is rejected with a 422 error, code Conflict. PLATFORM_QA_CHECK and PLATFORM_STYLE_RULE are unaffected.

A TMS_PROJECT and TMS_PROJECT_TEMPLATE can only belong to one content group at a time. Creating a direct reference to a second group is rejected with a 422 error, code Conflict; unlink it from its current group first (DELETE /groups/{groupId}/references/{referenceId} or DELETE /groups/{groupId}/references) before linking it to a new one.

Available options:
PLATFORM_STYLE_GUIDE,
PLATFORM_STYLE_RULE,
TMS_PROJECT,
PLATFORM_QA_CHECK,
TMS_PROJECT_TEMPLATE
objectUid
string
required

Identifier of the platform object to link

Minimum string length: 1

Response

Reference created

id
string
required

Unique identifier of the reference

groupId
string
required

Identifier of the content group this reference belongs to

objectType
enum<string>
required

Type of platform object being linked.

PLATFORM_STYLE_GUIDE, TMS_PROJECT and TMS_PROJECT_TEMPLATE cannot be linked to the organization's SYSTEM content group — the request is rejected with a 422 error, code Conflict. PLATFORM_QA_CHECK and PLATFORM_STYLE_RULE are unaffected.

A TMS_PROJECT and TMS_PROJECT_TEMPLATE can only belong to one content group at a time. Creating a direct reference to a second group is rejected with a 422 error, code Conflict; unlink it from its current group first (DELETE /groups/{groupId}/references/{referenceId} or DELETE /groups/{groupId}/references) before linking it to a new one.

Available options:
PLATFORM_STYLE_GUIDE,
PLATFORM_STYLE_RULE,
TMS_PROJECT,
PLATFORM_QA_CHECK,
TMS_PROJECT_TEMPLATE
objectUid
string
required

Identifier of the linked platform object

createdAt
string
required

When the reference was created — timestamp (ISO-8601 format)

referenceType
enum<string>
required

Whether the reference belongs to the organization's SYSTEM content group (SYSTEM) or to a regular, user-created content group (USER). Computed by the server from the reference's group, never accepted on create requests.

Available options:
SYSTEM,
USER