Interface IContentClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface IContentClient
Methods
AggregateAsync(ContentAggregationRequest, CancellationToken)
Aggregate contents
Declaration
Task<ObjectAggregationResult> AggregateAsync(ContentAggregationRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentAggregationRequest
request
Content aggregation request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ObjectAggregationResult>
Object aggregation result |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
AggregateOnChannelAsync(ContentAggregationOnChannelRequest, CancellationToken)
Aggregate contents on channel
Declaration
Task<ObjectAggregationResult> AggregateOnChannelAsync(ContentAggregationOnChannelRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentAggregationOnChannelRequest
request
Content aggregation on channel request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ObjectAggregationResult>
Object aggregation result |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
BatchUpdateFieldsByFilterAsync(ContentFieldsBatchUpdateFilterRequest, Nullable<TimeSpan>, Boolean, CancellationToken)
Batch update fields - by filter
Declaration
Task<ContentBatchOperationResult> BatchUpdateFieldsByFilterAsync(ContentFieldsBatchUpdateFilterRequest updateRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentFieldsBatchUpdateFilterRequest
updateRequest
The metadata update request. |
System.Nullable<TimeSpan>
timeout
Timeout for waiting on the business process. |
System.Boolean
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. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentBatchOperationResult>
The |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |
BatchUpdateFieldsByIdsAsync(ContentFieldsBatchUpdateRequest, Nullable<TimeSpan>, Boolean, CancellationToken)
Batch update fields - by ids
Declaration
Task<ContentBatchOperationResult> BatchUpdateFieldsByIdsAsync(ContentFieldsBatchUpdateRequest updateRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentFieldsBatchUpdateRequest
updateRequest
The metadata update request. |
System.Nullable<TimeSpan>
timeout
Timeout for waiting on the business process. |
System.Boolean
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. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentBatchOperationResult>
The |
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(CancellationToken))
Parameters
CheckContentSchemaIdChangeRequest
request
Changes to check |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.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 |
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(CancellationToken))
Parameters
System.String
id
The ID of the content to replace. |
ContentFileUpdateCheckRequest
request
Content file update request |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.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 |
PictureparkException
Internal server error |
CreateAndAwaitDownloadLinkAsync(ContentDownloadLinkCreateRequest, Nullable<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(CancellationToken))
Parameters
ContentDownloadLinkCreateRequest
request
Content download link request |
System.Nullable<TimeSpan>
timeout
Timeout for operation |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<DownloadLink>
Download link |
CreateAsync(ContentCreateRequest, IEnumerable<ContentResolveBehavior>, Nullable<Boolean>, Nullable<TimeSpan>, Nullable<Boolean>, 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(CancellationToken))
Parameters
ContentCreateRequest
request
Content create request. |
System.Collections.Generic.IEnumerable<ContentResolveBehavior>
resolveBehaviors
List of enums that control which parts of the content are resolved and returned. |
System.Nullable<System.Boolean>
allowMissingDependencies
Allows creating contents that refer to list items or contents that don't exist in the system. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentDetail>
The content details |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
PictureparkValidationException
Validation exception |
BusinessProcessLifeCycleNotHitException
The specified wait timeout exceeded |
CreateCommentAsync(String, CommentCreateRequest, Nullable<TimeSpan>, CancellationToken)
Create comment
Declaration
Task<Comment> CreateCommentAsync(string id, CommentCreateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content ID. |
CommentCreateRequest
request
Comment creation request. |
System.Nullable<System.TimeSpan>
timeout
Operation timeout. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<Comment>
Created comment |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
CreateDownloadLinkAsync(ContentDownloadLinkCreateRequest, CancellationToken)
Create download link
Declaration
Task<BusinessProcess> CreateDownloadLinkAsync(ContentDownloadLinkCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentDownloadLinkCreateRequest
request
Content download link request |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Download link |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
CreateManyAsync(ContentCreateManyRequest, Nullable<TimeSpan>, Boolean, CancellationToken)
Create - many
Declaration
Task<ContentBatchOperationWithRequestIdResult> CreateManyAsync(ContentCreateManyRequest contentCreateManyRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentCreateManyRequest
contentCreateManyRequest
The content create many request. |
System.Nullable<TimeSpan>
timeout
Timeout for waiting on the business process. |
System.Boolean
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. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentBatchOperationWithRequestIdResult>
The |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |
CreateVersionDownloadLinkAsync(String, Int32, CancellationToken)
Get historic version download link
Declaration
Task<string> CreateVersionDownloadLinkAsync(string id, int versionId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content ID. |
System.Int32
versionId
Version ID. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.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 |
PictureparkException
Internal server error |
DeleteAsync(String, Nullable<Boolean>, Nullable<TimeSpan>, Nullable<Boolean>, CancellationToken)
Delete content
Declaration
Task DeleteAsync(string id, bool? forceReferenceRemoval = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The ID of the content to delete. |
System.Nullable<System.Boolean>
forceReferenceRemoval
A value indicating whether references to the content should be removed. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
Ok |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
PictureparkValidationException
Validation exception |
ReferencesUpdateException
Validation prevents deletion of item |
DeleteCommentAsync(String)
Delete a comment
Declaration
Task DeleteCommentAsync(string id)
Parameters
System.String
id
Comment ID |
Returns
System.Threading.Tasks.Task
OK |
DeleteManyAsync(ContentDeleteManyRequest, CancellationToken)
Delete multiple contents
Declaration
Task<BusinessProcess> DeleteManyAsync(ContentDeleteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentDeleteManyRequest
request
Delete many request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteManyByFilterAsync(ContentDeleteManyFilterRequest, CancellationToken)
Delete multiple contents - by filter
Declaration
Task<BusinessProcess> DeleteManyByFilterAsync(ContentDeleteManyFilterRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentDeleteManyFilterRequest
request
Delete many by filter request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteVersionAsync(String, Int32, CancellationToken)
Delete historic version
Declaration
Task DeleteVersionAsync(string id, int versionId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content ID. |
System.Int32
versionId
Version ID. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DownloadAsync(String, String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)
Download content
Declaration
Task<FileResponse> DownloadAsync(string contentId, string outputFormatId, int? width = null, int? height = null, string range = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
contentId
The content ID. |
System.String
outputFormatId
The output format ID. |
System.Nullable<System.Int32>
width
Optional width in pixels to resize image. |
System.Nullable<System.Int32>
height
Optional height in pixels to resize image. |
System.String
range
The range of bytes to download (http range header): bytes={from}-{to} (e.g. bytes=0-100000). |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<FileResponse>
|
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DownloadFilesAsync(ContentSearchResult, String, Boolean, Int32, String, String, Boolean, 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(CancellationToken))
Parameters
ContentSearchResult
contents
The files to download. |
System.String
exportDirectory
The directory to store the downloaded files. |
System.Boolean
overwriteIfExists
Specifies whether to overwrite files. |
System.Int32
concurrentDownloads
Specifies the number of concurrent downloads. |
System.String
outputFormat
The output format name (e.g. 'Original'). |
System.String
outputExtension
The expected output file extension. |
System.Boolean
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. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task
The task. |
DownloadThumbnailAsync(String, ThumbnailSize, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Download thumbnail
Declaration
Task<FileResponse> DownloadThumbnailAsync(string id, ThumbnailSize size, int? width = null, int? height = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The content ID. |
ThumbnailSize
size
Thumbnail size. Either small, medium or large. |
System.Nullable<System.Int32>
width
Optional width in pixels to resize image. |
System.Nullable<System.Int32>
height
Optional height in pixels to resize image. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<FileResponse>
|
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
EditOutputAsync(String, String, String, CancellationToken)
Edit output
Declaration
Task<FileResponse> EditOutputAsync(string contentId, string outputFormatId, string conversionPreset, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
contentId
The content ID. |
System.String
outputFormatId
The output format ID. |
System.String
conversionPreset
The conversion preset. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<FileResponse>
|
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetAsync(String, IEnumerable<ContentResolveBehavior>, CancellationToken)
Get content
Declaration
Task<ContentDetail> GetAsync(string id, IEnumerable<ContentResolveBehavior> resolveBehaviors = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The content ID. |
System.Collections.Generic.IEnumerable<ContentResolveBehavior>
resolveBehaviors
List of enums that control which parts of the content are resolved and returned. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentDetail>
Content detail |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
ContentNotFoundException
Content not found |
GetCommentAsync(String)
Get a comment
Declaration
Task<Comment> GetCommentAsync(string id)
Parameters
System.String
id
Comment ID |
Returns
System.Threading.Tasks.Task<Comment>
Comment |
GetDownloadLinkAsync(String, CancellationToken)
Resolve download token to Url
Declaration
Task<DownloadLink> GetDownloadLinkAsync(string token, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
token
Token |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<DownloadLink>
Download link information |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
List of content IDs |
System.Collections.Generic.IEnumerable<ContentResolveBehavior>
resolveBehaviors
List of enums that control which parts of the content are resolved and returned. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<ContentDetail>>
List of Content detail |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.String
id
ID of content. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<OutputResolveResult>>
Array of Result of output resolution. |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetOutputsManyAsync(OutputResolveManyRequest, CancellationToken)
Get outputs
Declaration
Task<ICollection<OutputResolveResult>> GetOutputsManyAsync(OutputResolveManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputResolveManyRequest
request
Output resolve many request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<OutputResolveResult>>
Array of Result of output resolution. |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetReferencesAsync(String, ContentReferencesRequest, CancellationToken)
Get content references
Declaration
Task<ContentReferencesResult> GetReferencesAsync(string id, ContentReferencesRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The content ID whose references to retrieve. |
ContentReferencesRequest
request
Content references request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentReferencesResult>
ContentReferencesResult |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetReferencesManyAsync(ContentManyReferencesRequest, CancellationToken)
Get many content references
Declaration
Task<ContentReferencesResult> GetReferencesManyAsync(ContentManyReferencesRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentManyReferencesRequest
request
Content many references request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentReferencesResult>
Content references result |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetVersionDownloadLinkAsync(String, Int32, CancellationToken)
Creates a download link for a specific content historic version
Declaration
Task<DownloadLink> GetVersionDownloadLinkAsync(string contentId, int version, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
contentId
Content ID |
System.Int32
version
Version number |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<DownloadLink>
Download link |
GetVersionsAsync(String, HistoricVersionSearchRequest, CancellationToken)
Get historic versions
Declaration
Task<HistoricVersionSearchResult> GetVersionsAsync(string id, HistoricVersionSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content ID. |
HistoricVersionSearchRequest
request
Request allowing for paging |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<HistoricVersionSearchResult>
Historic versions |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
RepairContentsBatchAsync(ContentRepairBatchRequest, CancellationToken)
Repair contents
Declaration
Task<BusinessProcess> RepairContentsBatchAsync(ContentRepairBatchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentRepairBatchRequest
request
Content repair request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
RepairContentsByFilterAsync(ContentRepairByFilterRequest, CancellationToken)
Repair contents by filter
Declaration
Task<BusinessProcess> RepairContentsByFilterAsync(ContentRepairByFilterRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentRepairByFilterRequest
request
Content repair request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
RestoreAsync(String, Nullable<Boolean>, Nullable<TimeSpan>, Nullable<Boolean>, CancellationToken)
Restore content
Declaration
Task RestoreAsync(string id, bool? allowMissingDependencies = null, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The content ID. |
System.Nullable<System.Boolean>
allowMissingDependencies
Allows restoring contents that refer to list items or contents that don't exist in the system. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
Ok |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
RestoreManyAsync(ContentRestoreManyRequest, CancellationToken)
Restore multiple contents
Declaration
Task<BusinessProcess> RestoreManyAsync(ContentRestoreManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentRestoreManyRequest
request
Content restore many request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SearchAsync(ContentSearchRequest, CancellationToken)
Search contents
Declaration
Task<ContentSearchResult> SearchAsync(ContentSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentSearchRequest
request
Content search request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentSearchResult>
Result for content search operation |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SearchCommentsAsync(String, CommentSearchRequest, CancellationToken)
Search comments
Declaration
Task<CommentSearchResult> SearchCommentsAsync(string id, CommentSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Content ID. |
CommentSearchRequest
request
Search request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.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 |
PictureparkException
Internal server error |
TransferOwnershipAsync(String, ContentOwnershipTransferRequest, Nullable<TimeSpan>, Nullable<Boolean>, CancellationToken)
Transfer content ownership
Declaration
Task TransferOwnershipAsync(string id, ContentOwnershipTransferRequest request, TimeSpan? timeout = null, bool? waitSearchDocCreation = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The content ID. |
ContentOwnershipTransferRequest
request
Content ownership transfer request. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
Ok |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
TransferOwnershipManyAsync(ContentOwnershipTransferManyRequest, Nullable<TimeSpan>, Boolean, CancellationToken)
Transfer ownership - many
Declaration
Task<ContentBatchOperationResult> TransferOwnershipManyAsync(ContentOwnershipTransferManyRequest contentOwnershipTransferManyRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentOwnershipTransferManyRequest
contentOwnershipTransferManyRequest
The content ownership transfer many request. |
System.Nullable<TimeSpan>
timeout
Timeout for waiting on the business process. |
System.Boolean
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. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentBatchOperationResult>
The |
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
System.String
id
Comment ID |
CommentEditable
request
What should be updated |
Returns
System.Threading.Tasks.Task<Comment>
Updated comment |
UpdateFileAsync(String, ContentFileUpdateRequest, CancellationToken)
Update content file
Declaration
Task<BusinessProcess> UpdateFileAsync(string id, ContentFileUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The ID of the content to replace. |
ContentFileUpdateRequest
request
Content file update request |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
UpdateMetadataAsync(String, ContentMetadataUpdateRequest, IEnumerable<ContentResolveBehavior>, Nullable<Boolean>, Nullable<TimeSpan>, Nullable<Boolean>, 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(CancellationToken))
Parameters
System.String
id
The content ID. |
ContentMetadataUpdateRequest
request
Content metadata update request. |
System.Collections.Generic.IEnumerable<ContentResolveBehavior>
resolveBehaviors
List of enums that control which parts of the content are resolved and returned. |
System.Nullable<System.Boolean>
allowMissingDependencies
Allows storing references to list items or contents that don't exist in the system. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentDetail>
Content detail |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
PictureparkValidationException
Validation exception |
BusinessProcessLifeCycleNotHitException
The specified wait timeout exceeded |
UpdateMetadataManyAsync(ContentMetadataUpdateManyRequest, Nullable<TimeSpan>, Boolean, CancellationToken)
Update metadata - many
Declaration
Task<ContentBatchOperationResult> UpdateMetadataManyAsync(ContentMetadataUpdateManyRequest updateRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentMetadataUpdateManyRequest
updateRequest
The metadata update requests. |
System.Nullable<TimeSpan>
timeout
Timeout for waiting on the business process. |
System.Boolean
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. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentBatchOperationResult>
The |
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>, Nullable<TimeSpan>, Nullable<Boolean>, 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(CancellationToken))
Parameters
System.String
id
The content ID. |
ContentPermissionsUpdateRequest
request
Content permissions update request. |
System.Collections.Generic.IEnumerable<ContentResolveBehavior>
resolveBehaviors
List of enums that control which parts of the content are resolved and returned. |
System.Nullable<System.TimeSpan>
timeout
Maximum time to wait for the operation to complete. If timeout is exceeded, the operation is not aborted but continues anyhow.
|
System.Nullable<System.Boolean>
waitSearchDocCreation
Wait for the creation of the search document and the rendered display values.
|
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentDetail>
Content detail |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
PictureparkValidationException
Validation exception |
BusinessProcessLifeCycleNotHitException
The specified wait timeout exceeded |
UpdatePermissionsManyAsync(ContentPermissionsUpdateManyRequest, Nullable<TimeSpan>, Boolean, CancellationToken)
Update permissions - many
Declaration
Task<ContentBatchOperationResult> UpdatePermissionsManyAsync(ContentPermissionsUpdateManyRequest updateManyRequest, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ContentPermissionsUpdateManyRequest
updateManyRequest
The permissions update many request. |
System.Nullable<TimeSpan>
timeout
Timeout for waiting on the business process. |
System.Boolean
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. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<ContentBatchOperationResult>
The |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |
WaitForBusinessProcessAndReturnResult(String, Nullable<TimeSpan>, Boolean, CancellationToken)
Waits for a business process and returns a
Declaration
Task<ContentBatchOperationResult> WaitForBusinessProcessAndReturnResult(string businessProcessId, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
businessProcessId
The business process id. |
System.Nullable<TimeSpan>
timeout
The timeout to wait on the business process. |
System.Boolean
waitSearchDocCreation
Wait for the creation of the search documents and the rendered display values |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<ContentBatchOperationResult>
The |
WaitForBusinessProcessAndReturnResultWithRequestId(String, Nullable<TimeSpan>, Boolean, CancellationToken)
Waits for a business process and returns a
Declaration
Task<ContentBatchOperationWithRequestIdResult> WaitForBusinessProcessAndReturnResultWithRequestId(string businessProcessId, TimeSpan? timeout = null, bool waitSearchDocCreation = true, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
businessProcessId
The business process id. |
System.Nullable<TimeSpan>
timeout
The timeout to wait on the business process. |
System.Boolean
waitSearchDocCreation
Wait for the creation of the search documents and the rendered display values |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<ContentBatchOperationWithRequestIdResult>
The |