/custom-object-classes/{custom_object_class_id}/association-types/{id}

from merge import Merge
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.crm.association_types.custom_object_classes_association_types_retrieve(
    custom_object_class_id="custom_object_class_id",
    id="id",
)

{
  "id": "5bb73c32-3c6c-4757-ab7d-7d3540a1be31",
  "remote_id": "93",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "source_object_class": {
    "id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602",
    "origin_type": "CUSTOM_OBJECT"
  },
  "target_object_classes": [
    {
      "id": "Opportunity",
      "origin_type": "COMMON_MODEL"
    }
  ],
  "remote_key_name": "order_to_opportunity",
  "display_name": "Order to Opportunity",
  "cardinality": "ONE_TO_MANY",
  "is_required": true
}

Returns an AssociationType object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

custom_object_class_idstringRequiredformat: "uuid"

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

source_object_classmap from strings to anyRead-only

The class of the source object (Custom Object or Common Model) for the association type.

target_object_classeslist of objectsRead-only

remote_key_namestring or null

display_namestring or null

cardinalityenum or null

ONE_TO_ONE - ONE_TO_ONE
MANY_TO_ONE - MANY_TO_ONE
MANY_TO_MANY - MANY_TO_MANY
ONE_TO_MANY - ONE_TO_MANY

* `ONE_TO_ONE` - ONE_TO_ONE * `MANY_TO_ONE` - MANY_TO_ONE * `MANY_TO_MANY` - MANY_TO_MANY * `ONE_TO_MANY` - ONE_TO_MANY

Allowed values:

is_requiredboolean

Authentication

Path parameters

Headers

Query parameters

Response