Skip to navigation
Tags APITag Collections

Create a Tag Collection

View as Markdown

Creates a new Tag Collection.

A Tag Collection is a container of tags. When you create tags, you must specify what Tag Collection they are part of. There is no permission needed to create a Tag Collection.

Note: When you create a Tag Collection, the system automatically creates a “default” Tag Category for it. When you create Tags, if you don’t specify what Tag Category they belong to, they are automatically assigned to the default category.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

RegionenumOptionalDefaults to US

The Autodesk Schema Registry currently supports in the US and EMEA regions. This header specifies where your data is stored. Possible Values:

  • US - (Default) All requests without a specified region header will be directed to the US region.
  • EMEA - Data center for the European Union, Middle East, and Africa. To access the EMEA region specifically, include the header “region: EMEA” in your API requests.
Allowed values:

Request

This endpoint expects an object.
externalIdstringOptional

Human friendly title as externalId label.

namestringOptional
A human readable name to identify the Tag Collection. Can only contain alphanumeric characters. Minimum length is two characters.

Response

The Tag Collection was sucessfully created.
idlongOptionalRead-only

A system-generated ID that uniquely identifies the Tag Collection.

externalIdstringOptional

Human friendly title as externalId label.

namestringOptional
A human readable name to identify the Tag Collection. Can only contain alphanumeric characters. Minimum length is two characters.
createdBystringOptional

If a three-legged access token was used to create the Tag Collection, contains the Autodesk ID (Oxygen ID) of the person who created the Tag Collection. If a two-legged access token was used to create the Tag Collection, contains the Client ID of the app that created the Tag Collection.

createTimedatetimeOptionalRead-only
A TimeISO 8601 Timestamp in UTC Timezone indicating when the Tag Collection was created.
lastModifiedBystringOptional

If a three-legged access token was used to modify the Tag Collection, contains the Autodesk ID (Oxygen ID) of the person who last modified the Tag Collection. If a two-legged access token was used to modify the Tag Collection, contains the Client ID of the app that modified the Tag Collection.

lastModifiedTimedatetimeOptionalRead-only
A TimeISO 8601 Timestamp in UTC Timezone, indicating when the Tag Collection was last modified.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error