IDocumentApiClientPatchDocumentAsyncT, U Method (String, T, PatchDocumentQuery, ApiClientSerializationOptions, DocumentHeaderProperties)

Partially updates the document identified by document-handle. The body of the request must contain a JSON document with the attributes to patch(the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there. PATCH/_api/document/{document-handle}

Namespace: ArangoDBNetStandard.DocumentApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0

Syntax

C++

Copy

Task<PatchDocumentResponse<U>> PatchDocumentAsync<T, U>(
	string documentId,
	T body,
	PatchDocumentQuery query = null,
	ApiClientSerializationOptions serializationOptions = null,
	DocumentHeaderProperties headers = null
)

Function PatchDocumentAsync(Of T, U) ( 
	documentId As String,
	body As T,
	Optional query As PatchDocumentQuery = Nothing,
	Optional serializationOptions As ApiClientSerializationOptions = Nothing,
	Optional headers As DocumentHeaderProperties = Nothing
) As Task(Of PatchDocumentResponse(Of U))

generic<typename T, typename U>
Task<PatchDocumentResponse<U>^>^ PatchDocumentAsync(
	String^ documentId, 
	T body, 
	PatchDocumentQuery^ query = nullptr, 
	ApiClientSerializationOptions^ serializationOptions = nullptr, 
	DocumentHeaderProperties^ headers = nullptr
)

abstract PatchDocumentAsync : 
        documentId : string * 
        body : 'T * 
        ?query : PatchDocumentQuery * 
        ?serializationOptions : ApiClientSerializationOptions * 
        ?headers : DocumentHeaderProperties 
(* Defaults:
        let _query = defaultArg query null
        let _serializationOptions = defaultArg serializationOptions null
        let _headers = defaultArg headers null
*)
-> Task<PatchDocumentResponse<'U>>

Parameters

documentId: Type: SystemString
body: Type: T
query (Optional): Type: ArangoDBNetStandard.DocumentApi.ModelsPatchDocumentQuery
serializationOptions (Optional): Type: ArangoDBNetStandard.SerializationApiClientSerializationOptions
The serialization options. When the value is null the the serialization options should be provided by the serializer, otherwise the given options should be used.
headers (Optional): Type: ArangoDBNetStandard.DocumentApi.ModelsDocumentHeaderProperties
The DocumentHeaderProperties values.

Type Parameters

T: Type of the patch object used to partially update a document.
U: Type of the returned document, only applies when ReturnNew or ReturnOld are used.

Return Value

Type: TaskPatchDocumentResponseU

Reference

IDocumentApiClient Interface

PatchDocumentAsync Overload

ArangoDBNetStandard.DocumentApi Namespace