DocumentsController.Deactivate Method

DocumentsControllerDeactivate Method

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

Deactivates a document instance by guid in the database.

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

Syntax

C++

Copy

public IHttpActionResult Deactivate(
	Guid guid,
	bool deactivateLinks = false
)

Public Function Deactivate ( 
	guid As Guid,
	Optional deactivateLinks As Boolean = false
) As IHttpActionResult

public:
IHttpActionResult^ Deactivate(
	Guid guid, 
	bool deactivateLinks = false
)

member Deactivate : 
        guid : Guid * 
        ?deactivateLinks : bool 
(* Defaults:
        let _deactivateLinks = defaultArg deactivateLinks false
*)
-> IHttpActionResult

Parameters

guid: Type: SystemGuid
Target document instance guid.
deactivateLinks (Optional): Type: SystemBoolean
True if documents instantiated by this document should also be deactivated.

Return Value

Type: IHttpActionResult
200 OK if the document guid is found, otherwise 404.

Remarks

Call requires a valid login token. HTTP Method: DELETE

Copy

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

Reference

DocumentsController Class

WebServiceKit.Controllers Namespace