DocumentsController.Get Method

DocumentsControllerGet Method

[This is preliminary documentation and is subject to change.]

Retrieves a document instance by guid from the database.

Namespace: WebServiceKit.Controllers
Assembly: WebServiceKit (in WebServiceKit.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public IHttpActionResult Get(
	Guid guid,
	bool update = false
)

Public Function Get ( 
	guid As Guid,
	Optional update As Boolean = false
) As IHttpActionResult

public:
IHttpActionResult^ Get(
	Guid guid, 
	bool update = false
)

member Get : 
        guid : Guid * 
        ?update : bool 
(* Defaults:
        let _update = defaultArg update false
*)
-> IHttpActionResult

guid: Type: SystemGuid
Target document instance guid.
update (Optional): Type: SystemBoolean
True to update the document to the latest type version, otherwise false.

Type: IHttpActionResult
200 OK and the serialized document instance will be returned if the document instance guid is found, otherwise 404.

Remarks

The document instance is formatted using XML or JSON depending on the client request. Call requires a valid login token. HTTP Method: GET

[Route("api/documents/{guid}")]