Assets Public API • Unity Docs

List organization status flows.

List status flows belonging to an organization.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

The organization id.

Query parameters for "{title}"

offset

integer

example: 10

The amount of entities to skip.

limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/status"

Response example

{ "statusFlows": [ { "id": "string", "organizationId": "string", "name": "string", "assetStatuses": [ { "id": "string", "name": "string", "description": "string", "canBeSkipped": true, "inPredicate": { "id": null, "name": null }, "outPredicate": { "id": null, "name": null }, "sortingOrder": 0 } ], "transitions": [ { "id": "string", "fromStatusId": "string", "toStatusId": "string", "throughPredicate": { "id": null, "name": null } } ], "startAssetStatusId": "string", "isDefault": true } ], "total": 0}

Assign status flow.

Assign a status flow to an asset version.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The asset id.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The asset version.

statusFlowId

string

必填

The status flow id.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/statusflows/{statusFlowId}/assign"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Disable the autosubmit mode.

If called in time, it will disable the autosubmit mode on an asset version. After all the transformations complete, the asset will stay unfrozen.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

The projectId.

assetId

string

必填

The assetId.

assetVersion

string

必填

The assetVersion.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/autosubmit/disable"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

AutoSubmit asset version.

Enable autosaving in an asset version. If there are transformations running, the AutoSubmit flag will be enabled for the asset version, and as soon as all the transformations are complete, the asset version will be submitted. While in AutoSubmit mode, no changes are allowed on the asset version. In this case no versionNumber will be returned in the response. If there are no transformations running, the asset version will be immediately submitted (as SubmitAssetVersion does). The new versionNumber assigned to the asset will be included in the response.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

The projectId.

assetId

string

必填

The assetId.

assetVersion

string

必填

The assetVersion.

Request body for "{title}"

Media Type:

application/json

changeLog

string

example: - Added tag 'Wood' to asset;\r\n- Added a metallic map to material;

The change log for the asset version.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "changeLog": "- Added tag 'Wood' to asset;\\r\\n- Added a metallic map to material;"}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/autosubmit"

Response example

{ "versionNumber": 0}

Rolls the metadata of an asset version to a previous version.

The endpoint to roll back metadata to a previous version.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

assetId

string

必填

example: b59940b38970

The Id of the asset.

assetVersion

string

必填

example: latest

The asset version.

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

sequenceNumber

integer

必填

example: 10

The sequence to roll back to.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/metadata/rollback/{sequenceNumber}"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Read count of files in the asset and version.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset is located.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

The asset version.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/files-count"

Response example

{ "count": 0}

Read count of datasets in the asset and version.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset is located.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

The asset version.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets-count"

Response example

{ "count": 0}

Read multiple assets in bulk with their files and datasets.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

Request body for "{title}"

Media Type:

application/json

assets

array[object]

The assets to retrieve.

assetId

string

必填

The asset id.

assetVersion

string

The asset version.

label

string

The label.

includeFields

array[string]

example: ["*","name","description","tags","primaryType","portalMetadata","metadata","metadata.yourFieldName","systemMetadata.fieldName","datasets.*","datasets.name","datasets.isVisible","datasets.workflowName","datasets.description","datasets.tags","datasets.portalMetadata","datasets.metadata","datasets.systemMetadata","datasets.primaryType","files.*","files.filePath","files.description","files.tags","files.portalMetadata","files.metadata","files.systemMetadata","files.userChecksum","files.fileSize","files.downloadURL","files.previewURL"]

The optional fields to include in the response.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "assets": [ { "assetId": "string", "assetVersion": "string", "label": "string" } ], "includeFields": [ "*", "name", "description", "tags", "primaryType", "portalMetadata", "metadata", "metadata.yourFieldName", "systemMetadata.fieldName", "datasets.*", "datasets.name", "datasets.isVisible", "datasets.workflowName", "datasets.description", "datasets.tags", "datasets.portalMetadata", "datasets.metadata", "datasets.systemMetadata", "datasets.primaryType", "files.*", "files.filePath", "files.description", "files.tags", "files.portalMetadata", "files.metadata", "files.systemMetadata", "files.userChecksum", "files.fileSize", "files.downloadURL", "files.previewURL" ]}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/batch/get"

Response example

{ "assets": [ { "asset": { "assetId": "b59940b38970", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "name": "Tree material", "description": "This is a material to be used in trees", "tags": [ "string" ], "systemTags": [ "string" ], "labels": [ "string" ], "archivedLabels": [ "string" ], "primaryType": "Material", "portalMetadata": "string", "versionNumber": 3, "parentVersionNumber": 2, "changeLog": "- Added tag 'Wood' to asset;\\r\\n- Added a metallic map to material;", "parentAssetVersion": "4", "metadata": { "MarketingPitch": "Your marketing pitch", "Price": 0.5, "Length": 200, "ScorePoints": 15, "IsReadyForPostProcess": true, "ValidatedByManager": false, "ConnectedToWebPortal": false, "LaunchDate": "2023-08-16T08:49:12.1674180", "LastCheckPlan": "2023-08-16T08:49:12.1674180", "DateScanned": "2023-06-05T010:35:05.1674180", "License": "https://assetfilelicense.com", "WebProductPage": "https://productpage.com", "RepoSource": "https://github.com/myprojectrepo", "Priority": "Low|Medium|High", "Certifications": "ISO 4905|ISO 3013", "TeamCharter": "Seoul|Shanghai|Jakarta", "IndustryType": [ "Architecture", "Industrial", "Energy and Oil" ], "Sprints": [ 1, 2, 3, 4, 5 ], "Owner": "5772465996530", "Reviewer": "5772465996530", "Project Lead": "5772465996530" }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "status": "Draft", "isFrozen": true, "created": "2024-01-01T00:00:00Z", "createdBy": "5772465996530", "updated": "2024-01-01T00:00:00Z", "updatedBy": "5772465996530", "sourceProjectId": "string", "projectIds": [ "87cf845f-8ca7-4b2f-9cc1-c3d731335810", "5fd931ab-0950-4e9c-9264-d888f490b5a5", "5e7b9c90-b07e-490c-bfb7-80897f6f7e7e" ], "previewFile": "folder/thumbnail.gif", "previewFileDatasetId": "string", "previewFileUrl": "https://teststorage.com/files/folder/thumbnail.gif", "isPreviewFileUrlOriginalImage": true, "files": [ { "datasetIds": null, "filePath": null, "description": null, "status": null, "created": null, "createdBy": null, "updated": null, "updatedBy": null, "tags": null, "systemTags": null, "portalMetadata": null, "metadata": null, "systemMetadata": null, "userChecksum": null, "fileSize": null, "downloadURL": null, "isDownloadURLOriginalImage": null, "previewURL": null, "previewDatasetId": null, "primaryType": null, "transformationInputFiles": null, "isPreviewURLOriginalImage": null, "mainFile": null } ], "datasets": [ { "datasetId": null, "name": null, "description": null, "isVisible": null, "workflowName": null, "tags": null, "portalMetadata": null, "primaryType": null, "metadata": null, "systemMetadata": null, "status": null, "systemTags": null, "createdBy": null, "created": null, "updatedBy": null, "updated": null, "filesOrder": null, "vcsMappingId": null } ], "assetTemplateId": "string", "statusFlowId": "string", "statusFlowName": "string", "autoSubmit": true, "trashDetails": [ { "projectId": null, "movedToTrashBy": null, "movedToTrashAt": null } ], "upstreamReferences": [ { "id": null, "type": null, "assetId": null, "assetVersion": null, "labelName": null, "sourceDatasetId": null, "targetDatasetId": null, "dependencyType": null, "relativePath": null, "metadata": null } ], "downstreamReferences": [ { "id": null, "type": null, "assetId": null, "assetVersion": null, "labelName": null, "sourceDatasetId": null, "targetDatasetId": null, "dependencyType": null, "relativePath": null, "metadata": null } ] }, "files": [ { "datasetIds": [ null ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ null ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ null ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "datasets": [ { "datasetId": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "name": "Thumbnails", "description": "Dataset with thumbnails images of the asset.", "isVisible": true, "workflowName": "thumbnail-generation", "tags": [ "thumbnail", "image" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "status": "string", "systemTags": [ null ], "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "filesOrder": [ null ], "vcsMappingId": "string" } ], "upstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ], "downstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ] } ], "errors": [ { "assetId": "string", "assetVersion": "string", "label": "string", "errorMessage": "string", "errorCode": "string" } ]}

Create asset.

Create a new asset in a project with primary and custom metadata. Note that custom metadata needs first to be created in the organization library, through metadata field definition creation.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset will be created.

Request body for "{title}"

Media Type:

application/json

name

string

必填

The name of the asset.

description

string

The description of the asset.

tags

array[string]

example: ["Industry","CAD"]

A list of tags associated with the asset (optionally empty).

primaryType

string

example: Other | 3D Model | Audio | Video | 2D Asset | Script | Material

The primary type of the asset.

portalMetadata

string

The metadata provided by the frontend.

metadata

object

example: {"MarketingPitch":"Your marketing pitch","Price":0.5,"Length":200,"ScorePoints":15,"IsReadyForPostProcess":true,"ValidatedByManager":false,"ConnectedToWebPortal":false,"LaunchDate":"2023-09-15T15:42:52.106Z","LastCheckPlan":"2023-09-15T15:42:52.106Z","DateScanned":"2023-09-15T15:42:52.106Z","License":"https://assetfilelicense.com","WebProductPage":"https://productpage.com","RepoSource":"https://github.com/myprojectrepo","Priority":"Low|Medium|High","Certifications":"ISO 4905|ISO 3013","TeamCharter":"Seoul|Shanghai|Jakarta","IndustryType":["Architecture","Industrial","Energy and Oil"],"Sprints":[1,2,3,4,5],"Owner":"5772465996530","Reviewer":"5772465996530","Project Lead":"5772465996530"}

The searchable custom metadata. Metadata fields need to exist in the organization library. Refer to Metadata field management endpoints.

systemMetadata

object

[Deprecated] This field is deprecated for this request and is read-only. Please use the Metadata field to store additional information.

collections

array[string]

example: ["collection1","project1/collection2"]

The collection(s) to which the asset is linked.

statusFlowId

string

The identifier of the status flow to assign to the asset.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "description": "string", "tags": [ "Industry", "CAD" ], "primaryType": "Other | 3D Model | Audio | Video | 2D Asset | Script | Material", "portalMetadata": "string", "metadata": { "MarketingPitch": "Your marketing pitch", "Price": 0.5, "Length": 200, "ScorePoints": 15, "IsReadyForPostProcess": true, "ValidatedByManager": false, "ConnectedToWebPortal": false, "LaunchDate": "2023-09-15T15:42:52.106Z", "LastCheckPlan": "2023-09-15T15:42:52.106Z", "DateScanned": "2023-09-15T15:42:52.106Z", "License": "https://assetfilelicense.com", "WebProductPage": "https://productpage.com", "RepoSource": "https://github.com/myprojectrepo", "Priority": "Low|Medium|High", "Certifications": "ISO 4905|ISO 3013", "TeamCharter": "Seoul|Shanghai|Jakarta", "IndustryType": [ "Architecture", "Industrial", "Energy and Oil" ], "Sprints": [ 1, 2, 3, 4, 5 ], "Owner": "5772465996530", "Reviewer": "5772465996530", "Project Lead": "5772465996530" }, "systemMetadata": {}, "collections": [ "collection1", "project1/collection2" ], "statusFlowId": "string"}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets"

Response example

{ "assetId": "string", "assetVersion": "string", "datasets": [ { "datasetId": "string", "name": "string", "systemTags": [ "string" ] } ]}

Copy assets from library to a project.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: 1daf2f01-2e49-445f-afd4-7f4d998d6fa1

The library ID.

destinationProjectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project ID where the asset will be copied to.

Request body for "{title}"

Media Type:

application/json

Array Type:

[ { "assetId": "65325f523a625f7e1acdb197", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "collectionPath": "MainCollection/Collection1", "statusFlowId": "6ca4a681-a48a-4e8e-aa49-4112c2285b2c" }]

HTTP response status codes for "{title}":

Created

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '[ { "assetId": "65325f523a625f7e1acdb197", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "collectionPath": "MainCollection/Collection1", "statusFlowId": "6ca4a681-a48a-4e8e-aa49-4112c2285b2c" }]' \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/duplicate/projects/{destinationProjectId}"

Response example

[ { "id": "6ca4a681-a48a-4e8e-aa49-4112c2285b2c", "name": "Importing Electricity Box", "type": "duplication", "progress": { "value": 0.5, "message": "Copying asset to project." }, "state": "prioritized", "results": {}, "failedReason": "Failed to copy the asset." }]

Read library job.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

jobId

string

必填

example: 4230670b-99d0-48b5-a444-a23ecd2c2a50

The job id.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/jobs/duplication/{jobId}"

Response example

{ "id": "6ca4a681-a48a-4e8e-aa49-4112c2285b2c", "name": "Importing Electricity Box", "type": "duplication", "progress": { "value": 0.5, "message": "Copying asset to project." }, "state": "prioritized", "results": {}, "failedReason": "Failed to copy the asset."}

Read library jobs.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/jobs/duplication"

Response example

[ { "id": "6ca4a681-a48a-4e8e-aa49-4112c2285b2c", "name": "Importing Electricity Box", "type": "duplication", "progress": { "value": 0.5, "message": "Copying asset to project." }, "state": "prioritized", "results": {}, "failedReason": "Failed to copy the asset." }]

Get library.

Reads a library by id.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

The library identifier.

Query parameters for "{title}"

includeFields

array

example: hasCollection

The optional fields to include in the response.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}"

Response example

{ "id": "02cc56be-968b-4a38-b06f-16dfb2953d95", "name": "Test Library", "hasCollection": true, "supportedBy": [ "string" ]}

List libraries.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Query parameters for "{title}"

offset

integer

example: 10

The amount of entities to skip.

limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries"

Response example

{ "results": [ { "id": "02cc56be-968b-4a38-b06f-16dfb2953d95", "name": "Test Library", "hasCollection": true, "supportedBy": [ "string" ] } ], "total": 0}

Search assets by criteria.

Searches multiple assets filtering by the specified criteria.

Note: if no labels filter is specified only versions with latest or pending labels will be returned.

Note 2: Asset manager search endpoints work on the basis of the Eventual Consistency model. This means that at times, an update may take a short time to be reflected in search results.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The library id.

Request body for "{title}"

Media Type:

application/json

filter

object

The asset read filter.

includeQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":16384},{"conditionType":"lessThan","value":1048576.2}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","updatedBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.description":"description of the dataset","datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to include all the entries matching all the criteria.

excludeQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":-163.84},{"conditionType":"lessThan","value":1048576}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","updatedBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.description":"description of the dataset","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to exclude all the entries matching all the criteria.

anyQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":16384},{"conditionType":"lessThan","value":1048576}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.description":"description of the dataset","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to Include all entries matching any of the criteria.

anyQueryMinimumMatch

integer

The minimum any query match amount to be considered a match for return.

collections

array[string]

The collection paths.

includeFields

array[string]

example: ["*","name","description","tags","primaryType","portalMetadata","metadata","metadata.yourFieldName","VersionNumber","parentVersionNumber","systemMetadata.fieldName","previewFileUrl","changeLog","parentAssetVersion","datasets.*","datasets.name","datasets.description","datasets.tags","datasets.portalMetadata","datasets.metadata","datasets.systemMetadata","datasets.primaryType","files.*","files.filePath","files.description","files.tags","files.portalMetadata","files.metadata","files.systemMetadata","files.userChecksum","files.fileSize","files.downloadUrl","files.previewURL"]

The fields to be returned.

pagination

object

The pagination of the request.

token

string

The pagination token.

limit

integer

The amount of assets per page.

sortingField

string

必填

The field to sort the assets from the page.

sortingOrder

string

The order to sort the assets (Ascending/Descending).

Schema:

The request to read the assets versions.

{ "filter": { "includeQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": 16384 }, { "conditionType": "lessThan", "value": 1048576.2 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "updatedBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.description": "description of the dataset", "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "excludeQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": -163.84 }, { "conditionType": "lessThan", "value": 1048576 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "updatedBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.description": "description of the dataset", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "anyQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": 16384 }, { "conditionType": "lessThan", "value": 1048576 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.description": "description of the dataset", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "anyQueryMinimumMatch": 0, "collections": [ "string" ] }, "includeFields": [ "*", "name", "description", "tags", "primaryType", "portalMetadata", "metadata", "metadata.yourFieldName", "VersionNumber", "parentVersionNumber", "systemMetadata.fieldName", "previewFileUrl", "changeLog", "parentAssetVersion", "datasets.*", "datasets.name", "datasets.description", "datasets.tags", "datasets.portalMetadata", "datasets.metadata", "datasets.systemMetadata", "datasets.primaryType", "files.*", "files.filePath", "files.description", "files.tags", "files.portalMetadata", "files.metadata", "files.systemMetadata", "files.userChecksum", "files.fileSize", "files.downloadUrl", "files.previewURL" ], "pagination": { "token": "string", "limit": 0, "sortingField": "string", "sortingOrder": "string" }}

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "filter": { "includeQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": 16384 }, { "conditionType": "lessThan", "value": 1048576.2 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "updatedBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.description": "description of the dataset", "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "excludeQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": -163.84 }, { "conditionType": "lessThan", "value": 1048576 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "updatedBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.description": "description of the dataset", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "anyQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": 16384 }, { "conditionType": "lessThan", "value": 1048576 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.description": "description of the dataset", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "anyQueryMinimumMatch": 0, "collections": [ "string" ] }, "includeFields": [ "*", "name", "description", "tags", "primaryType", "portalMetadata", "metadata", "metadata.yourFieldName", "VersionNumber", "parentVersionNumber", "systemMetadata.fieldName", "previewFileUrl", "changeLog", "parentAssetVersion", "datasets.*", "datasets.name", "datasets.description", "datasets.tags", "datasets.portalMetadata", "datasets.metadata", "datasets.systemMetadata", "datasets.primaryType", "files.*", "files.filePath", "files.description", "files.tags", "files.portalMetadata", "files.metadata", "files.systemMetadata", "files.userChecksum", "files.fileSize", "files.downloadUrl", "files.previewURL" ], "pagination": { "token": "string", "limit": 0, "sortingField": "string", "sortingOrder": "string" }}' \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/search"

Response example

{ "next": "string", "results": [ { "assetId": "b59940b38970", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "name": "Tree material", "description": "This is a material to be used in trees", "tags": [ "string" ], "systemTags": [ "string" ], "labels": [ "string" ], "archivedLabels": [ "string" ], "primaryType": "Material", "portalMetadata": "string", "versionNumber": 3, "parentVersionNumber": 2, "changeLog": "- Added tag 'Wood' to asset;\\r\\n- Added a metallic map to material;", "parentAssetVersion": "4", "metadata": { "MarketingPitch": "Your marketing pitch", "Price": 0.5, "Length": 200, "ScorePoints": 15, "IsReadyForPostProcess": true, "ValidatedByManager": false, "ConnectedToWebPortal": false, "LaunchDate": "2023-08-16T08:49:12.1674180", "LastCheckPlan": "2023-08-16T08:49:12.1674180", "DateScanned": "2023-06-05T010:35:05.1674180", "License": "https://assetfilelicense.com", "WebProductPage": "https://productpage.com", "RepoSource": "https://github.com/myprojectrepo", "Priority": "Low|Medium|High", "Certifications": "ISO 4905|ISO 3013", "TeamCharter": "Seoul|Shanghai|Jakarta", "IndustryType": [ "Architecture", "Industrial", "Energy and Oil" ], "Sprints": [ 1, 2, 3, 4, 5 ], "Owner": "5772465996530", "Reviewer": "5772465996530", "Project Lead": "5772465996530" }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "status": "Draft", "isFrozen": true, "created": "2024-01-01T00:00:00Z", "createdBy": "5772465996530", "updated": "2024-01-01T00:00:00Z", "updatedBy": "5772465996530", "sourceProjectId": "string", "projectIds": [ "87cf845f-8ca7-4b2f-9cc1-c3d731335810", "5fd931ab-0950-4e9c-9264-d888f490b5a5", "5e7b9c90-b07e-490c-bfb7-80897f6f7e7e" ], "previewFile": "folder/thumbnail.gif", "previewFileDatasetId": "string", "previewFileUrl": "https://teststorage.com/files/folder/thumbnail.gif", "isPreviewFileUrlOriginalImage": true, "files": [ { "datasetIds": [ null ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ null ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ null ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "datasets": [ { "datasetId": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "name": "Thumbnails", "description": "Dataset with thumbnails images of the asset.", "isVisible": true, "workflowName": "thumbnail-generation", "tags": [ "thumbnail", "image" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "status": "string", "systemTags": [ null ], "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "filesOrder": [ null ], "vcsMappingId": "string" } ], "assetTemplateId": "string", "statusFlowId": "string", "statusFlowName": "string", "autoSubmit": true, "trashDetails": [ { "projectId": "string", "movedToTrashBy": "string", "movedToTrashAt": "2024-01-01T00:00:00Z" } ], "upstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ], "downstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ] } ]}

Search asset versions by criteria.

Searches multiple assets filtering by the specified criteria.

Note: Asset manager search endpoints work on the basis of the Eventual Consistency model. This means that at times, an update may take a short time to be reflected in search results.

Supported Query Objects

Exact Match Search for values that exactly match the field.

Date Range Search for values where the date field is in a given range.

Wildcard Search for values with wildcard placeholder characters ('?' for a single character, '*' for zero or more characters).

Regex Search for values matching a regular expression.

Prefix Search for values beginning with a given term.

Fuzzy Search for values similar to the given search term.

Numeric Range Search for values in a given numeric range.

AND Operator

OR Operator Search for results that match ONE or MORE of the given query conditions.

NOT Operator Search for results that do NOT match the given query condition.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The library id.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

Request body for "{title}"

Media Type:

application/json

filter

object

The asset read filter.

includeQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":16384},{"conditionType":"lessThan","value":1048576.2}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","updatedBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.description":"description of the dataset","datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to include all the entries matching all the criteria.

excludeQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":-163.84},{"conditionType":"lessThan","value":1048576}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","updatedBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.description":"description of the dataset","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to exclude all the entries matching all the criteria.

anyQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":16384},{"conditionType":"lessThan","value":1048576}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.description":"description of the dataset","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to Include all entries matching any of the criteria.

anyQueryMinimumMatch

integer

The minimum any query match amount to be considered a match for return.

collections

array[string]

The collection paths.

includeFields

array[string]

example: ["*","name","description","tags","primaryType","portalMetadata","metadata","metadata.yourFieldName","VersionNumber","parentVersionNumber","systemMetadata.fieldName","previewFileUrl","changeLog","parentAssetVersion","datasets.*","datasets.name","datasets.description","datasets.tags","datasets.portalMetadata","datasets.metadata","datasets.systemMetadata","datasets.primaryType","files.*","files.filePath","files.description","files.tags","files.portalMetadata","files.metadata","files.systemMetadata","files.userChecksum","files.fileSize","files.downloadUrl","files.previewURL"]

The fields to be returned.

pagination

object

The pagination of the request.

token

string

The pagination token.

limit

integer

The amount of assets per page.

sortingField

string

必填

The field to sort the assets from the page.

sortingOrder

string

The order to sort the assets (Ascending/Descending).

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "filter": { "includeQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": 16384 }, { "conditionType": "lessThan", "value": 1048576.2 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "updatedBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.description": "description of the dataset", "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "excludeQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": -163.84 }, { "conditionType": "lessThan", "value": 1048576 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "updatedBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.description": "description of the dataset", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "anyQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": 16384 }, { "conditionType": "lessThan", "value": 1048576 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.description": "description of the dataset", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "anyQueryMinimumMatch": 0, "collections": [ "string" ] }, "includeFields": [ "*", "name", "description", "tags", "primaryType", "portalMetadata", "metadata", "metadata.yourFieldName", "VersionNumber", "parentVersionNumber", "systemMetadata.fieldName", "previewFileUrl", "changeLog", "parentAssetVersion", "datasets.*", "datasets.name", "datasets.description", "datasets.tags", "datasets.portalMetadata", "datasets.metadata", "datasets.systemMetadata", "datasets.primaryType", "files.*", "files.filePath", "files.description", "files.tags", "files.portalMetadata", "files.metadata", "files.systemMetadata", "files.userChecksum", "files.fileSize", "files.downloadUrl", "files.previewURL" ], "pagination": { "token": "string", "limit": 0, "sortingField": "string", "sortingOrder": "string" }}' \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/{assetId}/versions/search"

Response example

{ "next": "string", "results": [ { "assetId": "b59940b38970", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "name": "Tree material", "description": "This is a material to be used in trees", "tags": [ "string" ], "systemTags": [ "string" ], "labels": [ "string" ], "archivedLabels": [ "string" ], "primaryType": "Material", "portalMetadata": "string", "versionNumber": 3, "parentVersionNumber": 2, "changeLog": "- Added tag 'Wood' to asset;\\r\\n- Added a metallic map to material;", "parentAssetVersion": "4", "metadata": { "MarketingPitch": "Your marketing pitch", "Price": 0.5, "Length": 200, "ScorePoints": 15, "IsReadyForPostProcess": true, "ValidatedByManager": false, "ConnectedToWebPortal": false, "LaunchDate": "2023-08-16T08:49:12.1674180", "LastCheckPlan": "2023-08-16T08:49:12.1674180", "DateScanned": "2023-06-05T010:35:05.1674180", "License": "https://assetfilelicense.com", "WebProductPage": "https://productpage.com", "RepoSource": "https://github.com/myprojectrepo", "Priority": "Low|Medium|High", "Certifications": "ISO 4905|ISO 3013", "TeamCharter": "Seoul|Shanghai|Jakarta", "IndustryType": [ "Architecture", "Industrial", "Energy and Oil" ], "Sprints": [ 1, 2, 3, 4, 5 ], "Owner": "5772465996530", "Reviewer": "5772465996530", "Project Lead": "5772465996530" }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "status": "Draft", "isFrozen": true, "created": "2024-01-01T00:00:00Z", "createdBy": "5772465996530", "updated": "2024-01-01T00:00:00Z", "updatedBy": "5772465996530", "sourceProjectId": "string", "projectIds": [ "87cf845f-8ca7-4b2f-9cc1-c3d731335810", "5fd931ab-0950-4e9c-9264-d888f490b5a5", "5e7b9c90-b07e-490c-bfb7-80897f6f7e7e" ], "previewFile": "folder/thumbnail.gif", "previewFileDatasetId": "string", "previewFileUrl": "https://teststorage.com/files/folder/thumbnail.gif", "isPreviewFileUrlOriginalImage": true, "files": [ { "datasetIds": [ null ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ null ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ null ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "datasets": [ { "datasetId": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "name": "Thumbnails", "description": "Dataset with thumbnails images of the asset.", "isVisible": true, "workflowName": "thumbnail-generation", "tags": [ "thumbnail", "image" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "status": "string", "systemTags": [ null ], "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "filesOrder": [ null ], "vcsMappingId": "string" } ], "assetTemplateId": "string", "statusFlowId": "string", "statusFlowName": "string", "autoSubmit": true, "trashDetails": [ { "projectId": "string", "movedToTrashBy": "string", "movedToTrashAt": "2024-01-01T00:00:00Z" } ], "upstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ], "downstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ] } ]}

Read asset files.

Read asset files from a dataset in an asset.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

The library id.

assetId

string

必填

The asset id.

assetVersion

string

必填

The asset version.

datasetId

string

必填

The dataset id.

Query parameters for "{title}"

includeFields

array

example: *,filePath,description,tags,portalMetadata,metadata,systemMetadata,userChecksum,fileSize,downloadURL

The optional fields to include in the response.

token

string

The pagination token.

limit

integer

The amount of assets per page.

HTTP response status codes for "{title}":

OK

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/files"

Response example

{ "results": [ { "datasetIds": [ "string" ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ "string" ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ "string" ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "total": 0, "next": "string", "previous": "string"}

Get asset version.

Return a single asset from a library with on-demand fields.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the library where the asset lives.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The asset id.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The asset version.

Query parameters for "{title}"

includeFields

array

example: *,name,description,tags,primaryType,portalMetadata,metadata,metadata.yourFieldName,systemMetadata.fieldName,datasets.*,datasets.name,datasets.isVisible,datasets.workflowName,datasets.description,datasets.tags,datasets.portalMetadata,datasets.metadata,datasets.systemMetadata,datasets.primaryType,files.*,files.filePath,files.description,files.tags,files.portalMetadata,files.metadata,files.systemMetadata,files.userChecksum,files.fileSize,files.downloadURL,files.previewURL

The optional fields to include in the response.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/{assetId}/versions/{assetVersion}"

Response example

{ "assetId": "b59940b38970", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "name": "Tree material", "description": "This is a material to be used in trees", "tags": [ "string" ], "systemTags": [ "string" ], "labels": [ "string" ], "archivedLabels": [ "string" ], "primaryType": "Material", "portalMetadata": "string", "versionNumber": 3, "parentVersionNumber": 2, "changeLog": "- Added tag 'Wood' to asset;\\r\\n- Added a metallic map to material;", "parentAssetVersion": "4", "metadata": { "MarketingPitch": "Your marketing pitch", "Price": 0.5, "Length": 200, "ScorePoints": 15, "IsReadyForPostProcess": true, "ValidatedByManager": false, "ConnectedToWebPortal": false, "LaunchDate": "2023-08-16T08:49:12.1674180", "LastCheckPlan": "2023-08-16T08:49:12.1674180", "DateScanned": "2023-06-05T010:35:05.1674180", "License": "https://assetfilelicense.com", "WebProductPage": "https://productpage.com", "RepoSource": "https://github.com/myprojectrepo", "Priority": "Low|Medium|High", "Certifications": "ISO 4905|ISO 3013", "TeamCharter": "Seoul|Shanghai|Jakarta", "IndustryType": [ "Architecture", "Industrial", "Energy and Oil" ], "Sprints": [ 1, 2, 3, 4, 5 ], "Owner": "5772465996530", "Reviewer": "5772465996530", "Project Lead": "5772465996530" }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "status": "Draft", "isFrozen": true, "created": "2024-01-01T00:00:00Z", "createdBy": "5772465996530", "updated": "2024-01-01T00:00:00Z", "updatedBy": "5772465996530", "sourceProjectId": "string", "projectIds": [ "87cf845f-8ca7-4b2f-9cc1-c3d731335810", "5fd931ab-0950-4e9c-9264-d888f490b5a5", "5e7b9c90-b07e-490c-bfb7-80897f6f7e7e" ], "previewFile": "folder/thumbnail.gif", "previewFileDatasetId": "string", "previewFileUrl": "https://teststorage.com/files/folder/thumbnail.gif", "isPreviewFileUrlOriginalImage": true, "files": [ { "datasetIds": [ "string" ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ "string" ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ "string" ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "datasets": [ { "datasetId": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "name": "Thumbnails", "description": "Dataset with thumbnails images of the asset.", "isVisible": true, "workflowName": "thumbnail-generation", "tags": [ "thumbnail", "image" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "status": "string", "systemTags": [ "string" ], "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "filesOrder": [ "string" ], "vcsMappingId": "string" } ], "assetTemplateId": "string", "statusFlowId": "string", "statusFlowName": "string", "autoSubmit": true, "trashDetails": [ { "projectId": "string", "movedToTrashBy": "string", "movedToTrashAt": "2024-01-01T00:00:00Z" } ], "upstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ], "downstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ]}

Get download file URL.

Return a download URL for a given file.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the library where the asset lives.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The ID of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset. For the time being, generated by the system.

datasetId

string

必填

example: d21b2715-0c09-4c0d-ba8f-647291eacfd4

The ID of the dataset.

filePath

string

必填

example: my-folder%2Fmy-file.txt

The encoded path of the file. Serves as the unique identifier.

Query parameters for "{title}"

width

integer

example: 512

[Deprecated] This parameter is deprecated. Please use maxDimension instead./>

maxDimension

integer

example: 512

The desired length to resize the larger image dimension to, while maintaining the same aspect ratio. Should be between 50 and 3850. For DownloadURL.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/files/{filePath}/download-url"

Response example

{ "url": "https://example.com", "isOriginalImage": true}

Get asset download URLs.

Get all the files download URLs of one or several datasets of the same asset. Note that every asset has by default 2 datasets: The source and the preview. Download URLs are valid for ten minutes only.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the library.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset.

Query parameters for "{title}"

limit

integer

必填

example: 10

The limit of returning records for pagination.

offset

integer

默认: 0

example: 1

The pagination offset.

datasets

array

The list of datasets from which to download files.

maxDimension

integer

example: 512

The desired length to resize the larger image dimension to, while maintaining the same aspect ratio. Should be between 50 and 3850. For DownloadURL.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/{assetId}/versions/{assetVersion}/download-urls"

Response example

{ "results": [ { "datasetId": "string", "filePath": "string", "url": "string", "isOriginalImage": true } ], "total": 0}

List library collections.

Return all collections within a library.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

The library id.

Query parameters for "{title}"

offset

integer

example: 1

The pagination offset.

limit

integer

example: 20

The limit of returning records for pagination.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/collections"

Response example

{ "results": [ { "name": "string", "description": "string", "parentPath": "string" } ], "total": 0}

Get the number of assets in a collection.

Return the number of assets in the collection.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the library where the asset lives.

collectionPath

string

必填

example: MainCollection%2FParentCollection

The encoded path of the collection. Must be URL escaped.

Query parameters for "{title}"

includeSubCollections

boolean

Flag to include child collections' assets in the count.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/collections/{collectionPath}/assets/count"

Response example

{ "count": 0}

Count assets in library.

Get the number of assets in a library.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

The library identifier.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/count"

Response example

{ "count": 0}

List field definitions.

Return metadata field definition from the organization library.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

The library identifier.

Query parameters for "{title}"

name

array

必填

The field definition names.

limit

integer

默认: 999

The amount of field definitions per page.

includeDeleted

boolean

默认: false

example: false

A value indicating whether the result should include deleted fields.

token

string

The pagination token for the next page.

sortingOrder

example: Ascending

The order to sort the fields.

fieldOrigin

string

If defined, only search for fields with the specified FieldOrigin value (either 'User' or 'System')

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/templates/fields"

Response example

{ "results": [ { "name": "GeometryArea", "displayName": "Geometry Area", "type": "Boolean", "acceptedValues": [ "Area", "Volume" ], "multiSelection": true, "status": "Active|Deleted", "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "fieldOrigin": "User" } ], "next": "string"}

List asset versions labels.

List all labels assigned across all versions of an asset.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the library where the asset is located.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

Query parameters for "{title}"

offset

integer

example: 10

The amount of entities to skip.

limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/{assetId}/labels"

Response example

{ "assetVersionLabels": [ { "assetVersion": "d3a30060-7213-4f15-a183-2e87267d0c12", "labels": [ { "name": "string", "description": "string", "colour": "string", "isSystemLabel": true, "isUserAssignable": true, "created": "2024-01-01T00:00:00Z", "createdBy": "string", "updated": "2024-01-01T00:00:00Z", "updatedBy": "string" } ], "archivedLabels": [ { "name": "string", "description": "string", "colour": "string", "isSystemLabel": true, "isUserAssignable": true, "created": "2024-01-01T00:00:00Z", "createdBy": "string", "updated": "2024-01-01T00:00:00Z", "updatedBy": "string" } ] } ], "total": 0}

Read labels.

Get all the labels in the organization.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the library where the asset is located.

Query parameters for "{title}"

status

example: Active

The status of the labels to be returned.

isSystemLabel

boolean

example: true

The type of the labels to be returned.

offset

integer

example: 10

The amount of entities to skip.

limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/labels"

Response example

{ "results": [ { "name": "string", "description": "string", "colour": "string", "isSystemLabel": true, "isUserAssignable": true, "created": "2024-01-01T00:00:00Z", "createdBy": "string", "updated": "2024-01-01T00:00:00Z", "updatedBy": "string" } ], "total": 0}

Read multiple assets in bulk with their files and datasets.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

libraryId

string

必填

The library id.

Request body for "{title}"

Media Type:

application/json

assets

array[object]

The assets to retrieve.

assetId

string

必填

The asset id.

assetVersion

string

The asset version.

includeFields

array[string]

example: ["*","name","description","tags","primaryType","portalMetadata","metadata","metadata.yourFieldName","systemMetadata.fieldName","datasets.*","datasets.name","datasets.isVisible","datasets.workflowName","datasets.description","datasets.tags","datasets.portalMetadata","datasets.metadata","datasets.systemMetadata","datasets.primaryType","files.*","files.filePath","files.description","files.tags","files.portalMetadata","files.metadata","files.systemMetadata","files.userChecksum","files.fileSize","files.downloadURL","files.previewURL"]

The optional fields to include in the response.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "assets": [ { "assetId": "string", "assetVersion": "string" } ], "includeFields": [ "*", "name", "description", "tags", "primaryType", "portalMetadata", "metadata", "metadata.yourFieldName", "systemMetadata.fieldName", "datasets.*", "datasets.name", "datasets.isVisible", "datasets.workflowName", "datasets.description", "datasets.tags", "datasets.portalMetadata", "datasets.metadata", "datasets.systemMetadata", "datasets.primaryType", "files.*", "files.filePath", "files.description", "files.tags", "files.portalMetadata", "files.metadata", "files.systemMetadata", "files.userChecksum", "files.fileSize", "files.downloadURL", "files.previewURL" ]}' \ "https://services.api.unity.com/assets/v1/libraries/{libraryId}/assets/batch/get"

Response example

{ "assets": [ { "asset": { "assetId": "b59940b38970", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "name": "Tree material", "description": "This is a material to be used in trees", "tags": [ "string" ], "systemTags": [ "string" ], "labels": [ "string" ], "archivedLabels": [ "string" ], "primaryType": "Material", "portalMetadata": "string", "versionNumber": 3, "parentVersionNumber": 2, "changeLog": "- Added tag 'Wood' to asset;\\r\\n- Added a metallic map to material;", "parentAssetVersion": "4", "metadata": { "MarketingPitch": "Your marketing pitch", "Price": 0.5, "Length": 200, "ScorePoints": 15, "IsReadyForPostProcess": true, "ValidatedByManager": false, "ConnectedToWebPortal": false, "LaunchDate": "2023-08-16T08:49:12.1674180", "LastCheckPlan": "2023-08-16T08:49:12.1674180", "DateScanned": "2023-06-05T010:35:05.1674180", "License": "https://assetfilelicense.com", "WebProductPage": "https://productpage.com", "RepoSource": "https://github.com/myprojectrepo", "Priority": "Low|Medium|High", "Certifications": "ISO 4905|ISO 3013", "TeamCharter": "Seoul|Shanghai|Jakarta", "IndustryType": [ "Architecture", "Industrial", "Energy and Oil" ], "Sprints": [ 1, 2, 3, 4, 5 ], "Owner": "5772465996530", "Reviewer": "5772465996530", "Project Lead": "5772465996530" }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "status": "Draft", "isFrozen": true, "created": "2024-01-01T00:00:00Z", "createdBy": "5772465996530", "updated": "2024-01-01T00:00:00Z", "updatedBy": "5772465996530", "sourceProjectId": "string", "projectIds": [ "87cf845f-8ca7-4b2f-9cc1-c3d731335810", "5fd931ab-0950-4e9c-9264-d888f490b5a5", "5e7b9c90-b07e-490c-bfb7-80897f6f7e7e" ], "previewFile": "folder/thumbnail.gif", "previewFileDatasetId": "string", "previewFileUrl": "https://teststorage.com/files/folder/thumbnail.gif", "isPreviewFileUrlOriginalImage": true, "files": [ { "datasetIds": null, "filePath": null, "description": null, "status": null, "created": null, "createdBy": null, "updated": null, "updatedBy": null, "tags": null, "systemTags": null, "portalMetadata": null, "metadata": null, "systemMetadata": null, "userChecksum": null, "fileSize": null, "downloadURL": null, "isDownloadURLOriginalImage": null, "previewURL": null, "previewDatasetId": null, "primaryType": null, "transformationInputFiles": null, "isPreviewURLOriginalImage": null, "mainFile": null } ], "datasets": [ { "datasetId": null, "name": null, "description": null, "isVisible": null, "workflowName": null, "tags": null, "portalMetadata": null, "primaryType": null, "metadata": null, "systemMetadata": null, "status": null, "systemTags": null, "createdBy": null, "created": null, "updatedBy": null, "updated": null, "filesOrder": null, "vcsMappingId": null } ], "assetTemplateId": "string", "statusFlowId": "string", "statusFlowName": "string", "autoSubmit": true, "trashDetails": [ { "projectId": null, "movedToTrashBy": null, "movedToTrashAt": null } ], "upstreamReferences": [ { "id": null, "type": null, "assetId": null, "assetVersion": null, "labelName": null, "sourceDatasetId": null, "targetDatasetId": null, "dependencyType": null, "relativePath": null, "metadata": null } ], "downstreamReferences": [ { "id": null, "type": null, "assetId": null, "assetVersion": null, "labelName": null, "sourceDatasetId": null, "targetDatasetId": null, "dependencyType": null, "relativePath": null, "metadata": null } ] }, "files": [ { "datasetIds": [ null ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ null ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ null ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "datasets": [ { "datasetId": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "name": "Thumbnails", "description": "Dataset with thumbnails images of the asset.", "isVisible": true, "workflowName": "thumbnail-generation", "tags": [ "thumbnail", "image" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "status": "string", "systemTags": [ null ], "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "filesOrder": [ null ], "vcsMappingId": "string" } ], "upstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ], "downstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ] } ], "errors": [ { "assetId": "string", "assetVersion": "string", "label": "string", "errorMessage": "string", "errorCode": "string" } ]}

List references originating in assetId.

The context query parameter can be used to filter the result.

If context == source, This endpoint lists all the references with assetId and asset version as source assetId and source assetVersion.

If context == target, This endpoint lists all the references with assetId and asset version as target assetId and target assetVersion.

If not context is provided, this endpoint list all the references that has the assetId and assetVersion as its target or source.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

Query parameters for "{title}"

AssetVersion

string

The asset version.

Context

The context to filter the result with.

offset

integer

example: 10

The amount of entities to skip.

limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/references"

Response example

{ "results": [ { "referenceId": "string", "type": "string", "isValid": true, "source": { "assetId": "string", "assetVersion": "string", "datasetId": "string" }, "target": { "assetId": "string", "assetVersion": "string", "labelName": "string", "datasetId": "string" }, "dependencyType": "string", "relativePath": "string", "metadata": {} } ], "total": 0}

Create a reference .

Asset Manager supports modeling a dependency between two asset versions by using the concept of a reference. A reference is an oriented link from one source asset version identified by [assetId, assetVersion] pair towards another target asset version. The target asset version can be identified by the pair [assetId, assetVersion] or by the pair [assetId, labelName].

The first, assetVersion-kind is a "hard-link" as target asset version is hardcoded into reference during creation of the reference.

The second, labeled-kind is a "soft-link" as it represents the target defined as "asset version of an asset identified by assetId and having assigned label labelName". As such, whenever the labelName is reassigned, the real target asset version is changed to the asset version just receiving the labelName. This provides for semantics based referencing which will keep up with the assets' evolution.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the source asset.

Request body for "{title}"

Media Type:

application/json

assetVersion

string

必填

The asset version.

target

object

The reference's target asset.

assetId

string

The id of the asset.

assetVersion

string

The asset version.

labelName

string

The name of the label.

datasetId

string

The optional target dataset identifier.

datasetId

string

The optional source dataset identifier.

dependencyType

string

The optional type of dependency.

relativePath

string

The optional relative path of the dependency.

metadata

object

The optional metadata of the dependency.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "assetVersion": "string", "target": { "assetId": "string", "assetVersion": "string", "labelName": "string", "datasetId": "string" }, "datasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {}}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/references"

Response example

{ "referenceId": "string"}

Read asset files.

Read asset files from a dataset in an asset.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

The project id.

assetId

string

必填

The asset id.

assetVersion

string

必填

The asset version.

datasetId

string

必填

The dataset id.

Query parameters for "{title}"

includeFields

array

example: *,filePath,description,tags,portalMetadata,metadata,systemMetadata,userChecksum,fileSize,downloadURL

The optional fields to include in the response.

token

string

The pagination token.

limit

integer

The amount of assets per page.

HTTP response status codes for "{title}":

OK

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/files"

Response example

{ "results": [ { "datasetIds": [ "string" ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ "string" ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ "string" ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "total": 0, "next": "string", "previous": "string"}

Create file.

Upload a file to an asset and define metadata. The file needs to belong to one dataset. By default, an asset has a source dataset and a preview dataset.

When using the upload URL returned by this method, it is necessary to include the following header in your HTTP request:

x-ms-blob-type: BlockBlob

. This header specifies the type of blob being uploaded to Azure Blob Storage and ensures that the upload operation is properly recognized and processed as a block blob.

Additionally, for streamed uploads where the file is uploaded in chunks, it is necessary to include the

Content-Type: application/octet-stream

header. This ensures that the storage service correctly interprets the data being streamed and processes it without errors.

Failing to include the required headers may result in errors or unexpected behavior during the upload operation. Ensure that all HTTP clients interacting with the upload URL are configured to set these headers correctly based on the upload method. Note: File metadata are not yet displayed on the Unity Asset Manager web. Returned URL is valid for one hour only.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset belongs.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The ID of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset.

datasetId

string

必填

example: d21b2715-0c09-4c0d-ba8f-647291eacfd4

The ID of the dataset in which the file should be assigned.

Request body for "{title}"

Media Type:

application/json

filePath

string

必填

example: my-folder/my-file.txt

The path of the file. Serves as the unique identifier.

description

string

example: File from technical equipment

A description of the file.

tags

array[string]

example: ["Industry","CAD"]

A list of tags associated with the file.

portalMetadata

string

The metadata provided by the frontend.

metadata

object

example: {"Triangle count":"45002","IsRigged":"True","FileExtension":"fbx","BoundingBoxSize (m)":"3.02","CameraType":"Sony X","Lens":"Leica","CapturedTime":"2023-08-16T08:49:12.1674180-04:00","FPS":"29.43","Length (s)":"143","Resolution":"1024","BitDepth":"32","Bitrate":"320 Kbps"}

Available field to add searchable custom metadata.

systemMetadata

object

[Deprecated] This field is deprecated for this request and is read-only. Please use the Metadata field to store additional information.

userChecksum

string

example: 5a828ca5302b19ae8c7a66149f3e1e98

Available field for checksum use-case.

fileSize

integer

example: 512

The file size.

mainFile

boolean

Flag to indicate the main file.

createEvenIfFrozen

boolean

Flag to indicate whether it should create even if asset is frozen.

HTTP response status codes for "{title}":

OK

Asset file is created but URL generation failed. Use the get upload url endpoint <a href="#tag/File-management/operation/assets_v1_AssetFiles_GetUploadAssetFileUrl">here</a> to fetch a new url.

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "filePath": "my-folder/my-file.txt", "description": "File from technical equipment", "tags": [ "Industry", "CAD" ], "portalMetadata": "string", "metadata": { "Triangle count": "45002", "IsRigged": "True", "FileExtension": "fbx", "BoundingBoxSize (m)": "3.02", "CameraType": "Sony X", "Lens": "Leica", "CapturedTime": "2023-08-16T08:49:12.1674180-04:00", "FPS": "29.43", "Length (s)": "143", "Resolution": "1024", "BitDepth": "32", "Bitrate": "320 Kbps" }, "systemMetadata": {}, "userChecksum": "5a828ca5302b19ae8c7a66149f3e1e98", "fileSize": 512, "mainFile": true, "createEvenIfFrozen": true}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/files"

Response example

{ "uploadUrl": "https://example.com"}

Remove files from dataset.

The endpoint to remove files from a dataset/asset.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

The project id.

assetId

string

必填

The asset id.

assetVersion

string

必填

The asset version.

datasetId

string

必填

The dataset id.

Request body for "{title}"

Media Type:

application/json

filePaths

array[string]

The paths to files. Serves as the unique identifiers.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X DELETE \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "filePaths": [ "string" ]}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/files"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Create asset version.

Creates a new version of an existing asset. The new asset-version is in Unfrozen state. If the new asset-version is created from an existing asset-version, the Previews and Sources datasets will be referenced from the base version(no new dataset versions created at this point)

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset is located.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

Request body for "{title}"

Media Type:

application/json

parentAssetVersion

string

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The AssetVersion from which the new version will be derived. If this parameter is omitted, the latest version will be used.

statusFlowId

string

The identifier of the status flow to assign to the asset version.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "parentAssetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "statusFlowId": "string"}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions"

Response example

{ "assetVersion": "2", "parentAssetVersion": "4", "parentVersionNumber": 2}

Create a bulk operation task for an asset version.

Creates a bulk operation that will be performed on a group of asset versions with a project. The bulk operation can be comprised of multiple operations. An optional flag can be provided to freeze the asset versions once the operations have completed.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

Request body for "{title}"

Media Type:

application/json

assetVersions

array[object]

The list of assets involved in the bulk operation, by asset id and asset version.

assetId

string

example: 65325f523a625f7e1acdb197

The asset id.

assetVersion

string

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The asset version.

operations

array[object]

The list of operations.

operationType

string

必填

The type of the operation.

operationArguments

object

必填

The arguments to the operation.

submitOnCompletion

boolean

The flag to indicate if the asset should be submitted on successful completion.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "assetVersions": [ { "assetId": "65325f523a625f7e1acdb197", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5" } ], "operations": [ { "operationType": "string", "operationArguments": {} } ], "submitOnCompletion": true}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/versions/bulk"

Response example

{ "bulkId": "string"}

List collections.

Return all collections within a project.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the collection(s) live.

Query parameters for "{title}"

offset

integer

The amount of collections to skip.

limit

integer

The maximum number of collections to return.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/collections"

Response example

[ { "name": "string", "description": "string", "parentPath": "string" }]

Create collection.

Create a collection under a project. The special character '%' is not allowed in the collection name.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the collection will be created.

Request body for "{title}"

Media Type:

application/json

parentPath

string

example: RootCollection/ParentCollection

The parent collection's path

name

string

必填

example: Trees

The name of the collection.

description

string

example: Collection of trees

The description of the collection.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "parentPath": "RootCollection/ParentCollection", "name": "Trees", "description": "Collection of trees"}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/collections"

Response example

{ "path": "string"}

Read datasets from an asset.

Read datasets from an asset in a project.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

The project id.

assetId

string

必填

The asset id.

assetVersion

string

必填

The asset version.

Query parameters for "{title}"

includeFields

array

example: *,description,tags,portalMetadata,metadata,systemMetadata,files,filesOrder,files.downloadURL

The optional fields to include in the response.

token

string

The pagination token.

limit

integer

The amount of assets per page.

HTTP response status codes for "{title}":

OK

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets"

Response example

{ "results": [ { "datasetId": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "name": "Thumbnails", "description": "Dataset with thumbnails images of the asset.", "isVisible": true, "workflowName": "thumbnail-generation", "tags": [ "thumbnail", "image" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "status": "string", "systemTags": [ "string" ], "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "filesOrder": [ "string" ], "files": [ { "datasetIds": [ null ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ null ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ null ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "vcsMappingId": "string" } ], "total": 0, "next": "string", "previous": "string"}

Create dataset.

Create a new dataset in an asset. Note: New datasets are not visible (yet) from the Unity Asset Manager. Neither is dataset metadata.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset belongs.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset.

Request body for "{title}"

Media Type:

application/json

name

string

必填

The name of the dataset.

description

string

The description of the dataset.

tags

array[string]

example: ["Materials","Textures"]

A list of tags associated with the dataset.

portalMetadata

string

The metadata provided by the frontend.

primaryType

string

The primary type of the asset.

isVisible

boolean

Define if the dataset is visible in the UI.

metadata

object

example: {"StringField":"string value","BoolField":true,"Base64BytesField":"dGVzdCB0ZXh0IGVuY29kaW5n","DoubleField":10.5,"FloatField":10.005,"IntField":10,"LongField":9223372000000000000,"DateTimeField":"2023-08-16T08:49:12.1674180-04:00","ListField":["string value",10,false]}

Available field to add custom and searchable metadata.

systemMetadata

object

[Deprecated] This field is deprecated for this request and is read-only. Please use the Metadata field to store additional information.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "description": "string", "tags": [ "Materials", "Textures" ], "portalMetadata": "string", "primaryType": "string", "isVisible": true, "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets"

Response example

{ "datasetId": "string"}

Lists all features available.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Query parameters for "{title}"

offset

integer

example: 10

The amount of entities to skip.

limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/features"

Response example

{ "results": [ { "name": "string", "description": "string" } ], "total": 0}

Read labels.

Get all the labels in the organization.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Query parameters for "{title}"

status

example: Active

The status of the labels to be returned.

isSystemLabel

boolean

example: true

The type of the labels to be returned.

offset

integer

example: 10

The amount of entities to skip.

limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/labels"

Response example

{ "results": [ { "name": "string", "description": "string", "colour": "string", "isSystemLabel": true, "isUserAssignable": true, "created": "2024-01-01T00:00:00Z", "createdBy": "string", "updated": "2024-01-01T00:00:00Z", "updatedBy": "string" } ], "total": 0}

Create label.

Creates a new label in the organization.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Request body for "{title}"

Media Type:

application/json

name

string

必填

example: release-candidate

The name of the label.

description

string

必填

example: Assets ready to be used in 'release-candidate' releases.

The description of the label.

colour

string

example: #00FF00

The RGB Hex color code of the label.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "name": "release-candidate", "description": "Assets ready to be used in 'release-candidate' releases.", "colour": "#00FF00"}' \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/labels"

Response example

{ "labelName": "string"}

Get entitlements.

Returns the organization entitlements, the current user seat entitlements and whether or not the user has a valid seat.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

No description

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Conflict

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/entitlements"

Response example

{ "entitlements": [ "string" ], "userSeats": [ "string" ], "validSeat": true}

Read current user or service account projects.

Endpoint for reading a list of projects in an org that the current user or service account has access to.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Query parameters for "{title}"

IncludeFields

array

example: hasCollection

The optional fields to include in the response.

Features

array

The name of the features to filter the projects by.

Page

integer

example: 1

The page.

Limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/projects"

Response example

{ "projects": [ { "organizationId": "5772925064011", "id": "02cc56be-968b-4a38-b06f-16dfb2953d95", "name": "Test Project", "metadata": {}, "storageIds": [ "string" ], "status": "Unknown", "userCount": 0, "hasCollection": true, "features": [ "string" ] } ], "projectsRole": {}}

Create project.

Create a new Asset Manager project in your organization.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Request body for "{title}"

Media Type:

application/json

name

string

必填

The name of the project.

isPrivateProject

boolean

Private project setting.

metadata

object

The metadata of the project (Optional).

features

array[string]

The name of the features to add to the project.

HTTP response status codes for "{title}":

Created

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "isPrivateProject": true, "metadata": {}, "features": [ "string" ]}' \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/projects"

Response example

{ "projectId": "string"}

[Deprecated] Reads a list of projects in an org that a service account has access to.

[Deprecated] To be deprecated from February 2024. Please use the get projects endpoint in the project management section.

Authorizations

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Query parameters for "{title}"

Page

integer

example: 1

The page.

Limit

integer

example: 25

The page size.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/service-accounts/me/organizations/{organizationId}/projects"

Response example

{ "projects": [ { "organizationId": "5772925064011", "id": "02cc56be-968b-4a38-b06f-16dfb2953d95", "name": "Test Project", "metadata": {}, "storageIds": [ "string" ], "status": "Unknown", "userCount": 0, "hasCollection": true, "features": [ "string" ] } ], "projectsRole": {}}

List field definitions.

Return metadata field definition from the organization library.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Query parameters for "{title}"

IncludeDeleted

boolean

example: false

A value indicating whether the result should include deleted fields.

Limit

integer

The amount of field definitions per page.

SortingOrder

example: Ascending

The order to sort the fields.

FieldOrigin

string

If defined, only search for fields with the specified FieldOrigin value (either 'User' or 'System')

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/templates/fields"

Response example

{ "fieldDefinitions": [ { "name": "GeometryArea", "displayName": "Geometry Area", "type": "Boolean", "acceptedValues": [ "Area", "Volume" ], "multiSelection": true, "status": "Active|Deleted", "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "fieldOrigin": "User" } ], "next": "string"}

Create field definition.

Create a Metadata Field for your organization to add to assets. The Metadata field definition is stored in your metadata’s organization library.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Request body for "{title}"

Media Type:

application/json

name

string

必填

example: SourceOfAsset

The unique name of the field. The field definition name is unique within the organization.

displayName

string

必填

example: Source of asset

The name that will be used to display the field on the UI. The type of the field definition. Refer to user documentation for more info.

type

string

必填

The type of a field definition.

acceptedValues

array[string]

example: ["Internally created","Bought from asset store","Created by partner"]

The accepted values of the field. Required only when the type is "Selection".

multiSelection

boolean

example: false

A value indicating whether the field is multi selection. Required only when the type is "Selection".

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "name": "SourceOfAsset", "displayName": "Source of asset", "type": "Boolean", "acceptedValues": [ "Internally created", "Bought from asset store", "Created by partner" ], "multiSelection": false}' \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/templates/fields"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Start transformation - 3D Data Streaming.

This workflow is intended for large model review use cases. It utilizes Pixyz technology to produce a representation of a large 3D model utilizing hierarchical levels of detail that are dynamically streamed into a viewer at view time. Massive 3D models that are typical in architecture, geospatial applications, and other infrastructure projects are best prepared using this workflow. This workflow is only available in the Unity Enterprise Tier. You may consider using the glb-preview workflow as an alternative for small model previewing.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The asset id.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The asset version.

datasetId

string

必填

example: d21b2715-0c09-4c0d-ba8f-647291eacfd4

The dataset id.

Request body for "{title}"

Media Type:

application/json

workflowScope

string

example: Custom

The workflow scope. Used for internal-only custom workflows.

inputFiles

array[string]

example: ["filename.png","my-folder/my-file.txt"]

The list of input files.

extraParameters

object

example: {"useDracoCompression":"1"}

The extra parameters for workflow engine.

useAdditiveOutputDataset

boolean

example: true

The flag use additive output dataset.

HTTP response status codes for "{title}":

OK

Bad Request

Forbidden

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "workflowScope": "Custom", "inputFiles": [ "filename.png", "my-folder/my-file.txt" ], "extraParameters": { "useDracoCompression": "1" }, "useAdditiveOutputDataset": true}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/transformations/start/3d-data-streaming"

Response example

{ "transformationId": "string"}

[Deprecated] Read current user projects.

[Deprecated] Endpoint for reading a list of projects in an org that the current user has access to. To be deprecated from February 2024. Please use the get projects endpoint in the project management section.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Query parameters for "{title}"

Page

integer

example: 1

The page.

Limit

integer

example: 25

The page size.

features

array

The features to filter for if any.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://services.api.unity.com/assets/v1/users/me/organizations/{organizationId}/projects"

Response example

{ "projects": [ { "organizationId": "5772925064011", "id": "02cc56be-968b-4a38-b06f-16dfb2953d95", "name": "Test Project", "metadata": {}, "storageIds": [ "string" ], "status": "Unknown", "userCount": 0, "hasCollection": true, "features": [ "string" ] } ], "projectsRole": {}}

[Deprecated] Update file.

Update file metadata. Note: File metadata aren’t displayed yet on the Unity Asset Manager.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset belongs.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The ID of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset to be updated.

filePath

string

必填

example: my-folder%2Fmy-file.txt

The encoded path of the file. Serves as the unique identifier.

Request body for "{title}"

Media Type:

application/json

description

string

example: File from technical equipment

The new file description.

tags

array[string]

example: ["Industry","CAD"]

The new file tag(s).

portalMetadata

string

The new searchable custom metadata.

metadata

object

example: {"Triangle count":"45002","IsRigged":"True","FileExtension":"fbx","BoundingBoxSize (m)":"3.02","CameraType":"Sony X","Lens":"Leica","CapturedTime":"2023-08-16T08:49:12.1674180-04:00","FPS":"29.43","Length (s)":"143","Resolution":"1024","BitDepth":"32","Bitrate":"320 Kbps"}

The metadata of the asset file.

systemMetadata

object

[Deprecated] This field is deprecated for this request and is read-only. Please use the Metadata field to store additional information.

mainFile

boolean

Flag to indicate the main file.

updateEvenIfFrozen

boolean

Flag to indicate whether it should update even if asset is frozen.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "description": "File from technical equipment", "tags": [ "Industry", "CAD" ], "portalMetadata": "string", "metadata": { "Triangle count": "45002", "IsRigged": "True", "FileExtension": "fbx", "BoundingBoxSize (m)": "3.02", "CameraType": "Sony X", "Lens": "Leica", "CapturedTime": "2023-08-16T08:49:12.1674180-04:00", "FPS": "29.43", "Length (s)": "143", "Resolution": "1024", "BitDepth": "32", "Bitrate": "320 Kbps" }, "systemMetadata": {}, "mainFile": true, "updateEvenIfFrozen": true}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/files/{filePath}"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Read asset file.

Reads an asset file from an asset.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

The project id.

assetId

string

必填

The asset id.

assetVersion

string

必填

The asset version.

datasetId

string

必填

The dataset id.

filePath

string

必填

The optional fields to include in the response.

Query parameters for "{title}"

includeFields

array

example: *,filePath,description,tags,portalMetadata,metadata,systemMetadata,userChecksum,fileSize,downloadURL

The optional fields to include in the response.

HTTP response status codes for "{title}":

OK

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/files/{filePath}"

Response example

{ "datasetIds": [ "string" ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ "string" ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ "string" ], "isPreviewURLOriginalImage": true, "mainFile": true}

Update file.

Update file metadata. Note: File metadata aren’t displayed yet on the Unity Asset Manager.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset belongs.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The ID of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset.

datasetId

string

必填

example: d21b2715-0c09-4c0d-ba8f-647291eacfd4

The ID of the dataset in which the file should be updated (Placeholder for future feature).

filePath

string

必填

example: my-folder%2Fmy-file.txt

The encoded path of the file. Serves as the unique identifier.

Query parameters for "{title}"

updateEvenIfFrozen

boolean

默认: false

example: false

Whether to edit a frozen version of the asset.

Request body for "{title}"

Media Type:

application/json

description

string

example: File from technical equipment

The new file description.

tags

array[string]

example: ["Industry","CAD"]

The new file tag(s).

portalMetadata

string

The new searchable custom metadata.

metadata

object

example: {"Triangle count":"45002","IsRigged":"True","FileExtension":"fbx","BoundingBoxSize (m)":"3.02","CameraType":"Sony X","Lens":"Leica","CapturedTime":"2023-08-16T08:49:12.1674180-04:00","FPS":"29.43","Length (s)":"143","Resolution":"1024","BitDepth":"32","Bitrate":"320 Kbps"}

The metadata of the asset file.

mainFile

boolean

Flag to indicate the main file.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "description": "File from technical equipment", "tags": [ "Industry", "CAD" ], "portalMetadata": "string", "metadata": { "Triangle count": "45002", "IsRigged": "True", "FileExtension": "fbx", "BoundingBoxSize (m)": "3.02", "CameraType": "Sony X", "Lens": "Leica", "CapturedTime": "2023-08-16T08:49:12.1674180-04:00", "FPS": "29.43", "Length (s)": "143", "Resolution": "1024", "BitDepth": "32", "Bitrate": "320 Kbps" }, "mainFile": true}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/files/{filePath}"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Remove file from dataset.

The endpoint to remove a file from a dataset/asset.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset belongs.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The ID of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset.

datasetId

string

必填

example: 042fde6b-49b8-4017-a0dd-5f3a00f4bc5c

The ID of the dataset.

filePath

string

必填

example: my-folder%2my-file.txt

The encoded path of the file. Serves as the unique identifier.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X DELETE \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/files/{filePath}"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Submit asset version.

Submits an asset version that is not frozen. It will return a failure if the asset has transformations still running. In this case, use AutoSubmitAssetVersion.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset is located.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The asset version.

Request body for "{title}"

Media Type:

application/json

forceFreeze

boolean

example: false

Submitting with forceFreeze will immediately freeze the asset, even if there are transformations running. The running transformation will be cancelled.

changeLog

string

example: - Added tag 'Wood' to asset;\r\n- Added a metallic map to material;

The change log for the asset version.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "forceFreeze": false, "changeLog": "- Added tag 'Wood' to asset;\\r\\n- Added a metallic map to material;"}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/submit"

Response example

{ "versionNumber": 0}

Create a bulk operation task for specified search criteria.

Creates a bulk operation that will be performed on a group of asset versions in a project that match a set of search criteria. Due to a limit of 5000 assets per bulk operation, results exceeding this number will be grouped into multiple bulk operations. For example, 15001 assets returned means 4 bulk operations are created.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

Request body for "{title}"

Media Type:

application/json

filter

object

The asset read filter.

includeQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":16384},{"conditionType":"lessThan","value":1048576.2}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","updatedBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.description":"description of the dataset","datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to include all the entries matching all the criteria.

excludeQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":-163.84},{"conditionType":"lessThan","value":1048576}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","updatedBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.description":"description of the dataset","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to exclude all the entries matching all the criteria.

anyQuery

object

example: {"created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"assetId":"included-asset-id","assetVersion":{"type":"exact-match","value":"a83f650b-3e86-4457-8ce4-8decef827da0","caseInsensitive":false},"name":{"type":"wildcard","value":"*auto*"},"description":{"type":"regex","value":".*auto.*"},"tags":["tag1","tag2","tag3"],"systemTags":["tag1","tag2","tag3"],"labels":["label1","label2"],"status":"Draft","primaryType":"included-asset-type","metadata.fieldName":{"type":"prefix","value":"fieldVal"},"systemMetadata.fieldName":"fieldValue","files.FileSize":{"type":"numeric-range","conditions":[{"conditionType":"greaterThanOrEqual","value":16384},{"conditionType":"lessThan","value":1048576}]},"portalMetadata":"","previewFile":"folder/thumbnail.gif","createdBy":"5772465996530","versionNumber":13,"parentVersionNumber":12,"changeLog":"- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;","parentAssetVersion":"1","datasets.isVisible":true,"datasets.workflowName":"thumbnail-generation","datasets.name":{"type":"fuzzy","value":"nsme"},"datasets.description":"description of the dataset","datasets.tags":["tag1","tag2","tag3"],"datasets.portalMetadata":"portalMetadata","datasets.metadata.fieldName":"fieldValue","datasets.systemMetadata.fieldName":"fieldValue","datasets.primaryType":"primaryTypeValue","datasets.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"datasets.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.filePath":"file-example.txt","files.description":"file-description","files.status":"Uploaded","files.created":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.updated":{"type":"date-range","conditions":[{"conditionType":"greaterThanOrEqual","value":"2023-08-16T09:16:39Z"},{"conditionType":"lessThan","value":"2023-08-27T09:00:00Z"}]},"files.tags":["tag1","tag2","tag3"],"files.portalMetadata":"portalMetadata","files.checksum":"checksum","files.fileSize":4096,"files.metadata.fieldName":"fieldValue","files.systemMetadata.fieldName":"fieldValue"}

The dictionary to Include all entries matching any of the criteria.

anyQueryMinimumMatch

integer

The minimum any query match amount to be considered a match for return.

collections

array[string]

The collection paths.

operations

array[object]

The list of operations.

operationType

string

必填

The type of the operation.

operationArguments

object

必填

The arguments to the operation.

submitOnCompletion

boolean

The flag to indicate if the asset should be submitted on successful completion.

HTTP response status codes for "{title}":

OK

Partial Content

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "filter": { "includeQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": 16384 }, { "conditionType": "lessThan", "value": 1048576.2 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "updatedBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.description": "description of the dataset", "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "excludeQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": -163.84 }, { "conditionType": "lessThan", "value": 1048576 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "updatedBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.description": "description of the dataset", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "anyQuery": { "created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "assetId": "included-asset-id", "assetVersion": { "type": "exact-match", "value": "a83f650b-3e86-4457-8ce4-8decef827da0", "caseInsensitive": false }, "name": { "type": "wildcard", "value": "*auto*" }, "description": { "type": "regex", "value": ".*auto.*" }, "tags": [ "tag1", "tag2", "tag3" ], "systemTags": [ "tag1", "tag2", "tag3" ], "labels": [ "label1", "label2" ], "status": "Draft", "primaryType": "included-asset-type", "metadata.fieldName": { "type": "prefix", "value": "fieldVal" }, "systemMetadata.fieldName": "fieldValue", "files.FileSize": { "type": "numeric-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": 16384 }, { "conditionType": "lessThan", "value": 1048576 } ] }, "portalMetadata": "", "previewFile": "folder/thumbnail.gif", "createdBy": "5772465996530", "versionNumber": 13, "parentVersionNumber": 12, "changeLog": "- Added tag 'Wood' to asset;\r\n- Added a metallic map to material;", "parentAssetVersion": "1", "datasets.isVisible": true, "datasets.workflowName": "thumbnail-generation", "datasets.name": { "type": "fuzzy", "value": "nsme" }, "datasets.description": "description of the dataset", "datasets.tags": [ "tag1", "tag2", "tag3" ], "datasets.portalMetadata": "portalMetadata", "datasets.metadata.fieldName": "fieldValue", "datasets.systemMetadata.fieldName": "fieldValue", "datasets.primaryType": "primaryTypeValue", "datasets.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "datasets.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.filePath": "file-example.txt", "files.description": "file-description", "files.status": "Uploaded", "files.created": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.updated": { "type": "date-range", "conditions": [ { "conditionType": "greaterThanOrEqual", "value": "2023-08-16T09:16:39Z" }, { "conditionType": "lessThan", "value": "2023-08-27T09:00:00Z" } ] }, "files.tags": [ "tag1", "tag2", "tag3" ], "files.portalMetadata": "portalMetadata", "files.checksum": "checksum", "files.fileSize": 4096, "files.metadata.fieldName": "fieldValue", "files.systemMetadata.fieldName": "fieldValue" }, "anyQueryMinimumMatch": 0, "collections": [ "string" ] }, "operations": [ { "operationType": "string", "operationArguments": {} } ], "submitOnCompletion": true}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/versions/bulk/criteria"

Response example

{ "bulkIds": [ "string" ]}

Read dataset.

Read a specific dataset from an asset.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

The project id.

assetId

string

必填

The asset id.

assetVersion

string

必填

The asset version.

datasetId

string

必填

The dataset id.

Query parameters for "{title}"

includeFields

array

example: *,description,tags,portalMetadata,metadata,systemMetadata,files,filesOrder,files.downloadURL

The optional fields to include in the response.

HTTP response status codes for "{title}":

OK

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

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

Response example

{ "datasetId": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "name": "Thumbnails", "description": "Dataset with thumbnails images of the asset.", "isVisible": true, "workflowName": "thumbnail-generation", "tags": [ "thumbnail", "image" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "status": "string", "systemTags": [ "string" ], "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "filesOrder": [ "string" ], "files": [ { "datasetIds": [ "string" ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ "string" ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ "string" ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "vcsMappingId": "string"}

Update dataset.

Update dataset metadata of an asset.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset belongs.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset.

datasetId

string

必填

example: d21b2715-0c09-4c0d-ba8f-647291eacfd4

The id of the dataset to be updated.

Query parameters for "{title}"

updateEvenIfFrozen

boolean

默认: false

Whether to edit a frozen version of the asset.

Request body for "{title}"

Media Type:

application/json

name

string

The new name of the dataset.

description

string

example: Previews

The new description field of the dataset.

isVisible

boolean

example: true

Parameter to display the dataset on the frontend. Not yet enabled on Unity Asset Manager. Coming soon

tags

array[string]

example: ["Tree","Landscape"]

The new tags for the dataset.

portalMetadata

string

The metadata provided by the frontend.

primaryType

string

The primary type of the asset.

metadata

object

example: {"StringField":"string value","BoolField":true,"Base64BytesField":"dGVzdCB0ZXh0IGVuY29kaW5n","DoubleField":10.5,"FloatField":10.005,"IntField":10,"LongField":9223372000000000000,"DateTimeField":"2023-08-16T08:49:12.1674180-04:00","ListField":["string value",10,false]}

The new searchable custom metadata.

systemMetadata

object

[Deprecated] This field is deprecated for this request and is read-only. Please use the Metadata field to store additional information.

filesOrder

array[string]

example: ["my-folder/my-file.txt","fileName.png"]

The order of the files through an array of FilePaths

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "description": "Previews", "isVisible": true, "tags": [ "Tree", "Landscape" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "filesOrder": [ "my-folder/my-file.txt", "fileName.png" ]}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Get project.

Reads a project by id.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

The project identifier.

Query parameters for "{title}"

includeFields

array

example: hasCollection

The optional fields to include in the response.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}"

Response example

{ "organizationId": "5772925064011", "id": "02cc56be-968b-4a38-b06f-16dfb2953d95", "name": "Test Project", "metadata": {}, "storageIds": [ "string" ], "status": "Unknown", "userCount": 0, "hasCollection": true, "features": [ "string" ]}

Start transformation - Higher tier optimize and convert.

Optimize and Convert allows you to transform your 3D assets using customizable parameters for strategy, polygon targets, and outputs. Free-tier users can only convert generic file formats, while Pro and Enterprise/Industry tiers have the capability to optimize and convert all supported 3D file formats. For further details, please refer to the user documentation. higher-tier-optimize-and-convert:

outputFileName Specify the filename to output. Defaults to "output". Type: String
exportFormats Specify the output file extension list. Defaults to ["glb"]. Type: Array of String
strategy Specify to either use a polygon target number (triangleCount) or a ratio (ratio) between 0 and 100%. Defaults to “ratio”. Type: String
target Specify the target polygon count or ratio (0-100%) for the processing of the file. Defaults to "100". Type: Integer
mergeOptimization Specify if workflow needs to do a scene optimization by merging some components. Defaults to false. Type: Boolean
meshCleaning Specify if workflow needs to do a scene optimization by deleting unnecessary objects. Defaults to false. Type: Boolean

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The asset id.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The asset version.

datasetId

string

必填

example: d21b2715-0c09-4c0d-ba8f-647291eacfd4

The dataset id.

Request body for "{title}"

Media Type:

application/json

workflowScope

string

example: Custom

The workflow scope. Used for internal-only custom workflows.

inputFiles

array[string]

example: ["filename.png","my-folder/my-file.txt"]

The list of input files.

extraParameters

object

example: {"useDracoCompression":"1"}

The extra parameters for workflow engine.

useAdditiveOutputDataset

boolean

example: true

The flag use additive output dataset.

HTTP response status codes for "{title}":

OK

Bad Request

Forbidden

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X POST \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "workflowScope": "Custom", "inputFiles": [ "filename.png", "my-folder/my-file.txt" ], "extraParameters": { "useDracoCompression": "1" }, "useAdditiveOutputDataset": true}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/datasets/{datasetId}/transformations/start/higher-tier-optimize-and-convert"

Response example

{ "transformationId": "string"}

Get user projects.

Endpoint for reading a list of projects in an org that a user has access to.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

Path parameters for "{title}"

userId

string

必填

example: 5772925064006

The user id.

organizationId

string

必填

example: 5772925064011

The organization id.

Query parameters for "{title}"

Page

integer

example: 1

The page.

Limit

integer

example: 25

The page size.

features

array

The features to search for.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ "https://services.api.unity.com/assets/v1/users/{userId}/organizations/{organizationId}/projects"

Response example

{ "projects": [ { "organizationId": "5772925064011", "id": "02cc56be-968b-4a38-b06f-16dfb2953d95", "name": "Test Project", "metadata": {}, "storageIds": [ "string" ], "status": "Unknown", "userCount": 0, "hasCollection": true, "features": [ "string" ] } ], "projectsRole": {}}

List references originating in an asset version recursively.

This endpoint traverses the tree formed by nodes defined by [assetId,assetVersion] and references being the directed edges in the tree. Direction of the reference (edge in graph) is defined as direction from reference's source asset version towards target asset version. The start of the lookup is defined by pair [assetId, assetVersion]. It is the asset version where the recursive lookup will originate from. The endpoint requires the user to choose the direction of traversal by specifying a value for direction parameter. This direction is used on the originating asset version as well as on all visited asset versions recursively.

Direction Downstream traverses the tree in the direction of the references, visiting asset versions that the originating asset version depends on.

With the direction Upstream specified, the endpoint traverses the tree against reference direction, it goes into asset versions depending on the lookup originating asset version.

Tree lookup uses breadth-first search algorithm to return immediate dependent nodes first. When the lookup ends because of all nodes has been visited or limit number of references has been reached, the references visited are returned in the result field and all unhandled nodes are returned in unresolved field.

To continue searching, the client has to issue the request for elements in unresolved field from the previous responses. The client must pass unresolved's assetId and assetVersion into the url and should the element in unresolved contain next value, this value should be put into url as a value for request.next .

This allows lookup algorithm to continue searching from exactly the point the search was abandoned before. These requests could be issues in parallel (to some reasonable degree) to speed up retrieving the references.

Example of serial implementation of retrieving references recursively using tree pagination :


            projectId = ... get id of the project in question
            direction = ... choose <i>Downstream</i> or <i>Upstream</i>
            limit = ... choose suitable page size, the maximal number of references to be returned from the endpoint, up to 1000.
            resolvedAssetVersions = ... empty set, will contain all [assetId,assetVersion] from complete lookup; important to be a set with properly defined equality for pairs [assetId, assetVersion]
            allReferences = ... empty set, will contain all references found
            
            queue = { [assetId, assetVersion, token:null ] }
            while ( queue is not empty )
            {
                current = queue.pop();
                if (resolvedAssetVersions.Contains(current))
                    continue;
            
                [result, unresolved] = ListReferencesRecursive( projectId, current.assetId, current.assetVersion, direction, { next: current.Next, limit: limit });
            
                allReferences.Add( result );
                foreach ( newlyVisited in unresolved.Where( un => !resolvedAssetVersions.Contains(un)) )
                    queue.Enqueue(newlyVisited);
            
                if (!unresolved.Contains(current))
                    resolvedAssetVersions.Add(current);
            }
            
            resolvedAssetVersions ... contains all pairs of [assetId, assetVersion] the originating asset version depends on (for Downstream) or influences (for Upstream)
            allReferences ... will contain all visited references.

References could form an oriented circle. This is not recommended, but the situation is not prevented from occurring by the Asset Manager backend, therefore should be handled by the client. Infinite visiting of nodes in a circle is prevented by checking resolvedAssetVersions before proceeding in the loop body. A more sophisticated mechanism can be put there to display circles to the user.

References could also form a diamond shape with one asset version being dependent on another asset version across multiple reference paths. Traversing across these paths would not cause an infinite loop, it would just duplicate results, but this is also prevented by consulting resolvedAssetVersions in the loop.

if direction == Downstream, This endpoint lists all the references with assetId and asset version as source assetId and source assetVersion.

if direction == Upstream, This endpoint lists all the references with assetId and asset version as target assetId and target assetVersion.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The asset version.

direction

必填

The recursive references search direction.

Query parameters for "{title}"

limit

integer

example: 25

The amount of references per page.

HTTP response status codes for "{title}":

OK

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/references/recursive/{direction}"

Response example

{ "results": [ { "referenceId": "string", "type": "string", "isValid": true, "source": { "assetId": "string", "assetVersion": "string", "datasetId": "string" }, "target": { "assetId": "string", "assetVersion": "string", "labelName": "string", "datasetId": "string" }, "dependencyType": "string", "relativePath": "string", "metadata": {} } ], "unresolved": [ { "assetId": "string", "assetVersion": "string", "next": "string" } ]}

Get asset version.

Return a single asset from a project with on-demand fields.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset lives.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset.

Query parameters for "{title}"

IncludeFields

array

example: *,name,description,tags,primaryType,portalMetadata,metadata,metadata.yourFieldName,systemMetadata.fieldName,datasets.*,datasets.name,datasets.isVisible,datasets.workflowName,datasets.description,datasets.tags,datasets.portalMetadata,datasets.metadata,datasets.systemMetadata,datasets.primaryType,files.*,files.filePath,files.description,files.tags,files.portalMetadata,files.metadata,files.systemMetadata,files.userChecksum,files.fileSize,files.downloadURL,files.previewURL

The optional fields to include in the response.

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Conflict

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}"

Response example

{ "assetId": "b59940b38970", "assetVersion": "b095dce9-6034-44c4-a02a-d41d7afbfab5", "name": "Tree material", "description": "This is a material to be used in trees", "tags": [ "string" ], "systemTags": [ "string" ], "labels": [ "string" ], "archivedLabels": [ "string" ], "primaryType": "Material", "portalMetadata": "string", "versionNumber": 3, "parentVersionNumber": 2, "changeLog": "- Added tag 'Wood' to asset;\\r\\n- Added a metallic map to material;", "parentAssetVersion": "4", "metadata": { "MarketingPitch": "Your marketing pitch", "Price": 0.5, "Length": 200, "ScorePoints": 15, "IsReadyForPostProcess": true, "ValidatedByManager": false, "ConnectedToWebPortal": false, "LaunchDate": "2023-08-16T08:49:12.1674180", "LastCheckPlan": "2023-08-16T08:49:12.1674180", "DateScanned": "2023-06-05T010:35:05.1674180", "License": "https://assetfilelicense.com", "WebProductPage": "https://productpage.com", "RepoSource": "https://github.com/myprojectrepo", "Priority": "Low|Medium|High", "Certifications": "ISO 4905|ISO 3013", "TeamCharter": "Seoul|Shanghai|Jakarta", "IndustryType": [ "Architecture", "Industrial", "Energy and Oil" ], "Sprints": [ 1, 2, 3, 4, 5 ], "Owner": "5772465996530", "Reviewer": "5772465996530", "Project Lead": "5772465996530" }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "status": "Draft", "isFrozen": true, "created": "2024-01-01T00:00:00Z", "createdBy": "5772465996530", "updated": "2024-01-01T00:00:00Z", "updatedBy": "5772465996530", "sourceProjectId": "string", "projectIds": [ "87cf845f-8ca7-4b2f-9cc1-c3d731335810", "5fd931ab-0950-4e9c-9264-d888f490b5a5", "5e7b9c90-b07e-490c-bfb7-80897f6f7e7e" ], "previewFile": "folder/thumbnail.gif", "previewFileDatasetId": "string", "previewFileUrl": "https://teststorage.com/files/folder/thumbnail.gif", "isPreviewFileUrlOriginalImage": true, "files": [ { "datasetIds": [ "string" ], "filePath": "directory/file1.extension", "description": "Normal map 1 for tree object", "status": "Uploaded", "created": "2023-09-15T15:48:26.731Z", "createdBy": "5772465996530", "updated": "2023-09-15T15:48:26.731Z", "updatedBy": "5772465996530", "tags": [ "thumbnail", "small", "model" ], "systemTags": [ "string" ], "portalMetadata": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": { "externalID": "4a86205c-5506-4546-9b86-a815507bc7d1", "autoGenerated": true, "dateProcessed": "2023-09-15T15:42:52.106Z", "externalUserId": "55e5725f-5722-4249-ad7a-5ee32d9e3178" }, "userChecksum": "b0ab4c79218a8a510761e25458bb69b2", "fileSize": 4096, "downloadURL": "http://testdownloadurl.com/file123", "isDownloadURLOriginalImage": true, "previewURL": "https://example.com", "previewDatasetId": "string", "primaryType": "string", "transformationInputFiles": [ "string" ], "isPreviewURLOriginalImage": true, "mainFile": true } ], "datasets": [ { "datasetId": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "name": "Thumbnails", "description": "Dataset with thumbnails images of the asset.", "isVisible": true, "workflowName": "thumbnail-generation", "tags": [ "thumbnail", "image" ], "portalMetadata": "string", "primaryType": "string", "metadata": { "StringField": "string value", "BoolField": true, "Base64BytesField": "dGVzdCB0ZXh0IGVuY29kaW5n", "DoubleField": 10.5, "FloatField": 10.005, "IntField": 10, "LongField": 9223372000000000000, "DateTimeField": "2023-08-16T08:49:12.1674180-04:00", "ListField": [ "string value", 10, false ] }, "systemMetadata": {}, "status": "string", "systemTags": [ "string" ], "createdBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "created": "2023-09-15T10:52:34.398Z", "updatedBy": "2ba1c430-086d-4b0b-a4cc-3120a2fab86a", "updated": "2023-09-15T10:52:34.398Z", "filesOrder": [ "string" ], "vcsMappingId": "string" } ], "assetTemplateId": "string", "statusFlowId": "string", "statusFlowName": "string", "autoSubmit": true, "trashDetails": [ { "projectId": "string", "movedToTrashBy": "string", "movedToTrashAt": "2024-01-01T00:00:00Z" } ], "upstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ], "downstreamReferences": [ { "id": "string", "type": "string", "assetId": "string", "assetVersion": "string", "labelName": "string", "sourceDatasetId": "string", "targetDatasetId": "string", "dependencyType": "string", "relativePath": "string", "metadata": {} } ]}

Update asset version.

Update the asset metadata and define which file should be used as the cover image for the Unity Asset Manager web.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The id of the project where the asset lives.

assetId

string

必填

example: 65325f523a625f7e1acdb197

The id of the asset.

assetVersion

string

必填

example: b095dce9-6034-44c4-a02a-d41d7afbfab5

The version of the asset.

Query parameters for "{title}"

updateEvenIfFrozen

boolean

默认: false

Flag to determine if users should be able to edit a frozen version.

Request body for "{title}"

Media Type:

application/json

name

string

example: Tree material

The new name of the asset.

description

string

example: Example tree material

The new description for the asset.

tags

array[string]

The new tags for the asset.

primaryType

string

The primary type of the asset.

portalMetadata

string

The metadata provided by the frontend.

metadata

object

example: {"MarketingPitch":"Your marketing pitch","Price":0.5,"Length":200,"ScorePoints":15,"IsReadyForPostProcess":true,"ValidatedByManager":false,"ConnectedToWebPortal":false,"LaunchDate":"2023-08-16T08:49:12.1674180","LastCheckPlan":"2023-08-16T08:49:12.1674180","DateScanned":"2023-06-05T010:35:05.1674180","License":"https://assetfilelicense.com","WebProductPage":"https://productpage.com","RepoSource":"https://github.com/myprojectrepo","Priority":"Low|Medium|High","Certifications":"ISO 4905|ISO 3013","TeamCharter":"Seoul|Shanghai|Jakarta","IndustryType":["Architecture","Industrial","Energy and Oil"],"Sprints":[1,2,3,4,5],"Owner":"5772465996530","Reviewer":"5772465996530","Project Lead":"5772465996530"}

The searchable custom metadata. Metadata fields need to exist in the organization library. Refer to Metadata field management endpoints.

systemMetadata

object

[Deprecated] This field is deprecated for this request and is read-only. Please use the Metadata field to store additional information.

previewFilePath

string

example: my-folder/my-file.txt

The file path of the asset cover image.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ -H "Content-Type: application/json" \ -d '{ "name": "Tree material", "description": "Example tree material", "tags": [ "string" ], "primaryType": "string", "portalMetadata": "string", "metadata": { "MarketingPitch": "Your marketing pitch", "Price": 0.5, "Length": 200, "ScorePoints": 15, "IsReadyForPostProcess": true, "ValidatedByManager": false, "ConnectedToWebPortal": false, "LaunchDate": "2023-08-16T08:49:12.1674180", "LastCheckPlan": "2023-08-16T08:49:12.1674180", "DateScanned": "2023-06-05T010:35:05.1674180", "License": "https://assetfilelicense.com", "WebProductPage": "https://productpage.com", "RepoSource": "https://github.com/myprojectrepo", "Priority": "Low|Medium|High", "Certifications": "ISO 4905|ISO 3013", "TeamCharter": "Seoul|Shanghai|Jakarta", "IndustryType": [ "Architecture", "Industrial", "Energy and Oil" ], "Sprints": [ 1, 2, 3, 4, 5 ], "Owner": "5772465996530", "Reviewer": "5772465996530", "Project Lead": "5772465996530" }, "systemMetadata": {}, "previewFilePath": "my-folder/my-file.txt"}' \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Delete an unfrozen asset version.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

projectId

string

必填

example: e5a3ca16-13c7-4f2d-a5bb-984e349911df

The project id.

assetId

string

必填

example: b59940b38970

The id of the asset.

assetVersion

string

必填

example: b59940b38970

The asset version.

HTTP response status codes for "{title}":

No Content

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X DELETE \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/projects/{projectId}/assets/{assetId}/versions/{assetVersion}"

Response example

{ "code": "string", "message": "string", "stackTrace": "string", "details": [ { "errorCode": "string", "errorMessage": "string" } ]}

Read bulk operation definitions.

Reads the definitions of available operations that can be performed as part of a bulk operation.

Authorizations

Client

HTTP: Client

HTTP Authorization Scheme: bearer

ServiceAccount

HTTP: ServiceAccount

To get started with authentication, visit the Service Account Authentication section.

HTTP Authorization Scheme: basic

Path parameters for "{title}"

organizationId

string

必填

example: 5772925064011

The organization id.

Query parameters for "{title}"

resourceType

string

Optional filter for resource type..

HTTP response status codes for "{title}":

OK

Bad Request

Unauthorized

Not Found

Unsupported Media Type

Internal Server Error

Code samples for "{title}":

Request example

curl -X GET \ -H "Authorization: Bearer <YOUR_TOKEN>" \ -H "Authorization: Basic <YOUR_CREDENTIALS>" \ "https://services.api.unity.com/assets/v1/organizations/{organizationId}/bulk/definitions"

Response example

{ "operationDefinitions": [ { "type": "string", "description": "string", "operationArguments": {}, "resourceType": "string", "operationFields": {} } ]}

Asset Manager API

List organization status flows.

Path parameters for "{title}"

organizationId

Query parameters for "{title}"

offset

limit

HTTP response status codes for "{title}":

200OK

400Bad Request

401Unauthorized

404Not Found

415Unsupported Media Type

500Internal Server Error

Code samples for "{title}":

Request example

Response example

GET/organizations/{organizationId}/status

Assign status flow.

Path parameters for "{title}"

projectId

assetId

assetVersion

statusFlowId

HTTP response status codes for "{title}":

204No Content

400Bad Request

401Unauthorized

404Not Found

415Unsupported Media Type

500Internal Server Error

Code samples for "{title}":

Request example

Response example

POST/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/statusflows/{statusFlowId}/assign

Disable the autosubmit mode.

Path parameters for "{title}"

projectId

assetId

assetVersion

HTTP response status codes for "{title}":

204No Content

400Bad Request

401Unauthorized

404Not Found

415Unsupported Media Type

500Internal Server Error

Code samples for "{title}":

Request example

Response example

POST/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/autosubmit/disable

AutoSubmit asset version.

Path parameters for "{title}"

projectId

assetId

assetVersion

Request body for "{title}"

changeLog

HTTP response status codes for "{title}":

200OK

400Bad Request

401Unauthorized

404Not Found

409Conflict

415Unsupported Media Type

500Internal Server Error

Code samples for "{title}":

Request example

Response example

POST/projects/{projectId}/assets/{assetId}/versions/{assetVersion}/autosubmit

Rolls the metadata of an asset version to a previous version.

Path parameters for "{title}"

assetId

assetVersion

projectId

sequenceNumber

HTTP response status codes for "{title}":

204No Content

400Bad Request

401Unauthorized