Page Comparison

...

Excerpt
Created a new document for an account.

Span

style	white-space: pre

Endpoint ID:

1062

9202

Method:

Status

colour	Green
title	POST

URL:

/

user

entity/

dp-key

id/{entityID}/documents

/

user

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

dialogportal™ master key

Rubiq entity ID that uniquely identifies the account to

return data

create the document for
	externalRelationID	External key that uniquely identifies the account to

return data

create the document for
	externalRelationType	Type of external key

documentID

The ID of the document to be retrieved

Request body:

None

Code Block

title	Example Request

"content":

123456,

compressed": "John Doe", "createdBy": "mailbox@mailserver.com",

base64 encoded text",
   "compressed": true,
   "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

sizeOriginal":

"mailbox@mailserver.com"

1500
}

Spanstylewhite-space:pre

Response body:

The content contain the DocumentID

A JSON object containing the "documentID" of the newly created document.

Code Block

title	Example

Request

Response

content

documentID": 123456
}

Status codes:

201

Document created with success

404

Account was not found

The following sub codes may be returned:

404.1	User not found
404.2	External user could not be found

Versions Compared

Old Version 1

New Version Current

Key