PATCH api/community/{userID}/docs/{docNumber}
Update community profile document record.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userID |
User ID |
string |
Required |
docNumber |
Document Number |
string |
Required |
Body Parameters
CommunityDocumentRecordName | Description | Type | Additional information |
---|---|---|---|
DocumentType |
The document type assigned to the community document |
string |
None. |
DocumentID |
The document ID assigned to the community document |
string |
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
{ "DocumentType": "sample string 1", "DocumentID": "sample string 2", "VCTableId": 3, "VCRecordId": 4, "VCParentRecordID": 1, "VCStorageID": 1, "VCFileRelativeLocation": "sample string 5", "VCFileName": "sample string 6", "VCFileExtension": "sample string 7", "VCFileOriginalName": "sample string 8" }
application/xml, text/xml
<CommunityDocumentRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClaimsVCRestApi.Models"> <DocumentID>sample string 2</DocumentID> <DocumentType>sample string 1</DocumentType> <VCFileExtension>sample string 7</VCFileExtension> <VCFileName>sample string 6</VCFileName> <VCFileOriginalName>sample string 8</VCFileOriginalName> <VCFileRelativeLocation>sample string 5</VCFileRelativeLocation> <VCParentRecordID>1</VCParentRecordID> <VCRecordId>4</VCRecordId> <VCStorageID>1</VCStorageID> <VCTableId>3</VCTableId> </CommunityDocumentRecord>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | 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. |