Click or drag to resize

IDocumentApiClient.HeadDocumentAsync Method (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
Task<HeadDocumentResponse> HeadDocumentAsync(
	string documentId,
	DocumentHeaderProperties headers = null
)

Parameters

documentId
Type: System.String
headers (Optional)
Type: ArangoDBNetStandard.DocumentApi.Models.DocumentHeaderProperties
The DocumentHeaderProperties values.

Return Value

Type: Task<HeadDocumentResponse>
Exceptions
ExceptionCondition
ArgumentExceptionDocument ID is invalid.
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.
See Also