Interface IUGCRepresentationApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.UGC

Assembly: solution.dll

Syntax

public interface IUGCRepresentationApi : IApiAccessor

Methods

CreateRepresentation(string, string, string, CreateRepresentationRequest, CancellationToken)

Create representation for a content item

Declaration

ApiOperation<RepresentationDTO> CreateRepresentation(string projectId, string environmentId, string contentId, CreateRepresentationRequest createRepresentationRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Project that this content belongs to
string	environmentId	Environment that this content belongs to
string	contentId	Content id
CreateRepresentationRequest	createRepresentationRequest	Request information for representation (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<RepresentationDTO>	The operation

CreateRepresentationOutputVersion(string, string, string, string, AddRepresentationVersionRequest, CancellationToken)

Add new representation version for a content item

Declaration

ApiOperation<UploadRepresentationVersionResponse> CreateRepresentationOutputVersion(string projectId, string environmentId, string contentId, string representationId, AddRepresentationVersionRequest addRepresentationVersionRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Project that this content belongs to
string	environmentId	Environment that this content belongs to
string	contentId	Content id
string	representationId	Representation id
AddRepresentationVersionRequest	addRepresentationVersionRequest	Add representation request (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<UploadRepresentationVersionResponse>	The operation

DeleteRepresentation(string, string, string, string, CancellationToken)

Delete representation for a content item

Declaration

ApiOperation DeleteRepresentation(string projectId, string environmentId, string contentId, string representationId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Project that this content belongs to
string	environmentId	Environment that this content belongs to
string	contentId	Content id
string	representationId	Representation id
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

GetRepresentation(string, string, string, string, CancellationToken)

Get representation for a content item

Declaration

ApiOperation<RepresentationDTO> GetRepresentation(string projectId, string environmentId, string contentId, string representationId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Project that this content belongs to
string	environmentId	Environment that this content belongs to
string	contentId	Content id
string	representationId	Representation id
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<RepresentationDTO>	The operation

SearchProjectRepresentations(string, string, int?, int?, List<string>, string, List<string>, List<string>, bool?, CancellationToken)

Search representations in a given project and environment

Declaration

ApiOperation<RepresentationDTOPagedResult> SearchProjectRepresentations(string projectId, string environmentId, int? offset = null, int? limit = null, List<string> sortBys = null, string search = null, List<string> tags = null, List<string> filters = null, bool? includeTotal = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Representations that belongs to this project
string	environmentId	Representations that belongs to this environment
int?	offset	The amount of results to skip (optional)
int?	limit	The amount of results to take (optional)
List<string>	sortBys	The field to use to sort by in ascending order, prefix - for descending (optional)
string	search	Only return results with this search term in their name (optional)
List<string>	tags	Only return results with these tags (optional)
List<string>	filters	You can filter on any field in the DTO<br /> Syntax for filters is: {field},{operator},{value}<br /> The operators are: eq (equal to), neq (not equal to), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal)<br /> The field can be nested up to two levels. Ex: "field.nestedField.nestedNestedField"<br /> filters="deletedAt,eq,null" will only return entities that have not been deleted<br /> (optional)
bool?	includeTotal	Should the result include the total count of objects available to page (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<RepresentationDTOPagedResult>	The operation

SearchRepresentationVersions(string, string, string, string, int?, int?, List<string>, bool?, CancellationToken)

Search representation versions for a content item

Declaration

ApiOperation<RepresentationVersionDTOPagedResult> SearchRepresentationVersions(string projectId, string environmentId, string contentId, string representationId, int? offset = null, int? limit = null, List<string> sortBys = null, bool? includeTotal = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId
string	environmentId
string	contentId
string	representationId
int?	offset	(optional)
int?	limit	(optional)
List<string>	sortBys	(optional)
bool?	includeTotal	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<RepresentationVersionDTOPagedResult>	The operation

SearchRepresentations(string, string, string, int?, int?, string, List<string>, List<string>, List<string>, bool?, CancellationToken)

Search representations for a content item

Declaration

ApiOperation<RepresentationDTOPagedResult> SearchRepresentations(string projectId, string environmentId, string contentId, int? offset = null, int? limit = null, string search = null, List<string> sortBys = null, List<string> tags = null, List<string> filters = null, bool? includeTotal = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Representations that belongs to this project
string	environmentId	Representations that belongs to this environment
string	contentId	Representations that belongs to this content
int?	offset	The amount of results to skip (optional)
int?	limit	The amount of results to take (optional)
string	search	Only return results with this search term in their name (optional)
List<string>	sortBys	The field to use to sort by in ascending order, prefix - for descending (optional)
List<string>	tags	Only return results with these tags (optional)
List<string>	filters	You can filter on any field in the DTO<br /> Syntax for filters is: {field},{operator},{value}<br /> The operators are: eq (equal to), neq (not equal to), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal)<br /> The field can be nested up to two levels. Ex: "field.nestedField.nestedNestedField"<br /> filters="deletedAt,eq,null" will only return entities that have not been deleted<br /> (optional)
bool?	includeTotal	Should the result include the total count of objects available to page (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<RepresentationDTOPagedResult>	The operation

UpdateRepresentation(string, string, string, string, UpdateRepresentationRequest, CancellationToken)

Update representation for a content item

Declaration

ApiOperation<RepresentationDTO> UpdateRepresentation(string projectId, string environmentId, string contentId, string representationId, UpdateRepresentationRequest updateRepresentationRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Project that this content belongs to
string	environmentId	Environment that this content belongs to
string	contentId	Content id
string	representationId	Representation id
UpdateRepresentationRequest	updateRepresentationRequest	Request information for representation (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<RepresentationDTO>	The operation