Class SchemaClient

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

Constructors

SchemaClient(IInfoClient, IBusinessProcessClient, IPictureparkServiceSettings, HttpClient)

Declaration
public SchemaClient(IInfoClient infoClient, IBusinessProcessClient businessProcessClient, IPictureparkServiceSettings settings, HttpClient httpClient)
Parameters
IInfoClient infoClient

IBusinessProcessClient businessProcessClient

IPictureparkServiceSettings settings

HttpClient httpClient

SchemaClient(IPictureparkServiceSettings, HttpClient)

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

HttpClient httpClient

Properties

JsonSerializerSettings

Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
JsonSerializerSettings

ReadResponseAsString

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

Methods

CreateAsync(SchemaCreateRequest, TimeSpan?, CancellationToken)

Create schema

Declaration
public virtual Task<SchemaCreateResult> CreateAsync(SchemaCreateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
SchemaCreateRequest request

The schema create request.
TimeSpan? timeout

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

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

Schema create result, containing the created schema
Implements
Remarks

Create a new schema.

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
DuplicateSchemaException

Schema with this name already exists
PictureparkArgumentNullException

Argument must not be null
SchemaValidationException

The validation exception of schema creation

CreateAsync(SchemaDetail, bool, TimeSpan?, CancellationToken)

Creates the given SchemaDetail.

Declaration
public Task<SchemaCreateResult> CreateAsync(SchemaDetail schemaDetail, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
SchemaDetail schemaDetail

The schema detail.
bool enableForBinaryFiles

Specifies whether to enable the schema for binary files.
TimeSpan? timeout

Maximum time to wait for the operation to complete.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<SchemaCreateResult>

The task.
Implements

CreateAsync(SchemaDetail, TimeSpan?, CancellationToken)

Creates the given SchemaDetail.

Declaration
public Task<SchemaCreateResult> CreateAsync(SchemaDetail schemaDetail, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
SchemaDetail schemaDetail

The schema detail.
TimeSpan? timeout

Maximum time to wait for the operation to complete.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<SchemaCreateResult>

The task.
Implements
Exceptions
ApiException

A server side error occurred.

CreateManyAsync(SchemaCreateManyRequest, TimeSpan?, CancellationToken)

Creates schemas using the given request.

Declaration
public Task<SchemaBatchOperationResult> CreateManyAsync(SchemaCreateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
SchemaCreateManyRequest request

The SchemaCreateManyRequest.
TimeSpan? timeout

Maximum time to wait for the underlying business process to complete.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<SchemaBatchOperationResult>

The SchemaBatchOperationResult.
Implements

CreateManyAsync(IEnumerable<SchemaDetail>, bool, TimeSpan?, CancellationToken)

Create the given enumerable of SchemaDetail.

Declaration
public Task<SchemaBatchOperationResult> CreateManyAsync(IEnumerable<SchemaDetail> schemaDetails, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
IEnumerable<SchemaDetail> schemaDetails

The schema details.
bool enableForBinaryFiles

Specifies whether to enable the schemas for binary files.
TimeSpan? timeout

Maximum time to wait for the underlying business process to complete.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<SchemaBatchOperationResult>

The SchemaBatchOperationResult.
Implements

CreateManyCoreAsync(SchemaCreateManyRequest, CancellationToken)

Create multiple schemas

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

The schema create many request.
CancellationToken cancellationToken

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

BusinessProcess which can be awaited
Remarks

Creates new schemas. 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.
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
DuplicateSchemaException

One or more schemas in the request already exist
PictureparkArgumentNullException

Argument must not be null
SchemaValidationException

One or more schemas failed to validate

CreateOrUpdateAsync(SchemaDetail, bool, TimeSpan?, CancellationToken)

Creates or updates the given SchemaDetail.

Declaration
public Task<ISchemaResult> CreateOrUpdateAsync(SchemaDetail schemaDetail, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
SchemaDetail schemaDetail

The schema detail.
bool enableForBinaryFiles

Specifies whether to enable the schema for binary files.
TimeSpan? timeout

Maximum time to wait for the operation to complete.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<ISchemaResult>

The task.
Implements

DeleteAsync(string, TimeSpan?, CancellationToken)

Delete schema

Declaration
public virtual Task<SchemaDeleteResult> DeleteAsync(string id, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
string id

The schema ID.
TimeSpan? timeout

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

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

Schema delete result
Implements
Remarks

Deletes an existing schema.
Depending on how much the schema is referenced, the operation can take a lot of time.

Exceptions
ApiException

A server side error occurred.
PictureparkForbiddenException

Forbidden
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
PictureparkArgumentNullException

Argument must not be null
SchemaInUseException

Schema is used in other entities and cannot be deleted
PictureparkNotFoundException

Entity not found
SchemaNotFoundException

Schema with this ID could not be found

ExistsAsync(string, CancellationToken)

Checks whether a schema ID already exists.

Declaration
public Task<bool> ExistsAsync(string schemaId, CancellationToken cancellationToken = default)
Parameters
string schemaId

The schema ID.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<bool>

The task.
Implements
Exceptions
ApiException

A server side error occurred.

ExistsCoreAsync(string, CancellationToken)

Exists schema

Declaration
protected virtual Task<SchemaExistsResponse> ExistsCoreAsync(string id, CancellationToken cancellationToken = default)
Parameters
string id

The schema ID.
CancellationToken cancellationToken

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

Schema Exists response
Remarks

Checks if the schema already exists.

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

FieldExistsAsync(string, string, CancellationToken)

Exists field in schema

Declaration
public virtual Task<FieldExistsResponse> FieldExistsAsync(string schemaId, string fieldId, CancellationToken cancellationToken = default)
Parameters
string schemaId

The schema ID.
string fieldId

The field ID.
CancellationToken cancellationToken

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

Field Exists response
Implements
Remarks

Checks if the field in the specified schema already exists.
Also returns a flag indicating if the field was previously deleted and the ID can therefore not be reused.

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

GenerateSchemasAsync(Type, IEnumerable<SchemaDetail>, bool, CancellationToken)

Generates the SchemaDetails for the given type and the referenced types.

Declaration
public Task<ICollection<SchemaDetail>> GenerateSchemasAsync(Type type, IEnumerable<SchemaDetail> schemaDetails = null, bool generateDependencySchema = true, CancellationToken cancellationToken = default)
Parameters
Type type

The type.
IEnumerable<SchemaDetail> schemaDetails

The existing schema details.
bool generateDependencySchema

Specifies whether to generate dependent schemas.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<ICollection<SchemaDetail>>

The collection of schema details.
Implements
Remarks

Note: When generating multiple schemas or schemas for types with dependencies, please use the CreateMany method to create them at the server to avoid dependency problems.

GetAggregationFieldsAsync(string, CancellationToken)

Retrieve the fields that can be used in an aggregator on a schema.

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

The ID of the schema.
CancellationToken cancellationToken

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

The list of fields
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetAggregationFieldsManyAsync(IEnumerable<string>, CancellationToken)

Retrieve the fields that can be used in an aggregator on multiple schemas.

Declaration
public virtual Task<ICollection<FieldInfo>> GetAggregationFieldsManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)
Parameters
IEnumerable<string> ids

The IDs of the schemas.
CancellationToken cancellationToken

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

The list of fields
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetAsync(string, CancellationToken)

Get schema

Declaration
public virtual Task<SchemaDetail> GetAsync(string id, CancellationToken cancellationToken = default)
Parameters
string id

The schema ID.
CancellationToken cancellationToken

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

Schema detail
Implements
Remarks

Gets the schema detail by schema 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
SchemaNotFoundException

Requested schema could not be found

GetFilterFieldsAsync(string, CancellationToken)

Retrieve the fields that can be used in a filter on a schema.

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

The ID of the schema.
CancellationToken cancellationToken

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

The list of fields
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetFilterFieldsManyAsync(IEnumerable<string>, CancellationToken)

Retrieve the fields that can be used in a filter on multiple schemas.

Declaration
public virtual Task<ICollection<FieldInfo>> GetFilterFieldsManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)
Parameters
IEnumerable<string> ids

The IDs of the schemas.
CancellationToken cancellationToken

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

The list of fields
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetManyAsync(IEnumerable<string>, CancellationToken)

Get multiple schemas

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

Comma separated list of schema IDs.
CancellationToken cancellationToken

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

List of schema details
Implements
Remarks

Gets multiple schema details by given schema IDs.
Can fetch 100 schema details at most.

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

GetManyReferencedAsync(IEnumerable<string>, bool?, CancellationToken)

Gets all schemas referenced by the schemas specified in ids

Declaration
public virtual Task<ICollection<SchemaDetail>> GetManyReferencedAsync(IEnumerable<string> ids = null, bool? sourceSchema = null, CancellationToken cancellationToken = default)
Parameters
IEnumerable<string> ids

The schema IDs.
bool? sourceSchema

If true, the returned schemas contain also the source schemas for which the referenced schemas were requested. If false, the source schemas are not returned (default behavior).
CancellationToken cancellationToken

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

Referenced schema details
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

GetReferencedAsync(string, bool?, CancellationToken)

Gets all schemas referenced by the schema specified in id

Declaration
public virtual Task<ICollection<SchemaDetail>> GetReferencedAsync(string id, bool? sourceSchema = null, CancellationToken cancellationToken = default)
Parameters
string id

The schema ID.
bool? sourceSchema

If true, the returned schemas contain also the source schema for which the referenced schemas were requested. If false, the source schema is not returned (default behavior).
CancellationToken cancellationToken

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

Referenced schema details
Implements
Remarks

Can fetch referencing schemas for 100 schemas at most.

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

GetSortFieldsBySchemaTypesAsync(IEnumerable<SchemaType>, CancellationToken)

Retrieve the fields that can be used for sorting.

Declaration
public virtual Task<ICollection<SortFieldInfo>> GetSortFieldsBySchemaTypesAsync(IEnumerable<SchemaType> schemaTypes = null, CancellationToken cancellationToken = default)
Parameters
IEnumerable<SchemaType> schemaTypes

Schema types to include in search
CancellationToken cancellationToken

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

The list of fields
Implements
Exceptions
ApiException

A server side error occurred.
PictureparkValidationException

Validation exception
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error

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

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

IReadOnlyDictionary<string, IEnumerable<string>> headers

CancellationToken cancellationToken

Returns
Task<SchemaClient.ObjectResponseResult<T>>

Type Parameters
T

SearchAsync(SchemaSearchRequest, CancellationToken)

Search schemas

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

The schema search request.
CancellationToken cancellationToken

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

Schema search result
Implements
Remarks

Searches schemas 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

TransferOwnershipAsync(string, SchemaOwnershipTransferRequest, TimeSpan?, CancellationToken)

Transfer ownership

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

The schema ID.
SchemaOwnershipTransferRequest request

Request detailing which user to transfer to.
TimeSpan? timeout

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

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

OK
Implements
Remarks

Transfer ownership of the schema specified in 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

TransferOwnershipManyAsync(SchemaOwnershipTransferManyRequest, CancellationToken)

Transfer ownership of multiple schemas

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

Schema ownership transfer many request.
CancellationToken cancellationToken

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

Business process
Implements
Remarks

Transfers ownership of multiple schemas to specified user. The target user must have the ManageSchemas user right.
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

UpdateAsync(SchemaDetail, bool, TimeSpan?, CancellationToken)

Updates the given SchemaDetail.

Declaration
public Task<SchemaUpdateResult> UpdateAsync(SchemaDetail schemaDetail, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
SchemaDetail schemaDetail

The schema detail.
bool enableForBinaryFiles

Specifies whether to enable the schema for binary files.
TimeSpan? timeout

Maximum time to wait for the operation to complete.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<SchemaUpdateResult>

The task.
Implements
Exceptions
ApiException

A server side error occurred.

UpdateAsync(string, SchemaUpdateRequest, TimeSpan?, CancellationToken)

Update schema

Declaration
public virtual Task<SchemaUpdateResult> UpdateAsync(string id, SchemaUpdateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
string id

The schema ID.
SchemaUpdateRequest request

The schema update request.
TimeSpan? timeout

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

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

Schema update result, containing the updated schema
Implements
Remarks

Updates an existing schema.
Depending on how much the schema is referenced by existing data, the operation can take a lot of time.

Exceptions
ApiException

A server side error occurred.
PictureparkForbiddenException

Forbidden
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
PictureparkArgumentNullException

Argument must not be null
SchemaValidationException

The validation exception of schema update
PictureparkNotFoundException

Entity not found
SchemaNotFoundException

Schema with this ID could not be found

UpdateManyAsync(SchemaUpdateManyRequest, TimeSpan?, CancellationToken)

Updates schemas using the given request.

Declaration
public Task<SchemaBatchOperationResult> UpdateManyAsync(SchemaUpdateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
SchemaUpdateManyRequest request

The SchemaUpdateManyRequest.
TimeSpan? timeout

Maximum time to wait for the underlying business process to complete.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<SchemaBatchOperationResult>

The SchemaBatchOperationResult.
Implements

UpdateManyAsync(IEnumerable<SchemaDetail>, bool, TimeSpan?, CancellationToken)

Update the given enumerable of SchemaDetail.

Declaration
public Task<SchemaBatchOperationResult> UpdateManyAsync(IEnumerable<SchemaDetail> schemaDetails, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
Parameters
IEnumerable<SchemaDetail> schemaDetails

The schema details.
bool enableForBinaryFiles

Specifies whether to enable the schemas for binary files.
TimeSpan? timeout

Maximum time to wait for the underlying business process to complete.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<SchemaBatchOperationResult>

The SchemaBatchOperationResult.
Implements

UpdateManyCoreAsync(SchemaUpdateManyRequest, CancellationToken)

Update multiple schema

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

Request to update multiple schemas.
CancellationToken cancellationToken

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

BusinessProcess which can be awaited
Remarks

Updates multiple existing schemas.
Prefer this whenever you have updates for multiple schemas. 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.
PictureparkForbiddenException

Forbidden
PictureparkNotFoundException

Entity not found
PictureparkConflictException

Version conflict
PictureparkTooManyRequestsException

Too many requests
PictureparkException

Internal server error
PictureparkValidationException

Validation exception
PictureparkArgumentNullException

Argument must not be null

WaitForBusinessProcessAndReturnResult(string, TimeSpan?, CancellationToken)

Waits for a business process and returns a SchemaBatchOperationResult.

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

The business process id.
TimeSpan? timeout

The timeout to wait on the business process.
CancellationToken cancellationToken

The cancellation token.
Returns
Task<SchemaBatchOperationResult>

The SchemaBatchOperationResult.
Implements