PUT portal/Entity/EntityDocument

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
record_id	string	Required
entity	IdValuePair	None.
type	IdValuePair	None.
file_name	string	Required
file_bytes	string	Required

Request Formats

application/json, text/json

Sample:

{
  "record_id": "sample string 1",
  "entity": {
    "value": "sample string 1",
    "id": 2
  },
  "type": {
    "value": "sample string 1",
    "id": 2
  },
  "file_name": "sample string 2",
  "file_bytes": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateEntityDocument'.

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: There was an error reflecting type 'Models.Models.Entity.UpdateEntityDocument'.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: There was an error reflecting type 'Models.Models.Entity.UpdateEntityDocument'.

Response Information

Resource Description

DSOutput

Name	Type	Additional information
status	boolean	None.
data	Object	None.
code	integer	None.
message	string	None.
error	Error	None.
paging	Paging	None.
additional_codes	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": true,
  "data": {},
  "code": 0,
  "message": "sample string 3",
  "error": {
    "code": 0,
    "message": "sample string 1",
    "target": "sample string 2",
    "details": [
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      },
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      }
    ]
  },
  "paging": {
    "page_number": 1,
    "page_size": 2,
    "page_from": 3,
    "page_to": 4,
    "record_count": 5
  },
  "additional_codes": "sample string 4"
}

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.