PUT api/Files/{id}/Fields

Sets the value of a workgroup field on a file.

Request

Parameters

Name Description Default
id Unique file ID.
field Field ID or name.

Body

Content Type: application/xml or application/json
One or more values to store in the field.

XML JSON
<Request>                  
  <Value>object</Value>    <!--For single-value fields--> 
  <Values>                 <!--Array of 'Item'--> 
    <Item>object</Item>    <!--For multi-value fields--> 
  </Values>                
</Request>                 
{                           
   "Value": "object",       // For single-value fields
   "Values": [ "object" ]   // For multi-value fields
}                           
                            

Response

Body

Content Type: application/xml or application/json
Success status or an error message.

XML JSON
<Response>                     
  <Result>string</Result>      <!--Always 'Success'--> 
  <Message>string</Message>    <!--Error message--> 
</Response>                    
{                         
   "Result": "string",    // Always 'Success'
   "Message": "string"    // Error message
}                         
                          

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid field or file ID.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenThe user does not have permission to modify the matter.
404 Not FoundFile or field not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

Values expressed as inline objects in the request will be stored as XML in ContactsLaw.