Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R11.0.0


Table of Contents
maxLevel2

...

Name

Type

Description

token

String

The token retrieved from the login method

entity

(mandatory)

String

The name of the entity related with the attachment. The supported entities are the following:

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • COMMUNICATIONS
  • CONTACTINFORMATION
  • INSTALLEDITEMS
  • JOBS
  • LEADS
  • PRODUCTS
  • SERVICEREQUESTS
  • ATTACHMENTSLIBRARY
Tip

ATTACHMENTSLIBRARY is Available from CRM.COM R12.2.0

entity_id

(mandatory on conditions)

String

The ID of the entity related with the attachment, which is mandatory only if the entity is not set to ATTACHMENTSLIBRARY

Tip

The entity ID is mandatory up to CRM.COM R12.1.0


Tip

The entity ID is mandatory on conditions from CRM.COM R12.2.0


classification

(mandatory on conditions)

String

The classification of the attachment, which is mandatory only if the entity is set to ATTACHMENTSLIBRARY

Tip

Available from CRM.COM R12.2.0

fields_set
(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

entity

(mandatory)

String

The name of the entity related with the attachments that should be returned as a result. The supported entities are the following:

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • COMMUNICATIONS
  • CONTACTINFORMATION
  • INSTALLEDITEMS
  • JOBS
  • LEADS
  • PRODUCTS
  • SERVICEREQUESTS
  • ATTACHMENTSLIBRARY
Tip

ATTACHMENTSLIBRARY is Available from CRM.COM R12.2.0

entity_id

(mandatory on conditions)

String

The ID of the entity related with the attachments that should be returned as a result, and is mandatory only if the entity is not set to ATTACHMENTSLIBRARY

Tip

The entity ID is mandatory up to CRM.COM R12.1.0


Tip

The entity ID is mandatory on conditions from CRM.COM R12.2.0


file

(semi-optional)

FileThe file that should be added as an attachment

url

(semi-optional)

StringThe URL that should be added as an attachment

classification

(mandatory on conditions)

String

The classification of the attachment, and is mandatory only if the entity is set to ATTACHMENTSLIBRARY

Tip

Available from CRM.COM R12.2.0

notes

(optional)

StringThe notes related with the attachment

fields_set
(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

id

(mandatory)

String

The id of the attachment that should be deleted

 

...