PATCH api/sfdocs/{docID}

Update a Salesforce document record.

Request Information

URI Parameters

Name	Description	Type	Additional information
docID	Document Number	string	Required

Body Parameters

DocumentRecord

Name	Description	Type	Additional information
DocumentID	The document ID assigned to the community document	string	None.
DocumentType	The document type assigned to the community document	string	None.
ClaimNumber	Claim number	string	None.
AljNumber	ALJ number	string	None.
CoaAppellateCaseNumber	COA appelate case number	string	None.
PacketID	The packet number assigned to the claim document	string	None.
FileNETEntryDate	The date the document was entered into FileNET	date	None.
VCTableID	The ViewCenter record table ID that represents the table the document is in	integer	None.
VCRecordID	The ViewCenter record ID that represents a document	integer	None.
VCParentRecordID	The ViewCenter parent record ID that this document record belongs too.	integer	None.
VCStorageID	The storage ID of the storage folder where the attachment is stored (internal use).	integer	None.
VCFileRelativeLocation	The folder within the storage folder the attachment is stored (internal use).	string	None.
VCFileName	The filename within the storage folder the attachment is named (internal use).	string	None.
VCFileExtension	The file extension of the attachment.	string	None.
VCFileOriginalName	The original filename of the attachment as sent to ViewCenter.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentID": "sample string 1",
  "DocumentType": "sample string 2",
  "ClaimNumber": "sample string 3",
  "AljNumber": "sample string 4",
  "CoaAppellateCaseNumber": "sample string 5",
  "PacketID": "sample string 6",
  "FileNETEntryDate": "2024-12-28T01:46:13.8428115-07:00",
  "VCTableID": 7,
  "VCRecordID": 8,
  "VCParentRecordID": 1,
  "VCStorageID": 1,
  "VCFileRelativeLocation": "sample string 9",
  "VCFileName": "sample string 10",
  "VCFileExtension": "sample string 11",
  "VCFileOriginalName": "sample string 12"
}

application/xml, text/xml

Sample:

<DocumentRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClaimsVCRestApi.Models.SalesforceDocuments">
  <AljNumber>sample string 4</AljNumber>
  <ClaimNumber>sample string 3</ClaimNumber>
  <CoaAppellateCaseNumber>sample string 5</CoaAppellateCaseNumber>
  <DocumentID>sample string 1</DocumentID>
  <DocumentType>sample string 2</DocumentType>
  <FileNETEntryDate>2024-12-28T01:46:13.8428115-07:00</FileNETEntryDate>
  <PacketID>sample string 6</PacketID>
  <VCFileExtension>sample string 11</VCFileExtension>
  <VCFileName>sample string 10</VCFileName>
  <VCFileOriginalName>sample string 12</VCFileOriginalName>
  <VCFileRelativeLocation>sample string 9</VCFileRelativeLocation>
  <VCParentRecordID>1</VCParentRecordID>
  <VCRecordID>8</VCRecordID>
  <VCStorageID>1</VCStorageID>
  <VCTableID>7</VCTableID>
</DocumentRecord>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.