Interface IOutputFormatClient
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IOutputFormatClientMethods
CreateAsync(OutputFormat, TimeSpan?, CancellationToken)
Create output format
Declaration
Task<OutputFormatOperationResult> CreateAsync(OutputFormat request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
OutputFormat
request
The request containing information needed to create new output format. |
|
TimeSpan?
timeout
Timeout for business process completion |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<OutputFormatOperationResult>
Output format |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
CreateManyAsync(OutputFormatCreateManyRequest, TimeSpan?, CancellationToken)
Create multiple output formats
Declaration
Task<OutputFormatBatchOperationResult> CreateManyAsync(OutputFormatCreateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
OutputFormatCreateManyRequest
request
The request containing information needed to create new output formats. |
|
TimeSpan?
timeout
Timeout for business process completion |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<OutputFormatBatchOperationResult>
Business process |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
DeleteAsync(string, TimeSpan?, CancellationToken)
Delete output format
Declaration
Task<OutputFormatDeleteResult> DeleteAsync(string id, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
string
id
ID of the output format that should be deleted. |
|
TimeSpan?
timeout
Timeout for business process completion |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<OutputFormatDeleteResult>
Business process |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
DeleteManyAsync(OutputFormatDeleteManyRequest, TimeSpan?, CancellationToken)
Delete multiple output formats
Declaration
Task<OutputFormatBatchOperationResult> DeleteManyAsync(OutputFormatDeleteManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
OutputFormatDeleteManyRequest
request
The request with output formats IDs to delete. |
|
TimeSpan?
timeout
Timeout for business process completion |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<OutputFormatBatchOperationResult>
Business process |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
GetAllAsync(CancellationToken)
Declaration
Task<ICollection<OutputFormatDetail>> GetAllAsync(CancellationToken cancellationToken = default)Parameters
| CancellationToken cancellationToken |
Returns
| Task<ICollection<OutputFormatDetail>> |
GetAsync(string, CancellationToken)
Get output format
Declaration
Task<OutputFormatDetail> GetAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
Output format ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<OutputFormatDetail>
Represents an output format. |
Remarks
Gets the output format by the output format ID.
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>, CancellationToken)
Get multiple output formats
Declaration
Task<ICollection<OutputFormatDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)Parameters
|
IEnumerable<string>
ids
Output format IDs to get information about. If this is omitted, all output formats in the system will be returned. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<OutputFormatDetail>>
Array of Represents an output format. |
Remarks
Gets multiple output format details by the output format IDs. Can fetch maximum of 100 output formats at once.
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 |
|
RequestSizeLimitExceededException
List of IDs exceeded maximum size |
RenderFormatPreviewAsync(OutputFormatRenderPreviewRequest, CancellationToken)
Render output format preview
Declaration
Task<FileResponse> RenderFormatPreviewAsync(OutputFormatRenderPreviewRequest request, CancellationToken cancellationToken = default)Parameters
|
OutputFormatRenderPreviewRequest
request
Information about the OutputFormat as well as which Content to use for the preview. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<FileResponse>
Rendered file |
Remarks
Request rendering of the given OutputFormat for a given 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 |
SetDownloadFileNamePatternsAsync(string, IDictionary<string, string>, CancellationToken)
Sets the download file name patterns for an output format
Declaration
Task<BusinessProcess> SetDownloadFileNamePatternsAsync(string id, IDictionary<string, string> patterns, CancellationToken cancellationToken = default)Parameters
|
string
id
ID of the output format. |
|
IDictionary<string, string>
patterns
Dictionary containing patterns per metadata language.
|
|
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
This is allowed for both static and dynamic formats. 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 |
SetDownloadFileNamePatternsManyAsync(OutputFormatDownloadFileNamePatternUpdateManyRequest, CancellationToken)
Sets the download file name patterns for multiple output formats
Declaration
Task<BusinessProcess> SetDownloadFileNamePatternsManyAsync(OutputFormatDownloadFileNamePatternUpdateManyRequest request, CancellationToken cancellationToken = default)Parameters
|
OutputFormatDownloadFileNamePatternUpdateManyRequest
request
The request containing the patterns for each output format. |
|
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
This is allowed for both static and dynamic formats. 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 |
SetPermissionAsync(string, OutputFormatSetPermissionRequest, CancellationToken)
Updates permission-related settings for an output format
Declaration
Task<BusinessProcess> SetPermissionAsync(string id, OutputFormatSetPermissionRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
ID of the output format. |
|
OutputFormatSetPermissionRequest
request
The request containing the settings for the output format. |
|
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
This is allowed for both static and dynamic formats. 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 |
SetPermissionManyAsync(OutputFormatSetPermissionManyRequest, CancellationToken)
Updates permission-related settings for multiple output formats
Declaration
Task<BusinessProcess> SetPermissionManyAsync(OutputFormatSetPermissionManyRequest request, CancellationToken cancellationToken = default)Parameters
|
OutputFormatSetPermissionManyRequest
request
The request containing the state changes for each output format. |
|
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
This is allowed for both static and dynamic formats. 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 |
SetXmpWritebackStateAsync(string, OutputFormatSetXmpWritebackStateRequest, CancellationToken)
Enables or disables XMP writeback for an output format
Declaration
Task<BusinessProcess> SetXmpWritebackStateAsync(string id, OutputFormatSetXmpWritebackStateRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
ID of the output format. |
|
OutputFormatSetXmpWritebackStateRequest
request
The request containing the state to be set for the output format. |
|
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
This is allowed for both static and dynamic formats.
However, enabling XMP writeback for Thumbnail formats or temporary formats is not allowed. 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 |
SetXmpWritebackStateManyAsync(OutputFormatSetXmpWritebackStateManyRequest, CancellationToken)
Enables or disables XMP writeback for multiple output formats
Declaration
Task<BusinessProcess> SetXmpWritebackStateManyAsync(OutputFormatSetXmpWritebackStateManyRequest request, CancellationToken cancellationToken = default)Parameters
|
OutputFormatSetXmpWritebackStateManyRequest
request
The request containing the state changes for each output format. |
|
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
This is allowed for both static and dynamic formats.
However, enabling XMP writeback for Thumbnail formats or temporary formats is not allowed. 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 |
UpdateAsync(string, OutputFormatEditable, TimeSpan?, CancellationToken)
Update output format
Declaration
Task<OutputFormatOperationResult> UpdateAsync(string id, OutputFormatEditable request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
string
id
ID of output format to update |
|
OutputFormatEditable
request
The request containing information needed to update the output format. |
|
TimeSpan?
timeout
Timeout for business process completion |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<OutputFormatOperationResult>
Business process |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |
UpdateManyAsync(OutputFormatUpdateManyRequest, TimeSpan?, CancellationToken)
Update multiple output formats
Declaration
Task<OutputFormatBatchOperationResult> UpdateManyAsync(OutputFormatUpdateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
OutputFormatUpdateManyRequest
request
The request containing information needed to update the output format. |
|
TimeSpan?
timeout
Timeout for business process completion |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<OutputFormatBatchOperationResult>
Business process |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkValidationException
Validation exception |