Document-type custom field values, when included in a REST object API response, will provide additional information about the attached document, including a URL to access the content of the attached file.
Document-type custom field values are read-only.
For example:
|
<SampleProject> <SimpleAttribute1>simple value</SimpleAttribute1> <SimpleAttribute2>simple value</SimpleAttribute2> |
← Simple object attribute values |
|
<DocumentAttribute3> |
← Begin document-type custom field value |
|
<title>My Doc Title</title> |
← Document title element |
|
<link href="http://server/ecosys/api/restdoc/SamplePro ject/4452-DocumentAttribute3/sampledoc.pdf" contentType="application/pdf" filename="sampledoc.pdf" sizeBytes="25401" modifiedTime="2013-02-22T10:30:24" /> |
← Document link element, including document meta data and URL to access attached file contents via HTTP |
|
</DocumentAttribute3> |
← End document-type custom field value |
|
. . . </SampleProject> |
The attributes of the document-type custom field value are as follows:
-
href — the API URL for accessing the content of the referenced document — this URL can be accessed through HTTP using the same session or credentials as the referring object API, and the HTTP response is the attached file itself inline
-
contentType — the MIME content type of the attached document referenced
-
filename — the filename assigned to the attached document
-
sizeBytes — the size in bytes of the attached document referenced
-
modifiedTime — the timestamp of the last update of the attached document referenced.