Update the metadata for a specified document.
|
HTTP Verb/Method: |
PUT |
|
URL Format: |
http://server/api/documents/{OrderID}/{DocName} |
|
Returns: |
HTTP status of 200 (OK) is returned upon a successful add or update. |
The following table lists the parameters available for this method request.
|
Parameter |
Description |
|
OrderID |
Enter the primary key of the requested MoversSuite order. |
|
DocName |
Enter the name of the document to be added or updated. |
Property Descriptions
The following JSON example shows all possible property settings available. Not all properties will be set when updating metadata (see the individual property descriptions for more information). In fact, only set the properties for the values that will be changed; leave out properties that will remain unchanged.
{
"Description": "My document description",
"Notes": "My notes",
"Type": "BOL",
"DocumentTypeID": 16,
"WorkTicketNumber": "5",
"WorkTicketID": 50345,
"SysUserID": 1,
"ExternalSystem": "My Document System"
}
Refer to Add Document Metadata for property descriptions. Only set values for properties that will be updated. Do not set properties unless they are to be updated. MoversSuite strongly recommends including the user name (SysUserID) on all updates.