DocCloud API

<back to all web services

PatchEntitiesCommand

Requires Authentication
The following routes are available for this service:
PATCH/serial/patchPatch changes into entity
PatchEntitiesCommand Parameters:
NameParameterData TypeRequiredDescription
IdsqueryList<Object>No
ObjectTypequeryintNo
PatchOperationsqueryList<PatchOperation>No
PatchOperation Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
ValueformObjectNo
OperationResult Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ResponseStatusformResponseStatusNo
ResultformObjectNo
IsSuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /serial/patch HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ids":[{}],"objectType":0,"patchOperations":[{"propertyName":"String","value":{}}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"code":"FAIL","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"result":{},"isSuccess":false}