Interface ISchemaClient
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface ISchemaClientMethods
CreateAsync(SchemaCreateRequest, TimeSpan?, CancellationToken)
Create schema
Declaration
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.
|
|
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 |
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
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. |
CreateAsync(SchemaDetail, TimeSpan?, CancellationToken)
Creates the given SchemaDetail.
Declaration
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. |
Exceptions
|
ApiException
A server side error occurred. |
CreateManyAsync(SchemaCreateManyRequest, TimeSpan?, CancellationToken)
Creates schemas using the given request.
Declaration
Task<SchemaBatchOperationResult> CreateManyAsync(SchemaCreateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
| SchemaCreateManyRequest request |
|
TimeSpan?
timeout
Maximum time to wait for the underlying business process to complete. |
|
CancellationToken
cancellationToken
The cancellation token. |
Returns
| Task<SchemaBatchOperationResult> |
CreateManyAsync(IEnumerable<SchemaDetail>, bool, TimeSpan?, CancellationToken)
Create the given enumerable of SchemaDetail.
Declaration
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> |
CreateOrUpdateAsync(SchemaDetail, bool, TimeSpan?, CancellationToken)
Creates or updates the given SchemaDetail.
Declaration
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. |
DeleteAsync(string, TimeSpan?, CancellationToken)
Delete schema
Declaration
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.
|
|
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 |
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
Task<bool> ExistsAsync(string schemaId, CancellationToken cancellationToken = default)Parameters
|
string
schemaId
The schema ID. |
|
CancellationToken
cancellationToken
The cancellation token. |
Returns
|
Task<bool>
The task. |
Exceptions
|
ApiException
A server side error occurred. |
FieldExistsAsync(string, string, CancellationToken)
Exists field in schema
Declaration
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 |
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
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. |
GetAggregationFieldsAsync(string, CancellationToken)
Retrieve the fields that can be used in an aggregator on a schema.
Declaration
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 |
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
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 |
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
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 |
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
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 |
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
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 |
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
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 |
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
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 |
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
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 |
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
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 |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
SearchAsync(SchemaSearchRequest, CancellationToken)
Search schemas
Declaration
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 |
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
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.
|
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
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
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 |
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
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. |
Exceptions
|
ApiException
A server side error occurred. |
UpdateAsync(string, SchemaUpdateRequest, TimeSpan?, CancellationToken)
Update schema
Declaration
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.
|
|
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 |
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
Task<SchemaBatchOperationResult> UpdateManyAsync(SchemaUpdateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
| SchemaUpdateManyRequest request |
|
TimeSpan?
timeout
Maximum time to wait for the underlying business process to complete. |
|
CancellationToken
cancellationToken
The cancellation token. |
Returns
| Task<SchemaBatchOperationResult> |
UpdateManyAsync(IEnumerable<SchemaDetail>, bool, TimeSpan?, CancellationToken)
Update the given enumerable of SchemaDetail.
Declaration
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> |
WaitForBusinessProcessAndReturnResult(string, TimeSpan?, CancellationToken)
Waits for a business process and returns a SchemaBatchOperationResult.
Declaration
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> |