CloudObjectRelations.list

Returns all defined CloudObjectRelations

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted CloudObjectRelations are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of CloudObjectRelations

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (CloudObjectRelation) {53}]

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

account

string <uri>

optional

Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.

appointment

string <uri>

optional

Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties.

task

string <uri>

optional

Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties.

approval_process

string <uri>

optional

Relation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcess' object for properties.

call

string <uri>

optional

Relation to Call. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Call' object for properties.

cloud_object_folder

string <uri>

optional

Relation to CloudObjectFolder. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObjectFolder' object for properties.

cloud_object

string <uri>

optional

Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' object for properties.

contact

string <uri>

optional

Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.

custom_entity

string <uri>

optional

Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties.

email_sequence

string <uri>

optional

Relation to EmailSequence. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailSequence' object for properties.

email_template

string <uri>

optional

Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties.

field_mapping

string <uri>

optional

Relation to FieldMapping. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'FieldMapping' object for properties.

lead

string <uri>

optional

Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.

oppty

string <uri>

optional

Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.

media

string <uri>

optional

Relation to Media. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Media' object for properties.

string <uri>

optional

Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties.

memo

string <uri>

optional

Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties.

online_form_field

string <uri>

optional

Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties.

online_form

string <uri>

optional

Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties.

process

string <uri>

optional

Relation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties.

process_template

string <uri>

optional

Relation to ProcessTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProcessTemplate' object for properties.

project

string <uri>

optional

Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties.

quote

string <uri>

optional

Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties.

report_schedule

string <uri>

optional

Relation to ReportSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ReportSchedule' object for properties.

text_message

string <uri>

optional

Relation to TextMessage. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'TextMessage' object for properties.

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

activity_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

approval_process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

call_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_folder_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

cloud_object_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

custom_entity_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_sequence_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

field_mapping_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_oppty_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

media_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

message_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

online_form_field_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

online_form_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

process_template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quote_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

report_schedule_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

text_message_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

Example

{
  "success": true,
  "data": [
    {
      "is_delete_protected": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "account": "http://example.com",
      "appointment": "http://example.com",
      "task": "http://example.com",
      "approval_process": "http://example.com",
      "call": "http://example.com",
      "cloud_object_folder": "http://example.com",
      "cloud_object": "http://example.com",
      "contact": "http://example.com",
      "custom_entity": "http://example.com",
      "email_sequence": "http://example.com",
      "email_template": "http://example.com",
      "field_mapping": "http://example.com",
      "lead": "http://example.com",
      "oppty": "http://example.com",
      "media": "http://example.com",
      "email": "http://example.com",
      "memo": "http://example.com",
      "online_form_field": "http://example.com",
      "online_form": "http://example.com",
      "process": "http://example.com",
      "process_template": "http://example.com",
      "project": "http://example.com",
      "quote": "http://example.com",
      "report_schedule": "http://example.com",
      "text_message": "http://example.com",
      "account_id": "01234567-abcd-dcba-ffff-000000000000",
      "activity_id": "01234567-abcd-dcba-ffff-000000000000",
      "approval_process_id": "01234567-abcd-dcba-ffff-000000000000",
      "call_id": "01234567-abcd-dcba-ffff-000000000000",
      "cloud_object_folder_id": "01234567-abcd-dcba-ffff-000000000000",
      "cloud_object_id": "01234567-abcd-dcba-ffff-000000000000",
      "contact_id": "01234567-abcd-dcba-ffff-000000000000",
      "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
      "email_sequence_id": "01234567-abcd-dcba-ffff-000000000000",
      "email_template_id": "01234567-abcd-dcba-ffff-000000000000",
      "field_mapping_id": "01234567-abcd-dcba-ffff-000000000000",
      "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
      "media_id": "01234567-abcd-dcba-ffff-000000000000",
      "message_id": "01234567-abcd-dcba-ffff-000000000000",
      "online_form_field_id": "01234567-abcd-dcba-ffff-000000000000",
      "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
      "process_id": "01234567-abcd-dcba-ffff-000000000000",
      "process_template_id": "01234567-abcd-dcba-ffff-000000000000",
      "project_id": "01234567-abcd-dcba-ffff-000000000000",
      "quote_id": "01234567-abcd-dcba-ffff-000000000000",
      "report_schedule_id": "01234567-abcd-dcba-ffff-000000000000",
      "text_message_id": "01234567-abcd-dcba-ffff-000000000000",
      "revision": 1
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

🔴500Server Error

CloudObjectRelations.list

Request

Request samples

Responses