IDocumentApiClientHeadDocumentAsync Method (String, String, DocumentHeaderProperties)

Like GET, but only returns the header fields and not the body. You can use this call to get the current revision of a document or check if the document was deleted. HEAD /_api/document/{document-handle}

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

Syntax

C++

Copy

Task<HeadDocumentResponse> HeadDocumentAsync(
	string collectionName,
	string documentKey,
	DocumentHeaderProperties headers = null
)

Function HeadDocumentAsync ( 
	collectionName As String,
	documentKey As String,
	Optional headers As DocumentHeaderProperties = Nothing
) As Task(Of HeadDocumentResponse)

Task<HeadDocumentResponse^>^ HeadDocumentAsync(
	String^ collectionName, 
	String^ documentKey, 
	DocumentHeaderProperties^ headers = nullptr
)

abstract HeadDocumentAsync : 
        collectionName : string * 
        documentKey : string * 
        ?headers : DocumentHeaderProperties 
(* Defaults:
        let _headers = defaultArg headers null
*)
-> Task<HeadDocumentResponse>

Parameters

collectionName: Type: SystemString
documentKey: Type: SystemString
headers (Optional): Type: ArangoDBNetStandard.DocumentApi.ModelsDocumentHeaderProperties
The DocumentHeaderProperties values.

Return Value

Type: TaskHeadDocumentResponse

Remarks

200: is returned if the document was found. 304: is returned if the “If-None-Match” header is given and the document has the same version. 400: is returned if the "TransactionId" header is given and the transactionId does not exist. 404: is returned if the document or collection was not found. 412: is returned if an “If-Match” header is given and the found document has a different version. The response will also contain the found document’s current revision in the Etag header.

Reference

IDocumentApiClient Interface

HeadDocumentAsync Overload

ArangoDBNetStandard.DocumentApi Namespace

IDocumentApiClientAddLanguageSpecificTextSet("LSTCCDC35F1_0?cpp=::|nu=.");HeadDocumentAsync Method (String, String, DocumentHeaderProperties)

Parameters

Return Value

Reference

IDocumentApiClientHeadDocumentAsync Method (String, String, DocumentHeaderProperties)