Interface IContentClient
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IContentClientMethods
AggregateAsync(ContentAggregationRequest, CancellationToken)
Aggregate contents
Declaration
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 |
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
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 |
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
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> |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
BatchUpdateFieldsByIdsAsync(ContentFieldsBatchUpdateRequest, TimeSpan?, bool, CancellationToken)
Batch update fields - by ids
Declaration
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> |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
CheckContentSchemaChangeAsync(CheckContentSchemaIdChangeRequest, CancellationToken)
Check if given changes of ContentSchemaId are possible without incurring data loss (due to assigned Layers and LayerSchemaIds)
Declaration
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 |
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
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 |
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
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 |
CreateAsync(ContentCreateRequest, IEnumerable<ContentResolveBehavior>, bool?, TimeSpan?, bool?, CancellationToken)
Create content
Declaration
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.
|
|
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<ContentDetail>
The content details |
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
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 |
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
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 |
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
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> |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
CreateVersionDownloadLinkAsync(string, int, CancellationToken)
Get historic version download link
Declaration
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 |
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
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.
|
|
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
Ok |
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
Task DeleteCommentAsync(string id)Parameters
|
string
id
Comment ID |
Returns
|
Task
OK |
DeleteManyAsync(ContentDeleteManyRequest, CancellationToken)
Delete multiple contents
Declaration
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 |
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
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 |
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
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 |
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
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> |
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
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. |
DownloadThumbnailAsync(string, ThumbnailSize, int?, int?, CancellationToken)
Download thumbnail
Declaration
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> |
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
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> |
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
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 |
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
Task<Comment> GetCommentAsync(string id)Parameters
|
string
id
Comment ID |
Returns
|
Task<Comment>
Comment |
GetDownloadLinkAsync(string, CancellationToken)
Resolve download token to Url
Declaration
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 |
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
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 |
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
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. |
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
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. |
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
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 |
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
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 |
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
Task<DownloadLink> GetVersionDownloadLinkAsync(string contentId, int version, CancellationToken cancellationToken = default)Parameters
|
string
contentId
Content ID |
|
int
version
Version number |
|
CancellationToken
cancellationToken
The cancellation token. |
Returns
|
Task<DownloadLink>
Download link |
GetVersionsAsync(string, HistoricVersionSearchRequest, CancellationToken)
Get historic versions
Declaration
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 |
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 |
RepairContentsBatchAsync(ContentRepairBatchRequest, CancellationToken)
Repair contents
Declaration
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 |
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
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 |
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
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.
|
|
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
Ok |
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
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 |
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
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 |
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
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 |
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
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 |
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
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 |
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
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.
|
|
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
Ok |
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
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 |
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
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> |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
UpdateCommentAsync(string, CommentEditable)
Update a comment
Declaration
Task<Comment> UpdateCommentAsync(string id, CommentEditable request)Parameters
|
string
id
Comment ID |
|
CommentEditable
request
What should be updated |
Returns
|
Task<Comment>
Updated comment |
UpdateFileAsync(string, ContentFileUpdateRequest, bool?, CancellationToken)
Update content file
Declaration
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 |
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
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.
|
|
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<ContentDetail>
Content detail |
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
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> |
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 |
UpdatePermissionsAsync(string, ContentPermissionsUpdateRequest, IEnumerable<ContentResolveBehavior>, TimeSpan?, bool?, CancellationToken)
Update content permissions
Declaration
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.
|
|
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<ContentDetail>
Content detail |
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
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 |
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
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> |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
WaitForBusinessProcessAndReturnResult(string, TimeSpan?, bool, CancellationToken)
Waits for a business process and returns a ContentBatchOperationResult.
Declaration
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> |
WaitForBusinessProcessAndReturnResultWithRequestId(string, TimeSpan?, bool, CancellationToken)
Waits for a business process and returns a ContentBatchOperationWithRequestIdResult.
Declaration
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> |