Interface ISchemaClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface ISchemaClient
Methods
CreateAsync(SchemaCreateRequest, Nullable<TimeSpan>, CancellationToken)
Create schema
Declaration
Task<SchemaCreateResult> CreateAsync(SchemaCreateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaCreateRequest
request
The schema create 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.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<SchemaCreateResult>
Schema create result, containing the created schema |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
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, Boolean, Nullable<TimeSpan>, CancellationToken)
Creates the given SchemaDetail.
Declaration
Task<SchemaCreateResult> CreateAsync(SchemaDetail schemaDetail, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaDetail
schemaDetail
The schema detail. |
System.Boolean
enableForBinaryFiles
Specifies whether to enable the schema for binary files. |
System.Nullable<TimeSpan>
timeout
Maximum time to wait for the operation to complete. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<SchemaCreateResult>
The task. |
CreateAsync(SchemaDetail, Nullable<TimeSpan>, CancellationToken)
Creates the given SchemaDetail.
Declaration
Task<SchemaCreateResult> CreateAsync(SchemaDetail schemaDetail, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaDetail
schemaDetail
The schema detail. |
System.Nullable<TimeSpan>
timeout
Maximum time to wait for the operation to complete. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<SchemaCreateResult>
The task. |
Exceptions
ApiException
A server side error occurred. |
CreateManyAsync(IEnumerable<SchemaDetail>, Boolean, Nullable<TimeSpan>, CancellationToken)
Create the given enumerable of SchemaDetail.
Declaration
Task<SchemaBatchOperationResult> CreateManyAsync(IEnumerable<SchemaDetail> schemaDetails, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
IEnumerable<SchemaDetail>
schemaDetails
The schema details. |
System.Boolean
enableForBinaryFiles
Specifies whether to enable the schemas for binary files. |
System.Nullable<TimeSpan>
timeout
Maximum time to wait for the underlying business process to complete. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<SchemaBatchOperationResult>
The |
CreateManyAsync(SchemaCreateManyRequest, Nullable<TimeSpan>, CancellationToken)
Creates schemas using the given request.
Declaration
Task<SchemaBatchOperationResult> CreateManyAsync(SchemaCreateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaCreateManyRequest request |
System.Nullable<TimeSpan>
timeout
Maximum time to wait for the underlying business process to complete. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<SchemaBatchOperationResult>
The |
CreateOrUpdateAsync(SchemaDetail, Boolean, Nullable<TimeSpan>, CancellationToken)
Creates or updates the given SchemaDetail.
Declaration
Task<ISchemaResult> CreateOrUpdateAsync(SchemaDetail schemaDetail, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaDetail
schemaDetail
The schema detail. |
System.Boolean
enableForBinaryFiles
Specifies whether to enable the schema for binary files. |
System.Nullable<TimeSpan>
timeout
Maximum time to wait for the operation to complete. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<ISchemaResult>
The task. |
DeleteAsync(String, Nullable<TimeSpan>, CancellationToken)
Delete schema
Declaration
Task<SchemaDeleteResult> DeleteAsync(string id, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The schema ID. |
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.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<SchemaDeleteResult>
Schema delete result |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.String
schemaId
The schema ID. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<System.Boolean>
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(CancellationToken))
Parameters
System.String
schemaId
The schema ID. |
System.String
fieldId
The field 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<FieldExistsResponse>
Field Exists response |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GenerateSchemasAsync(Type, IEnumerable<SchemaDetail>, Boolean, 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(CancellationToken))
Parameters
Type
type
The type. |
IEnumerable<SchemaDetail>
schemaDetails
The existing schema details. |
System.Boolean
generateDependencySchema
Specifies whether to generate dependent schemas. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.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(CancellationToken))
Parameters
System.String
id
The ID of the schema. |
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<FieldInfo>>
The list of fields |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
The IDs of the schemas. |
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<FieldInfo>>
The list of fields |
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, CancellationToken)
Get schema
Declaration
Task<SchemaDetail> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The schema 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<SchemaDetail>
Schema detail |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.String
id
The ID of the schema. |
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<FieldInfo>>
The list of fields |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
The IDs of the schemas. |
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<FieldInfo>>
The list of fields |
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>, CancellationToken)
Get multiple schemas
Declaration
Task<ICollection<SchemaDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
Comma separated list of schema IDs. |
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<SchemaDetail>>
List of schema details |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
PictureparkValidationException
Validation exception |
RequestSizeLimitExceededException
List of IDs exceeded maximum size |
GetManyReferencedAsync(IEnumerable<String>, Nullable<Boolean>, 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(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
The schema IDs. |
System.Nullable<System.Boolean>
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). |
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<SchemaDetail>>
Referenced schema details |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetReferencedAsync(String, Nullable<Boolean>, CancellationToken)
Gets all schemas referenced by the schema specified in id
Declaration
Task<ICollection<SchemaDetail>> GetReferencedAsync(string id, bool? sourceSchema = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The schema ID. |
System.Nullable<System.Boolean>
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). |
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<SchemaDetail>>
Referenced schema details |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<SchemaType>
schemaTypes
Schema types to include in search |
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<SortFieldInfo>>
The list of fields |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SearchAsync(SchemaSearchRequest, CancellationToken)
Search schemas
Declaration
Task<SchemaSearchResult> SearchAsync(SchemaSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaSearchRequest
request
The schema 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<SchemaSearchResult>
Schema search result |
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, SchemaOwnershipTransferRequest, Nullable<TimeSpan>, CancellationToken)
Transfer ownership
Declaration
Task TransferOwnershipAsync(string id, SchemaOwnershipTransferRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The schema ID. |
SchemaOwnershipTransferRequest
request
Request detailing which user to transfer to. |
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.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(SchemaOwnershipTransferManyRequest, CancellationToken)
Transfer ownership of multiple schemas
Declaration
Task<BusinessProcess> TransferOwnershipManyAsync(SchemaOwnershipTransferManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaOwnershipTransferManyRequest
request
Schema ownership transfer 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 |
UpdateAsync(SchemaDetail, Boolean, Nullable<TimeSpan>, CancellationToken)
Updates the given SchemaDetail.
Declaration
Task<SchemaUpdateResult> UpdateAsync(SchemaDetail schemaDetail, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaDetail
schemaDetail
The schema detail. |
System.Boolean
enableForBinaryFiles
Specifies whether to enable the schema for binary files. |
System.Nullable<TimeSpan>
timeout
Maximum time to wait for the operation to complete. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<SchemaUpdateResult>
The task. |
Exceptions
ApiException
A server side error occurred. |
UpdateAsync(String, SchemaUpdateRequest, Nullable<TimeSpan>, CancellationToken)
Update schema
Declaration
Task<SchemaUpdateResult> UpdateAsync(string id, SchemaUpdateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
The schema ID. |
SchemaUpdateRequest
request
The schema update 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.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<SchemaUpdateResult>
Schema update result, containing the updated schema |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkConflictException
Version conflict |
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(IEnumerable<SchemaDetail>, Boolean, Nullable<TimeSpan>, CancellationToken)
Update the given enumerable of SchemaDetail.
Declaration
Task<SchemaBatchOperationResult> UpdateManyAsync(IEnumerable<SchemaDetail> schemaDetails, bool enableForBinaryFiles, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
IEnumerable<SchemaDetail>
schemaDetails
The schema details. |
System.Boolean
enableForBinaryFiles
Specifies whether to enable the schemas for binary files. |
System.Nullable<TimeSpan>
timeout
Maximum time to wait for the underlying business process to complete. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<SchemaBatchOperationResult>
The |
UpdateManyAsync(SchemaUpdateManyRequest, Nullable<TimeSpan>, CancellationToken)
Updates schemas using the given request.
Declaration
Task<SchemaBatchOperationResult> UpdateManyAsync(SchemaUpdateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
SchemaUpdateManyRequest request |
System.Nullable<TimeSpan>
timeout
Maximum time to wait for the underlying business process to complete. |
System.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<SchemaBatchOperationResult>
The |
WaitForBusinessProcessAndReturnResult(String, Nullable<TimeSpan>, CancellationToken)
Waits for a business process and returns a
Declaration
Task<SchemaBatchOperationResult> WaitForBusinessProcessAndReturnResult(string businessProcessId, TimeSpan? timeout = null, 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.Threading.CancellationToken
cancellationToken
The cancellation token. |
Returns
System.Threading.Tasks.Task<SchemaBatchOperationResult>
The |