Class SchemaTransferClient

Inheritance
object
ClientBase
SchemaTransferClient
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 SchemaTransferClient : ClientBase, ISchemaTransferClient

Constructors

SchemaTransferClient(IPictureparkServiceSettings, HttpClient)

Declaration
public SchemaTransferClient(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

ImportAsync(SchemaImportRequest, CancellationToken)

Import schemas

Declaration
public virtual Task<Transfer> ImportAsync(SchemaImportRequest request, CancellationToken cancellationToken = default)
Parameters
SchemaImportRequest request

The schema import request.
CancellationToken cancellationToken

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

Transfer
Implements
Remarks

Imports schemas and list items. The file must already be uploaded before calling this endpoint. See Transfer.
The operation is executed asynchronous and it 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
FileTransferNotFoundException

File transfer not found
PictureparkArgumentNullException

Argument must not be null

ImportJsonAsync(Stream, string, bool?, bool?, CancellationToken)

Import schemas

Declaration
public virtual Task<BusinessProcess> ImportJsonAsync(Stream body = null, string name = null, bool? allowMissingDependencies = null, bool? importListItems = null, CancellationToken cancellationToken = default)
Parameters
Stream body

Body
string name

Name of the schema import
bool? allowMissingDependencies

Indicates if missing dependencies between imported list items should be allowed
bool? importListItems

Indicates if list items should be imported
CancellationToken cancellationToken

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

BusinessProcess
Implements
Remarks

Maximum uploaded file size is 500Mib 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

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

Declaration
protected virtual Task<SchemaTransferClient.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<SchemaTransferClient.ObjectResponseResult<T>>

Type Parameters
T