Versions Compared

Old Version 1

changes.mady.by.user Usman Tanveer

Saved on

compared with

New Version Current

changes.mady.by.user Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use /entity routing instead of /user


Excerpt

Update a document for an account. This endpoint may also be used to move a document to another entity, by setting the moveToEntityID property.


Endpoint ID:

1065
9205
Method:

Status
colourGreen
titlePUT

URL:

/

user

entity/

dp-key

id/{entityID}/documents/{documentID}

/

user

entity/ext-key/{externalRelationID}/{externalRelationType}/documents/{documentID}



entityID

dialogportal™ master key

Rubiq entity ID that uniquely identifies an account to return data for


externalRelationID

External key that uniquely identifies an account to return data for


externalRelationType

Type of external key

documentID

The ID of the document to be retrieved
Request body:None


Note

All properties are optional, only the properties that are included in the request will be updated.


Code Block
titleExample Request
{
"documentID":
12345
 
"content":
123456,
 
"
compressed": "John Doe", "createdBy": "mailbox@mailserver.com", 
base64 encoded text",
   "compressed": false,
   "description": "Description of the document",
   
"expiryDate": "31-12-
2016 23
2016T23:59:59",
   
"mimeType": "image",
   
"name": "Test Document",
   
"sizeCompressed": 500,
 
  "sizeOriginal": 1500,
"srid":
12345,
 
"
updatedBy
moveToEntityID":
"mailbox@mailserver.com"
12345
}
Spanstylewhite-space:pre

Response body:
None

Status codes:
200
204
Document updated with success

404
Account was not found, or the document was not found for the account.
The following sub codes may be returned:
404.1User not found
404.2External user could not be found