get
https://api.marketcircle.net/v1/files/
Show the details of a file
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the File | Read-only Non-null |
name | string | File name, including the extension, e.g. proposal.pdf. Used as the file name when downloading | Read-Write Nullable Searchable |
title | string | Title shown in Daylite | Read-Write Nullable Searchable |
size | integer | Size in bytes. Set when the content is uploaded | Read-only Nullable Searchable |
extension | string | File extension, e.g. pdf. Sets the content type when downloading | Read-Write Nullable Searchable |
note | string | Description of the file | Read-Write Nullable Searchable |
is_uploaded | boolean | Whether the file's content has been uploaded | Read-only Non-null |
appointments | array of link | Linked Appointments | Read-Write Nullable |
companies | array of link | Linked Companies | Read-Write Nullable |
contacts | array of link | Linked Contacts | Read-Write Nullable |
forms | array of link | Linked Forms | Read-Write Nullable |
groups | array of link | Linked Groups | Read-Write Nullable |
notes | array of link | Linked Notes | Read-Write Nullable |
opportunities | array of link | Linked Opportunities | Read-Write Nullable |
projects | array of link | Linked Projects | Read-Write Nullable |
tasks | array of link | Linked Tasks | Read-Write Nullable |
owner | reference | URL of the User responsible for the file | Read-Write Non-null Default value is the user making the request Searchable |
trashed | boolean | Whether the file is in the trash. Set to false to restore it | Read-only Non-null |
create_date | datetime | When the file was added | Read-only Non-null Searchable |
modify_date | datetime | When the file was last updated | Read-only Non-null Searchable |
Adding a file
A file has two parts: the record, with its name and links, and its content. Adding a file takes two requests:
- Create the file record with its
name,extensionand links. It returns the new file'slocation. - Upload the content with
PUTon that location plus/content.
is_uploaded is false until the content is uploaded. Content can only be uploaded once. To replace a file, create a new one.