Name | Type | Description |
|---|
id | String | The ID of the retrieved attachment |
| entity | String | The name of the entity related with the attachment. The supported entities are the following: - ACCOUNTSRECEIVABLE
- ACTIVITIES
- COMMUNICATIONS
- COMMUNICATIONTEMPLATES
- CONTACTINFORMATION
- INSTALLEDITEMS
- JOBS
- LEADS
- PRODUCTS
- SERVICEREQUESTS
- ATTACHMENTSLIBRARY
|
| entity_id | String | The ID of the entity related with the attachment. |
| url | String | The attached URL. This information is empty if the attachment is a file. |
| notes | String | The comments related with the retrieved attachment |
| classification | Attachments Classification Object | The classification of the attachment |
| file | File Object | The information of the attached file. This information is empty if the attachment is a URL. |
| log_information | Log Information Object | The log information of the retrieved attachment |
Referred Objects Response Data
classification object response data
| Name | Type | Description |
id | String | The id of the retrieved attachment classification |
name | String | The name of the retrieved attachment classification |
alternative_code | String | The alternative code of the retrieved attachment classification |
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |