PUT api/globalDocuments

Updates global documents

Request Information

URI Parameters

None.

Body Parameters

GlobalDocumentUpdateViewModel
NameDescriptionTypeAdditional information
GlobalDocumentId

integer

None.
Name

string

Required

Matching regular expression pattern: ^[^*?:<>|"\\/]*$
Description

string

Required
IsAvailableForRSM

boolean

None.
ModifiedOn

date

None.
ModifiedBy

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "globalDocumentId": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "isAvailableForRSM": true,
  "modifiedOn": "2025-10-29T04:36:41.3082492-04:00",
  "modifiedBy": 1
}

application/xml, text/xml

Sample: 
<GlobalDocumentUpdateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Description>sample string 3</Description>
  <GlobalDocumentId>1</GlobalDocumentId>
  <IsAvailableForRSM>true</IsAvailableForRSM>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2025-10-29T04:36:41.3082492-04:00</ModifiedOn>
  <Name>sample string 2</Name>
</GlobalDocumentUpdateViewModel>

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 'GlobalDocumentUpdateViewModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.