Annotations API • Unity Docs

Retrieves notifications through long polling.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Retrieves notifications through long polling."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

Query parameters for "Retrieves notifications through long polling."

from

integer

default: 0

The latest notification identifier from which to receive newer notifications

HTTP response status codes for "Retrieves notifications through long polling.":

Returns list of notifications.

If the number of comment identifiers exceed the 200 limits.

Code samples for "Retrieves notifications through long polling.":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/notifications"

Response example

List all the topics in an asset's dataset.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "List all the topics in an asset's dataset."

projectId

string

required

Project identifier.

datasetId

string

required

Dataset identifier.

assetId

string

required

Asset identifier.

HTTP response status codes for "List all the topics in an asset's dataset.":

Returns dataset's list of topics.

If the current user is not allowed to get the topics under the specified asset.

If specified project or asset, dataset identifier does not exist.

Code samples for "List all the topics in an asset's dataset.":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics"

Response example

{ "Topics": [ { "Id": "string", "SceneId": "string", "InstanceId": "string", "Title": "string", "CreationAuthor": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "CreationDate": "2024-01-01T00:00:00Z", "ModifiedAuthor": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "ModifiedDate": "2024-01-01T00:00:00Z", "Description": "string", "State": 0, "Read": true, "LocalTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "WorldTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "WorldCameraTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "IssueType": 0, "IssueManagementKey": "string", "LocalCameraTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } } } ]}

Create a new topic under the specified asset's dataset.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Create a new topic under the specified asset's dataset."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

Request body for "Create a new topic under the specified asset's dataset."

Media Type:

application/json

InstanceId

string

No description

Title

string

No description

Description

string

No description

LocalTransform

object

No description

Position

object

No description

X

number

No description

Y

number

No description

Z

number

No description

Rotation

object

No description

X

number

No description

Y

number

No description

Z

number

No description

W

number

No description

WorldTransform

object

No description

Position

object

No description

X

number

No description

Y

number

No description

Z

number

No description

Rotation

object

No description

X

number

No description

Y

number

No description

Z

number

No description

W

number

No description

WorldCameraTransform

object

No description

Position

object

No description

X

number

No description

Y

number

No description

Z

number

No description

Rotation

object

No description

X

number

No description

Y

number

No description

Z

number

No description

W

number

No description

LocalCameraTransform

object

No description

Position

object

No description

X

number

No description

Y

number

No description

Z

number

No description

Rotation

object

No description

X

number

No description

Y

number

No description

Z

number

No description

W

number

No description

InitialComment

string

No description

IssueType

integer

Types of Issue Management Tickets supported

IssueManagementKey

string

No description

IssueManagementData

string

No description

Attachment

object

No description

Bytes

string

No description

Filename

string

No description

ContentType

string

No description

Url

string

No description

HTTP response status codes for "Create a new topic under the specified asset's dataset.":

Returns the newly created topic.

If the current user is not allowed to create a new topic under the specified asset.

If the underliying service is not available.

Code samples for "Create a new topic under the specified asset's dataset.":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "InstanceId": "string", "Title": "string", "Description": "string", "LocalTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "WorldTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "WorldCameraTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "LocalCameraTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "InitialComment": "string", "IssueType": 0, "IssueManagementKey": "string", "IssueManagementData": "string", "Attachment": { "Bytes": "string", "Filename": "string", "ContentType": "string", "Url": "string" }}' \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics"

Response example

{ "Topic": { "Id": "string", "SceneId": "string", "InstanceId": "string", "Title": "string", "CreationAuthor": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "CreationDate": "2024-01-01T00:00:00Z", "ModifiedAuthor": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "ModifiedDate": "2024-01-01T00:00:00Z", "Description": "string", "State": 0, "Read": true, "LocalTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "WorldTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "WorldCameraTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "IssueType": 0, "IssueManagementKey": "string", "LocalCameraTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } } }, "Comment": { "Id": "string", "TopicId": "string", "Date": "2024-01-01T00:00:00Z", "Author": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "Text": "string", "ModifiedDate": "2024-01-01T00:00:00Z", "Read": true, "IssueManagementKey": "string" }}

Get a topic under the specified asset.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Get a topic under the specified asset."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

topicId

string

required

Topic identifier.

HTTP response status codes for "Get a topic under the specified asset.":

Returns the topic.

If the current user is not allowed to get the topics under the specified asset.

If specified project, asset, dataset or topic identifier does not exist.

Code samples for "Get a topic under the specified asset.":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics/{topicId}"

Response example

{ "Id": "string", "SceneId": "string", "InstanceId": "string", "Title": "string", "CreationAuthor": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "CreationDate": "2024-01-01T00:00:00Z", "ModifiedAuthor": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "ModifiedDate": "2024-01-01T00:00:00Z", "Description": "string", "State": 0, "Read": true, "LocalTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "WorldTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "WorldCameraTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }, "IssueType": 0, "IssueManagementKey": "string", "LocalCameraTransform": { "Position": { "X": 0, "Y": 0, "Z": 0 }, "Rotation": { "X": 0, "Y": 0, "Z": 0, "W": 0 } }}

Delete a topic.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Delete a topic."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

topicId

string

required

Topic identifier.

HTTP response status codes for "Delete a topic.":

If the topic is successfully deleted.

If the current user is not allowed to delete the topic under the specified asset.

If specified project, asset, dataset or topic identifier does not exist.

If the underliying service is not available.

Code samples for "Delete a topic.":

Request example

curl -X DELETE \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics/{topicId}"

Response example

List all the comments in a asset's dataset.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "List all the comments in a asset's dataset."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

HTTP response status codes for "List all the comments in a asset's dataset.":

Returns dataset's list of comments.

If the current user is not allowed to get the comments under the specified asset.

If the specified project, asset or dataset identifier does not exist.

Code samples for "List all the comments in a asset's dataset.":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/comments"

Response example

{ "Comments": [ { "Id": "string", "TopicId": "string", "Date": "2024-01-01T00:00:00Z", "Author": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "Text": "string", "ModifiedDate": "2024-01-01T00:00:00Z", "Read": true, "IssueManagementKey": "string" } ]}

Get the comments under a specific topic in a asset's dataset.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Get the comments under a specific topic in a asset's dataset."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

topicId

string

required

Topic identifier.

HTTP response status codes for "Get the comments under a specific topic in a asset's dataset.":

Returns topic's list of comments under the specified dataset.

If the current user is not allowed to get the comments under the specified asset.

If the specified project, asset, dataset or topic identifier does not exist.

Code samples for "Get the comments under a specific topic in a asset's dataset.":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics/{topicId}/comments"

Response example

{ "Comments": [ { "Id": "string", "TopicId": "string", "Date": "2024-01-01T00:00:00Z", "Author": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "Text": "string", "ModifiedDate": "2024-01-01T00:00:00Z", "Read": true, "IssueManagementKey": "string" } ]}

Create a new comment.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Create a new comment."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

topicId

string

required

Topic identifier.

Request body for "Create a new comment."

Media Type:

application/json

Comment

string

No description

HTTP response status codes for "Create a new comment.":

Returns the newly created comment.

If the current user is not allowed to create a new comment under the specified asset.

If the specified project, asset, dataset or topic identifier does not exist.

Code samples for "Create a new comment.":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "Comment": "string"}' \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics/{topicId}/comments"

Response example

{ "Id": "string", "TopicId": "string", "Date": "2024-01-01T00:00:00Z", "Author": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "Text": "string", "ModifiedDate": "2024-01-01T00:00:00Z", "Read": true, "IssueManagementKey": "string"}

Get the comment under a specific topic in an asset.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Get the comment under a specific topic in an asset."

assetId

string

required

Asset identifier.

projectId

string

required

Project identifier.

datasetId

string

required

Dataset identifier.

topicId

string

required

Topic identifier.

commentId

string

required

Comment identifier.

HTTP response status codes for "Get the comment under a specific topic in an asset.":

Returns the comments under the specified topic in an asset.

If the current user is not allowed to get the comments under the specified asset.

If the specified project, asset, dataset, topic or comment identifier does not exist.

Code samples for "Get the comment under a specific topic in an asset.":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics/{topicId}/comments/{commentId}"

Response example

{ "Id": "string", "TopicId": "string", "Date": "2024-01-01T00:00:00Z", "Author": { "Id": "string", "FullName": "string", "ColorIndex": 0 }, "Text": "string", "ModifiedDate": "2024-01-01T00:00:00Z", "Read": true, "IssueManagementKey": "string"}

Delete a comment.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Delete a comment."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

topicId

string

required

Topic identifier.

commentId

string

required

Comment identifier.

HTTP response status codes for "Delete a comment.":

If the comment is successfully deleted.

If the current user is not allowed to delete the comment under the specified asset.

If the specified project, asset, dataset, topic or comment identifier does not exist.

Code samples for "Delete a comment.":

Request example

curl -X DELETE \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics/{topicId}/comments/{commentId}"

Response example

Mark all the topics and comments as read by current user.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Mark all the topics and comments as read by current user."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

HTTP response status codes for "Mark all the topics and comments as read by current user.":

If the topics and comments are successfully updated.

If the current user is not allowed to update topics and comments under the specified asset.

Code samples for "Mark all the topics and comments as read by current user.":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/mark-all-as-read"

Response example

Mark all the topics as read by current user.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Mark all the topics as read by current user."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

Request body for "Mark all the topics as read by current user."

Media Type:

application/json

Array Type:

[ "string"]

HTTP response status codes for "Mark all the topics as read by current user.":

If the topics are successfully updated.

If the number of topic identifiers exceed the 200 limits.

If the current user is not allowed to update topics under the specified asset.

If none of the specified topic identifiers exist.

Code samples for "Mark all the topics as read by current user.":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '[ "string"]' \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics/mark-as-read"

Response example

Mark all the comments as read by current user.

Authorizations

Bearer

HTTP: Bearer

HTTP Authorization Scheme: bearer

Path parameters for "Mark all the comments as read by current user."

projectId

string

required

Project identifier.

assetId

string

required

Asset identifier.

datasetId

string

required

Dataset identifier.

Request body for "Mark all the comments as read by current user."

Media Type:

application/json

Array Type:

[ "string"]

HTTP response status codes for "Mark all the comments as read by current user.":

If the comments are successfully updated.

If the number of comment identifiers exceed the 200 limits.

If the current user is not allowed to update comments under the specified asset.

If none of the specified comment identifiers exist.

Code samples for "Mark all the comments as read by current user.":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Content-Type: application/json" \ -d '[ "string"]' \ "https://staging.services.api.unity.com/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/comments/mark-as-read"

Annotations Service API (Deprecated)

Deprecation Notice: This service will be disabled.

Retrieves notifications through long polling.

Path parameters for "Retrieves notifications through long polling."

projectId

assetId

datasetId

Query parameters for "Retrieves notifications through long polling."

from

HTTP response status codes for "Retrieves notifications through long polling.":

200Returns list of notifications.

400If the number of comment identifiers exceed the 200 limits.

Code samples for "Retrieves notifications through long polling.":

Request example

Response example

GET/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/notifications

List all the topics in an asset's dataset.

Path parameters for "List all the topics in an asset's dataset."

projectId

datasetId

assetId

HTTP response status codes for "List all the topics in an asset's dataset.":

200Returns dataset's list of topics.

403If the current user is not allowed to get the topics under the specified asset.

404If specified project or asset, dataset identifier does not exist.

Code samples for "List all the topics in an asset's dataset.":

Request example

Response example

GET/assets/annotations/v1/projects/{projectId}/assets/{assetId}/datasets/{datasetId}/topics

Create a new topic under the specified asset's dataset.

Path parameters for "Create a new topic under the specified asset's dataset."

projectId

assetId

datasetId

Request body for "Create a new topic under the specified asset's dataset."

InstanceId

Title

Description

LocalTransform

Position

X

Y

Z

Rotation

X

Y

Z

W

WorldTransform

Position

X

Y

Z

Rotation

X

Y

Z

W

WorldCameraTransform

Position

X

Y

Z

Rotation

X

Y

Z

W

LocalCameraTransform

Position

X

Y

Z

Rotation

X

Y

Z

W

InitialComment

IssueType