Class ContentClient

Inheritance
object
ClientBase
ContentClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ContentClient : ClientBase, IContentClient

Constructors

ContentClient(IBusinessProcessClient, IPictureparkServiceSettings, HttpClient)

Declaration
public ContentClient(IBusinessProcessClient businessProcessClient, IPictureparkServiceSettings settings, HttpClient httpClient)
Parameters
IBusinessProcessClient businessProcessClient

IPictureparkServiceSettings settings

HttpClient httpClient

ContentClient(IPictureparkServiceSettings, HttpClient)

Declaration
public ContentClient(IPictureparkServiceSettings configuration, HttpClient httpClient)
Parameters
IPictureparkServiceSettings configuration

HttpClient httpClient

Properties

JsonSerializerSettings

Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
JsonSerializerSettings

ReadResponseAsString

Declaration
public bool ReadResponseAsString { get; set; }
Property Value
bool

Methods

AggregateAsync(ContentAggregationRequest, CancellationToken)

Aggregate contents

Declaration
public virtual Task<ObjectAggregationResult> AggregateAsync(ContentAggregationRequest request, CancellationToken cancellationToken = default)
Parameters
ContentAggregationRequest request

Content aggregation request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ObjectAggregationResult>

Object aggregation result
Implements
Remarks

Aggregates content by content fields values as specified in the aggregation request.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

AggregateOnChannelAsync(ContentAggregationOnChannelRequest, CancellationToken)

Aggregate contents on channel

Declaration
public virtual Task<ObjectAggregationResult> AggregateOnChannelAsync(ContentAggregationOnChannelRequest request, CancellationToken cancellationToken = default)
Parameters
ContentAggregationOnChannelRequest request

Content aggregation on channel request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ObjectAggregationResult>

Object aggregation result
Implements
Remarks

Aggregates content by content fields values as specified in the aggregators saved on a channel.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

BatchUpdateFieldsByFilterAsync(ContentFieldsBatchUpdateFilterRequest, TimeSpan?, bool, CancellationToken)

Batch update fields - by filter

Declaration
public Task<ContentBatchOperationResult> BatchUpdateFieldsByFilterAsync(ContentFieldsBatchUpdateFilterRequest updateRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default)
Parameters
ContentFieldsBatchUpdateFilterRequest updateRequest

The metadata update request.
TimeSpan? timeout

Timeout for waiting on the business process.
bool waitSearchDocCreation

Wait for the creation of the search document and the rendered display values. By default the method waits for the search documents creation. Passing false, the method will return when the main entities have been updated and the creation of the search documents has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentBatchOperationResult>

The ContentBatchOperationResult.
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkException

Internal server error
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkValidationException

Validation exception

BatchUpdateFieldsByFilterCoreAsync(ContentFieldsBatchUpdateFilterRequest, CancellationToken)

Batch update fields - by filter

Declaration
protected virtual Task<BusinessProcess> BatchUpdateFieldsByFilterCoreAsync(ContentFieldsBatchUpdateFilterRequest request, CancellationToken cancellationToken = default)
Parameters
ContentFieldsBatchUpdateFilterRequest request

Content fields batch update filter request. It contains the changes that need to be applied to the contents and the filter request to identify the contents.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Remarks

Updates metadata layers' fields of multiple contents. For file-less contents, the content's fields themselves can be updated as well.
A filter must be provided to limit the update to specific contents. The same set of changes is applied to all the contents.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

BatchUpdateFieldsByIdsAsync(ContentFieldsBatchUpdateRequest, TimeSpan?, bool, CancellationToken)

Batch update fields - by ids

Declaration
public Task<ContentBatchOperationResult> BatchUpdateFieldsByIdsAsync(ContentFieldsBatchUpdateRequest updateRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default)
Parameters
ContentFieldsBatchUpdateRequest updateRequest

The metadata update request.
TimeSpan? timeout

Timeout for waiting on the business process.
bool waitSearchDocCreation

Wait for the creation of the search document and the rendered display values. By default the method waits for the search documents creation. Passing false, the method will return when the main entities have been updated and the creation of the search documents has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentBatchOperationResult>

The ContentBatchOperationResult.
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkException

Internal server error
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkValidationException

Validation exception

BatchUpdateFieldsByIdsCoreAsync(ContentFieldsBatchUpdateRequest, CancellationToken)

Batch update content fields - by IDs

Declaration
protected virtual Task<BusinessProcess> BatchUpdateFieldsByIdsCoreAsync(ContentFieldsBatchUpdateRequest request, CancellationToken cancellationToken = default)
Parameters
ContentFieldsBatchUpdateRequest request

Content fields batch update request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Remarks

Updates metadata layers' fields of multiple contents. For file-less contents, the content's fields themselves can be updated as well.
A list of content IDs must be provided to limit the update to specific contents. The same set of changes is applied to all the contents.
See ShouldUpdateMetadataMany tests.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

CheckContentSchemaChangeAsync(CheckContentSchemaIdChangeRequest, CancellationToken)

Check if given changes of ContentSchemaId are possible without incurring data loss (due to assigned Layers and LayerSchemaIds)

Declaration
public virtual Task<CheckContentSchemaIdChangeResult> CheckContentSchemaChangeAsync(CheckContentSchemaIdChangeRequest request, CancellationToken cancellationToken = default)
Parameters
CheckContentSchemaIdChangeRequest request

Changes to check
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<CheckContentSchemaIdChangeResult>

Result indicating if data loss would occur for given requests
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

CheckUpdateFileAsync(string, ContentFileUpdateCheckRequest, CancellationToken)

Check if a file update is possible without incurring data loss

Declaration
public virtual Task<CheckContentSchemaIdChangeResult> CheckUpdateFileAsync(string id, ContentFileUpdateCheckRequest request, CancellationToken cancellationToken = default)
Parameters
string id

The ID of the content to replace.
ContentFileUpdateCheckRequest request

Content file update request
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<CheckContentSchemaIdChangeResult>

Information about data loss, if any
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

CreateAndAwaitDownloadLinkAsync(ContentDownloadLinkCreateRequest, TimeSpan?, CancellationToken)

Creates a download link and awaits potential dynamic output format rendering

Declaration
public Task<DownloadLink> CreateAndAwaitDownloadLinkAsync(ContentDownloadLinkCreateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
ContentDownloadLinkCreateRequest request

Content download link request
TimeSpan? timeout

Timeout for operation
CancellationToken cancellationToken

The cancellation token.
Returns
Task<DownloadLink>

Download link
Implements

CreateAsync(ContentCreateRequest, IEnumerable<ContentResolveBehavior>, bool?, TimeSpan?, bool?, CancellationToken)

Create content

Declaration
public virtual Task<ContentDetail> CreateAsync(ContentCreateRequest request, IEnumerable<ContentResolveBehavior> resolveBehaviors = null, bool? allowMissingDependencies = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default)
Parameters
ContentCreateRequest request

Content create request.
IEnumerable<ContentResolveBehavior> resolveBehaviors

List of enums that control which parts of the content are resolved and returned.
bool? allowMissingDependencies

Allows creating contents that refer to list items or contents that don't exist in the system.
TimeSpan? timeout

Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
Only the waiting is aborted, and the calls returned.
bool? waitSearchDocCreation

Wait for the creation of the search document and the rendered display values.
By default the endpoint waits for the search document creation. Passing false, the endpoint will return when the main entity has been created and the creation of the search document has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentDetail>

The content details
Implements
Remarks

Create a single file-less content item. To import files, see Transfer.

Exceptions
ApiException

A server side error occurred.
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
BusinessProcessLifeCycleNotHitException

The specified wait timeout exceeded

CreateCommentAsync(string, CommentCreateRequest, TimeSpan?, CancellationToken)

Create comment

Declaration
public virtual Task<Comment> CreateCommentAsync(string id, CommentCreateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
string id

Content ID.
CommentCreateRequest request

Comment creation request.
TimeSpan? timeout

Operation timeout.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<Comment>

Created comment
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

CreateDownloadLinkAsync(ContentDownloadLinkCreateRequest, CancellationToken)

Create download link

Declaration
public virtual Task<BusinessProcess> CreateDownloadLinkAsync(ContentDownloadLinkCreateRequest request, CancellationToken cancellationToken = default)
Parameters
ContentDownloadLinkCreateRequest request

Content download link request
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Download link
Implements
Remarks

Creates a download link for one or more contents. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

CreateManyAsync(ContentCreateManyRequest, TimeSpan?, bool, CancellationToken)

Create - many

Declaration
public Task<ContentBatchOperationWithRequestIdResult> CreateManyAsync(ContentCreateManyRequest contentCreateManyRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default)
Parameters
ContentCreateManyRequest contentCreateManyRequest

The content create many request.
TimeSpan? timeout

Timeout for waiting on the business process.
bool waitSearchDocCreation

Wait for the creation of the search document and the rendered display values. By default the method waits for the search documents creation. Passing false, the method will return when the main entities have been created and the creation of the search documents has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentBatchOperationWithRequestIdResult>

The ContentBatchOperationResult.
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkException

Internal server error
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkValidationException

Validation exception

CreateManyCoreAsync(ContentCreateManyRequest, CancellationToken)

Create multiple contents

Declaration
protected virtual Task<BusinessProcess> CreateManyCoreAsync(ContentCreateManyRequest request, CancellationToken cancellationToken = default)
Parameters
ContentCreateManyRequest request

Content create many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Remarks

Create multiple file-less content items. To import files, see Transfer.
The operation is executed asynchronous and it's not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

CreateVersionDownloadLinkAsync(string, int, CancellationToken)

Get historic version download link

Declaration
public virtual Task<string> CreateVersionDownloadLinkAsync(string id, int versionId, CancellationToken cancellationToken = default)
Parameters
string id

Content ID.
int versionId

Version ID.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<string>

Download token to be used with download/{token} endpoint
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

DeleteAsync(string, bool?, TimeSpan?, bool?, CancellationToken)

Delete content

Declaration
public virtual Task DeleteAsync(string id, bool? forceReferenceRemoval = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default)
Parameters
string id

The ID of the content to delete.
bool? forceReferenceRemoval

A value indicating whether references to the content should be removed.
TimeSpan? timeout

Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
Only the waiting is aborted, and the calls returned.
bool? waitSearchDocCreation

Wait for the creation of the search document and the rendered display values.
By default the endpoint waits for the search document creation. Passing false, the endpoint will return when the main entity has been created and the creation of the search document has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task

Ok
Implements
Remarks

Deletes a single content. The lifecycle is changed to Inactive. After a customer instance specified time (default 30 days), the content and all files will be hard deleted.

Exceptions
ApiException

A server side error occurred.
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
ReferencesUpdateException

Validation prevents deletion of item

DeleteCommentAsync(string)

Delete a comment

Declaration
public Task DeleteCommentAsync(string id)
Parameters
string id

Comment ID
Returns
Task

OK
Implements

DeleteCommentCoreAsync(string, string, TimeSpan?, CancellationToken)

Delete comment

Declaration
protected virtual Task DeleteCommentCoreAsync(string id, string commentId, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
string id

Content ID.
string commentId

Comment ID.
TimeSpan? timeout

Operation timeout.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task

OK
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

DeleteManyAsync(ContentDeleteManyRequest, CancellationToken)

Delete multiple contents

Declaration
public virtual Task<BusinessProcess> DeleteManyAsync(ContentDeleteManyRequest request, CancellationToken cancellationToken = default)
Parameters
ContentDeleteManyRequest request

Delete many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Remarks

Deletes multiple contents. The lifecycle is changed to Inactive. After a customer instance specified time (default 30 days), the content and all files will be hard deleted.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

DeleteManyByFilterAsync(ContentDeleteManyFilterRequest, CancellationToken)

Delete multiple contents - by filter

Declaration
public virtual Task<BusinessProcess> DeleteManyByFilterAsync(ContentDeleteManyFilterRequest request, CancellationToken cancellationToken = default)
Parameters
ContentDeleteManyFilterRequest request

Delete many by filter request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Remarks

Deletes multiple contents. A filter must be provided to limit the deletion to specific contents.
The lifecycle is changed to Inactive. After a customer instance specified time (default 30 days), the content and all files will be hard deleted.
The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

DeleteVersionAsync(string, int, CancellationToken)

Delete historic version

Declaration
public virtual Task DeleteVersionAsync(string id, int versionId, CancellationToken cancellationToken = default)
Parameters
string id

Content ID.
int versionId

Version ID.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task

OK
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

DownloadAsync(string, string, int?, int?, string, CancellationToken)

Download content

Declaration
public virtual Task<FileResponse> DownloadAsync(string contentId, string outputFormatId, int? width = null, int? height = null, string range = null, CancellationToken cancellationToken = default)
Parameters
string contentId

The content ID.
string outputFormatId

The output format ID.
int? width

Optional width in pixels to resize image.
int? height

Optional height in pixels to resize image.
string range

The range of bytes to download (http range header): bytes={from}-{to} (e.g. bytes=0-100000).
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<FileResponse>

Implements
Remarks

Download a single content in a specific output format. To resize images on download specify target width & height. To download only a portion of the file, specify the range parameter.
To use conversion presets on download, e.g. to crop or rotate, please see EditOutput.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

DownloadFilesAsync(ContentSearchResult, string, bool, int, string, string, bool, Action<ContentDetail>, Action<Exception>, CancellationToken)

Downloads multiple files

Declaration
public Task DownloadFilesAsync(ContentSearchResult contents, string exportDirectory, bool overwriteIfExists, int concurrentDownloads = 4, string outputFormat = "Original", string outputExtension = "", bool contentIdAsFilename = false, Action<ContentDetail> successDelegate = null, Action<Exception> errorDelegate = null, CancellationToken cancellationToken = default)
Parameters
ContentSearchResult contents

The files to download.
string exportDirectory

The directory to store the downloaded files.
bool overwriteIfExists

Specifies whether to overwrite files.
int concurrentDownloads

Specifies the number of concurrent downloads.
string outputFormat

The output format name (e.g. 'Original').
string outputExtension

The expected output file extension.
bool contentIdAsFilename

Specifies whether to use the content id as filename. If false, the original filename is used and a counter added if needed.
Action<ContentDetail> successDelegate

The success delegate/callback.
Action<Exception> errorDelegate

The error delegate/callback.
CancellationToken cancellationToken

The cancellation token.
Returns
Task

The task.
Implements

DownloadThumbnailAsync(string, ThumbnailSize, int?, int?, CancellationToken)

Download thumbnail

Declaration
public virtual Task<FileResponse> DownloadThumbnailAsync(string id, ThumbnailSize size, int? width = null, int? height = null, CancellationToken cancellationToken = default)
Parameters
string id

The content ID.
ThumbnailSize size

Thumbnail size. Either small, medium or large.
int? width

Optional width in pixels to resize image.
int? height

Optional height in pixels to resize image.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<FileResponse>

Implements
Remarks

Provides a lightweight endpoint to download content thumbnails.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

EditOutputAsync(string, string, string, CancellationToken)

Edit output

Declaration
public virtual Task<FileResponse> EditOutputAsync(string contentId, string outputFormatId, string conversionPreset, CancellationToken cancellationToken = default)
Parameters
string contentId

The content ID.
string outputFormatId

The output format ID.
string conversionPreset

The conversion preset.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<FileResponse>

Implements
Remarks

Edits a single content in a specific output format.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetAsync(string, IEnumerable<ContentResolveBehavior>, CancellationToken)

Get content

Declaration
public virtual Task<ContentDetail> GetAsync(string id, IEnumerable<ContentResolveBehavior> resolveBehaviors = null, CancellationToken cancellationToken = default)
Parameters
string id

The content ID.
IEnumerable<ContentResolveBehavior> resolveBehaviors

List of enums that control which parts of the content are resolved and returned.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentDetail>

Content detail
Implements
Remarks

Gets the content detail by ID.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkNotFoundException

Entity not found
ContentNotFoundException

Content not found

GetCommentAsync(string)

Get a comment

Declaration
public Task<Comment> GetCommentAsync(string id)
Parameters
string id

Comment ID
Returns
Task<Comment>

Comment
Implements

GetCommentCoreAsync(string, string, CancellationToken)

Get comment

Declaration
protected virtual Task<Comment> GetCommentCoreAsync(string id, string commentId, CancellationToken cancellationToken = default)
Parameters
string id

Content ID.
string commentId

Comment ID.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<Comment>

Comment if found
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkNotFoundException

Entity not found
CommentNotFoundException

Comment not found

GetDownloadLinkAsync(string, CancellationToken)

Resolve download token to Url

Declaration
public virtual Task<DownloadLink> GetDownloadLinkAsync(string token, CancellationToken cancellationToken = default)
Parameters
string token

Token
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<DownloadLink>

Download link information
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetManyAsync(IEnumerable<string>, IEnumerable<ContentResolveBehavior>, CancellationToken)

Get multiple contents

Declaration
public virtual Task<ICollection<ContentDetail>> GetManyAsync(IEnumerable<string> ids, IEnumerable<ContentResolveBehavior> resolveBehaviors = null, CancellationToken cancellationToken = default)
Parameters
IEnumerable<string> ids

List of content IDs
IEnumerable<ContentResolveBehavior> resolveBehaviors

List of enums that control which parts of the content are resolved and returned.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ICollection<ContentDetail>>

List of Content detail
Implements
Remarks

Gets multiple content details by IDs.
Can fetch 100 contents at most.

Exceptions
ApiException

A server side error occurred.
PictureparkForbiddenException

Forbidden
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
RequestSizeLimitExceededException

List of IDs exceeded maximum size
PictureparkNotFoundException

Entity not found
ContentNotFoundException

One or more contents not found

GetOutputsAsync(string, CancellationToken)

Get outputs

Declaration
public virtual Task<ICollection<OutputResolveResult>> GetOutputsAsync(string id, CancellationToken cancellationToken = default)
Parameters
string id

ID of content.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ICollection<OutputResolveResult>>

Array of Result of output resolution.
Implements
Remarks

Retrieves all outputs available for content, also dynamic rendered outputs are returned, if requested.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetOutputsManyAsync(OutputResolveManyRequest, CancellationToken)

Get outputs

Declaration
public virtual Task<ICollection<OutputResolveResult>> GetOutputsManyAsync(OutputResolveManyRequest request, CancellationToken cancellationToken = default)
Parameters
OutputResolveManyRequest request

Output resolve many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ICollection<OutputResolveResult>>

Array of Result of output resolution.
Implements
Remarks

Retrieves all outputs available for contents, also dynamic rendered outputs are returned, if requested.
A maximum of 1000 content ids can be specified.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetReferencesAsync(string, ContentReferencesRequest, CancellationToken)

Get content references

Declaration
public virtual Task<ContentReferencesResult> GetReferencesAsync(string id, ContentReferencesRequest request, CancellationToken cancellationToken = default)
Parameters
string id

The content ID whose references to retrieve.
ContentReferencesRequest request

Content references request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentReferencesResult>

ContentReferencesResult
Implements
Remarks

Gets the references (list items, contents, shares) to a single content.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetReferencesManyAsync(ContentManyReferencesRequest, CancellationToken)

Get many content references

Declaration
public virtual Task<ContentReferencesResult> GetReferencesManyAsync(ContentManyReferencesRequest request, CancellationToken cancellationToken = default)
Parameters
ContentManyReferencesRequest request

Content many references request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentReferencesResult>

Content references result
Implements
Remarks

Gets references (list items, contents, shares) to content documents defined by IDs.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetVersionDownloadLinkAsync(string, int, CancellationToken)

Creates a download link for a specific content historic version

Declaration
public Task<DownloadLink> GetVersionDownloadLinkAsync(string contentId, int version, CancellationToken cancellationToken)
Parameters
string contentId

Content ID
int version

Version number
CancellationToken cancellationToken

The cancellation token.
Returns
Task<DownloadLink>

Download link
Implements

GetVersionsAsync(string, HistoricVersionSearchRequest, CancellationToken)

Get historic versions

Declaration
public virtual Task<HistoricVersionSearchResult> GetVersionsAsync(string id, HistoricVersionSearchRequest request, CancellationToken cancellationToken = default)
Parameters
string id

Content ID.
HistoricVersionSearchRequest request

Request allowing for paging
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<HistoricVersionSearchResult>

Historic versions
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration
protected virtual Task<ContentClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
HttpResponseMessage response

IReadOnlyDictionary<string, IEnumerable<string>> headers

CancellationToken cancellationToken

Returns
Task<ContentClient.ObjectResponseResult<T>>

Type Parameters
T

RepairContentsBatchAsync(ContentRepairBatchRequest, CancellationToken)

Repair contents

Declaration
public virtual Task<BusinessProcess> RepairContentsBatchAsync(ContentRepairBatchRequest request, CancellationToken cancellationToken = default)
Parameters
ContentRepairBatchRequest request

Content repair request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Remarks

A repair operation re-extracts Metadata from the originally uploaded file, applies it and triggers follow-up actions where needed (e.g. Rendering, XmpWriteback)
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

RepairContentsByFilterAsync(ContentRepairByFilterRequest, CancellationToken)

Repair contents by filter

Declaration
public virtual Task<BusinessProcess> RepairContentsByFilterAsync(ContentRepairByFilterRequest request, CancellationToken cancellationToken = default)
Parameters
ContentRepairByFilterRequest request

Content repair request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Remarks

A repair operation re-extracts Metadata from the originally uploaded file, applies it and triggers follow-up actions where needed (e.g. Rendering, XmpWriteback)
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

RestoreAsync(string, bool?, TimeSpan?, bool?, CancellationToken)

Restore content

Declaration
public virtual Task RestoreAsync(string id, bool? allowMissingDependencies = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default)
Parameters
string id

The content ID.
bool? allowMissingDependencies

Allows restoring contents that refer to list items or contents that don't exist in the system.
TimeSpan? timeout

Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
Only the waiting is aborted, and the calls returned.
bool? waitSearchDocCreation

Wait for the creation of the search document and the rendered display values.
By default the endpoint waits for the search document creation. Passing false, the endpoint will return when the main entity has been created and the creation of the search document has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task

Ok
Implements
Remarks

Restores a previously deleted content.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

RestoreManyAsync(ContentRestoreManyRequest, CancellationToken)

Restore multiple contents

Declaration
public virtual Task<BusinessProcess> RestoreManyAsync(ContentRestoreManyRequest request, CancellationToken cancellationToken = default)
Parameters
ContentRestoreManyRequest request

Content restore many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Remarks

Restores previously deleted contents.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

SearchAsync(ContentSearchRequest, CancellationToken)

Search contents

Declaration
public virtual Task<ContentSearchResult> SearchAsync(ContentSearchRequest request, CancellationToken cancellationToken = default)
Parameters
ContentSearchRequest request

Content search request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentSearchResult>

Result for content search operation
Implements
Remarks

Searches contents as specified in the search request.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

SearchCommentsAsync(string, CommentSearchRequest, CancellationToken)

Search comments

Declaration
public virtual Task<CommentSearchResult> SearchCommentsAsync(string id, CommentSearchRequest request, CancellationToken cancellationToken = default)
Parameters
string id

Content ID.
CommentSearchRequest request

Search request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<CommentSearchResult>

List of found comments
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

SetDisplayContentAsync(string, SetDisplayContentRequest, IEnumerable<ContentResolveBehavior>, TimeSpan?, bool?, CancellationToken)

Sets/unsets a DisplayContent for a content with an id given in the request

Declaration
public virtual Task<ContentDetail> SetDisplayContentAsync(string id, SetDisplayContentRequest setDisplayContentRequest, IEnumerable<ContentResolveBehavior> resolveBehaviors = null, TimeSpan? timeout = null, bool? waitForContinuation = null, CancellationToken cancellationToken = default)
Parameters
string id

Id of the content
SetDisplayContentRequest setDisplayContentRequest

Request with DisplayContentId
IEnumerable<ContentResolveBehavior> resolveBehaviors

List of enums that control which parts of the content are resolved and returned.
TimeSpan? timeout

Timeout for the operation
bool? waitForContinuation

Wait for the creation of the search doc update.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentDetail>

Result of the operation
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

SetManyDisplayContentsAsync(SetDisplayContentsManyRequest, CancellationToken)

Process many requests to set/unset display contents for given contents

Declaration
public virtual Task<BusinessProcess> SetManyDisplayContentsAsync(SetDisplayContentsManyRequest setDisplayContentsManyRequest, CancellationToken cancellationToken = default)
Parameters
SetDisplayContentsManyRequest setDisplayContentsManyRequest

Set many display contents request
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

TransferOwnershipAsync(string, ContentOwnershipTransferRequest, TimeSpan?, bool?, CancellationToken)

Transfer content ownership

Declaration
public virtual Task TransferOwnershipAsync(string id, ContentOwnershipTransferRequest request, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default)
Parameters
string id

The content ID.
ContentOwnershipTransferRequest request

Content ownership transfer request.
TimeSpan? timeout

Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
Only the waiting is aborted, and the calls returned.
bool? waitSearchDocCreation

Wait for the creation of the search document and the rendered display values.
By default the endpoint waits for the search document creation. Passing false, the endpoint will return when the main entity has been created and the creation of the search document has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task

Ok
Implements
Remarks

Transfers ownership of a content to another user. The target user must have the ManageContent UserRight.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

TransferOwnershipByFilterAsync(ContentOwnershipBatchTransferFilterRequest, CancellationToken)

Transfer multiple contents ownerships - by filter

Declaration
public virtual Task<BusinessProcess> TransferOwnershipByFilterAsync(ContentOwnershipBatchTransferFilterRequest request, CancellationToken cancellationToken = default)
Parameters
ContentOwnershipBatchTransferFilterRequest request

Content ownership transfer many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Remarks

Transfers ownerships of multiple contents to specified users. The target users must have the ManageContent UserRight.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

TransferOwnershipManyAsync(ContentOwnershipTransferManyRequest, TimeSpan?, bool, CancellationToken)

Transfer ownership - many

Declaration
public Task<ContentBatchOperationResult> TransferOwnershipManyAsync(ContentOwnershipTransferManyRequest contentOwnershipTransferManyRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default)
Parameters
ContentOwnershipTransferManyRequest contentOwnershipTransferManyRequest

The content ownership transfer many request.
TimeSpan? timeout

Timeout for waiting on the business process.
bool waitSearchDocCreation

Wait for the creation of the search document and the rendered display values. By default the method waits for the search documents creation. Passing false, the method will return when the main entities have been updated and the creation of the search documents has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentBatchOperationResult>

The ContentBatchOperationResult.
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkException

Internal server error
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkValidationException

Validation exception

TransferOwnershipManyCoreAsync(ContentOwnershipTransferManyRequest, CancellationToken)

Transfer multiple contents ownerships

Declaration
protected virtual Task<BusinessProcess> TransferOwnershipManyCoreAsync(ContentOwnershipTransferManyRequest request, CancellationToken cancellationToken = default)
Parameters
ContentOwnershipTransferManyRequest request

Content ownership transfer many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Remarks

Transfers ownerships of multiple contents to specified users. The target users must have the ManageContent UserRight.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

UpdateCommentAsync(string, CommentEditable)

Update a comment

Declaration
public Task<Comment> UpdateCommentAsync(string id, CommentEditable request)
Parameters
string id

Comment ID
CommentEditable request

What should be updated
Returns
Task<Comment>

Updated comment
Implements

UpdateCommentCoreAsync(string, string, CommentEditable, TimeSpan?, CancellationToken)

Update comment

Declaration
protected virtual Task<Comment> UpdateCommentCoreAsync(string id, string commentId, CommentEditable request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
string id

Content ID.
string commentId

Comment ID.
CommentEditable request

Comment update.
TimeSpan? timeout

Operation timeout.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<Comment>

Updated comment
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

UpdateFileAsync(string, ContentFileUpdateRequest, bool?, CancellationToken)

Update content file

Declaration
public virtual Task<BusinessProcess> UpdateFileAsync(string id, ContentFileUpdateRequest request, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default)
Parameters
string id

The ID of the content to replace.
ContentFileUpdateRequest request

Content file update request
bool? waitSearchDocCreation

Wait for the creation of the search document and the rendered display values.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Remarks

Updates binary file of existing content. The file must already be uploaded before calling this endpoint. See Transfer.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

UpdateMetadataAsync(string, ContentMetadataUpdateRequest, IEnumerable<ContentResolveBehavior>, bool?, TimeSpan?, bool?, CancellationToken)

Update content metadata

Declaration
public virtual Task<ContentDetail> UpdateMetadataAsync(string id, ContentMetadataUpdateRequest request, IEnumerable<ContentResolveBehavior> resolveBehaviors = null, bool? allowMissingDependencies = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default)
Parameters
string id

The content ID.
ContentMetadataUpdateRequest request

Content metadata update request.
IEnumerable<ContentResolveBehavior> resolveBehaviors

List of enums that control which parts of the content are resolved and returned.
bool? allowMissingDependencies

Allows storing references to list items or contents that don't exist in the system.
TimeSpan? timeout

Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
Only the waiting is aborted, and the calls returned.
bool? waitSearchDocCreation

Wait for the creation of the search document and the rendered display values.
By default the endpoint waits for the search document creation. Passing false, the endpoint will return when the main entity has been created and the creation of the search document has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentDetail>

Content detail
Implements
Remarks

Updates metadata layers of a specified content. For file-less contents, the content itself can be updated as well.
The update is flexible enough to allow the update of only the fields that are specified in the request (leaving untouched the other existing ones) or to allow
the entire replacement of all the values of a schema or even of all the schemas.
See ShouldUpdateMetadata tests.

Exceptions
ApiException

A server side error occurred.
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
BusinessProcessLifeCycleNotHitException

The specified wait timeout exceeded

UpdateMetadataManyAsync(ContentMetadataUpdateManyRequest, TimeSpan?, bool, CancellationToken)

Update metadata - many

Declaration
public Task<ContentBatchOperationResult> UpdateMetadataManyAsync(ContentMetadataUpdateManyRequest updateRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default)
Parameters
ContentMetadataUpdateManyRequest updateRequest

The metadata update requests.
TimeSpan? timeout

Timeout for waiting on the business process.
bool waitSearchDocCreation

Wait for the creation of the search document and the rendered display values. By default the method waits for the search documents creation. Passing false, the method will return when the main entities have been updated and the creation of the search documents has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentBatchOperationResult>

The ContentBatchOperationResult.
Implements
Exceptions
ApiException

A server side error occurred.
ContentNotFoundException

Not all provided contents could be found
PictureparkNotFoundException

Entity not found
PictureparkException

Internal server error
PictureparkConflictException

Version conflict
PictureparkValidationException

Validation exception

UpdateMetadataManyCoreAsync(ContentMetadataUpdateManyRequest, CancellationToken)

Update multiple content metadata

Declaration
protected virtual Task<BusinessProcess> UpdateMetadataManyCoreAsync(ContentMetadataUpdateManyRequest request, CancellationToken cancellationToken = default)
Parameters
ContentMetadataUpdateManyRequest request

Content metadata update many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Remarks

Updates metadata layers of multiple contents. For file-less contents, the contents itself can be updated a swell.
See ShouldUpdateMetadata tests.
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkNotFoundException

Entity not found
ContentNotFoundException

One or more contents not found

UpdatePermissionsAsync(string, ContentPermissionsUpdateRequest, IEnumerable<ContentResolveBehavior>, TimeSpan?, bool?, CancellationToken)

Update content permissions

Declaration
public virtual Task<ContentDetail> UpdatePermissionsAsync(string id, ContentPermissionsUpdateRequest request, IEnumerable<ContentResolveBehavior> resolveBehaviors = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default)
Parameters
string id

The content ID.
ContentPermissionsUpdateRequest request

Content permissions update request.
IEnumerable<ContentResolveBehavior> resolveBehaviors

List of enums that control which parts of the content are resolved and returned.
TimeSpan? timeout

Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
Only the waiting is aborted, and the calls returned.
bool? waitSearchDocCreation

Wait for the creation of the search document and the rendered display values.
By default the endpoint waits for the search document creation. Passing false, the endpoint will return when the main entity has been created and the creation of the search document has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentDetail>

Content detail
Implements
Remarks

Updates the content permission sets of a single content. To get a list of available content permission sets, see Permissions

Exceptions
ApiException

A server side error occurred.
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
BusinessProcessLifeCycleNotHitException

The specified wait timeout exceeded

UpdatePermissionsByFilterAsync(ContentPermissionsBatchUpdateFilterRequest, CancellationToken)

Update multiple contents permissions - by filter

Declaration
public virtual Task<BusinessProcess> UpdatePermissionsByFilterAsync(ContentPermissionsBatchUpdateFilterRequest request, CancellationToken cancellationToken = default)
Parameters
ContentPermissionsBatchUpdateFilterRequest request

Content permissions update many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Implements
Remarks

Updates the content permission sets of multiple contents. To get a list of available content permission sets, see Permissions
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

UpdatePermissionsManyAsync(ContentPermissionsUpdateManyRequest, TimeSpan?, bool, CancellationToken)

Update permissions - many

Declaration
public Task<ContentBatchOperationResult> UpdatePermissionsManyAsync(ContentPermissionsUpdateManyRequest updateManyRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default)
Parameters
ContentPermissionsUpdateManyRequest updateManyRequest

The permissions update many request.
TimeSpan? timeout

Timeout for waiting on the business process.
bool waitSearchDocCreation

Wait for the creation of the search document and the rendered display values. By default the method waits for the search documents creation. Passing false, the method will return when the main entities have been created and the creation of the search documents has been enqueued but not yet performed.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<ContentBatchOperationResult>

The ContentBatchOperationResult.
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkException

Internal server error
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkValidationException

Validation exception

UpdatePermissionsManyCoreAsync(ContentPermissionsUpdateManyRequest, CancellationToken)

Update multiple contents permissions

Declaration
protected virtual Task<BusinessProcess> UpdatePermissionsManyCoreAsync(ContentPermissionsUpdateManyRequest request, CancellationToken cancellationToken = default)
Parameters
ContentPermissionsUpdateManyRequest request

Content permissions update many request.
CancellationToken cancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
Task<BusinessProcess>

Business process
Remarks

Updates the content permission sets of multiple contents. To get a list of available content permission sets, see Permissions
The operation is executed asynchronous and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

WaitForBusinessProcessAndReturnResult(string, TimeSpan?, bool, CancellationToken)

Waits for a business process and returns a ContentBatchOperationResult.

Declaration
public Task<ContentBatchOperationResult> WaitForBusinessProcessAndReturnResult(string businessProcessId, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default)
Parameters
string businessProcessId

The business process id.
TimeSpan? timeout

The timeout to wait on the business process.
bool waitSearchDocCreation

Wait for the creation of the search documents and the rendered display values
CancellationToken cancellationToken

The cancellation token.
Returns
Task<ContentBatchOperationResult>

The ContentBatchOperationResult.
Implements

WaitForBusinessProcessAndReturnResultWithRequestId(string, TimeSpan?, bool, CancellationToken)

Waits for a business process and returns a ContentBatchOperationWithRequestIdResult.

Declaration
public Task<ContentBatchOperationWithRequestIdResult> WaitForBusinessProcessAndReturnResultWithRequestId(string businessProcessId, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default)
Parameters
string businessProcessId

The business process id.
TimeSpan? timeout

The timeout to wait on the business process.
bool waitSearchDocCreation

Wait for the creation of the search documents and the rendered display values
CancellationToken cancellationToken

The cancellation token.
Returns
Task<ContentBatchOperationWithRequestIdResult>

The ContentBatchOperationWithRequestIdResult.
Implements