PUT api/v1/documents/{documentId}

Updates a Document.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentId

integer

Required

Body Parameters

DocumentUpdateDto
NameDescriptionTypeAdditional information
DocumentId

integer

None.

UserId

integer

None.

TemplateId

integer

None.

Title

string

None.

Description

string

None.

BinaryData

Collection of byte

None.

Pages

integer

None.

CaseId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "documentId": 1,
  "userId": 2,
  "templateId": 3,
  "title": "sample string 4",
  "description": "sample string 5",
  "binaryData": "QEA=",
  "pages": 1,
  "caseId": 6
}

application/xml, text/xml

Sample:
<DocumentUpdateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
  <BinaryData>QEA=</BinaryData>
  <CaseId>6</CaseId>
  <Description>sample string 5</Description>
  <DocumentId>1</DocumentId>
  <Pages>1</Pages>
  <TemplateId>3</TemplateId>
  <Title>sample string 4</Title>
  <UserId>2</UserId>
</DocumentUpdateDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentUpdateDto'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.