Go to appAcademyWhat's new?
Back
Artisan IMG > Microsoft Dynamics 365 (microsoft-dynamics) (8c6b346c-34bd-4034-9409-02784d647fbe)
Microsoft Dynamics 365
OverviewUse casesOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Create entity
Copy

Create an entity of any type in your Microsoft Dynamics 365 account.

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "entity_set_name": "contacts",
5
    "fields": [
6
        {
7
            "field": "firstname",
8
            "value": "John"
9
        },
10
        {
11
            "field": "lastname",
12
            "value": "Doe"
13
        },
14
        {
15
            "field": "emailaddress1",
16
            "value": "john.doe@example.com"
17
        },
18
        {
19
            "field": "telephone1",
20
            "value": "+1 (555) 123-4567"
21
        }
22
    ]
23
}

Sample Output

1
{
2
    "id": "00000000-0000-0000-0000-000000000001"
3
}

Delete entity
Copy

Delete an entity of any type in your Microsoft Dynamics 365 account.

Sample Input

1
{
2
    "instance_url": "https://your-org.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "entity_id": "89a8cde4-5678-901f-2345-67890abcdef1",
5
    "entity_set_name": "contacts"
6
}

Sample Output

1
{
2
    "deleted": true
3
}

Get entity
Copy

Get an entity of any type from your Microsoft Dynamics 365 account.

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "v9.2",
5
    "entity_id": "00000000-0000-0000-0000-000000000001",
6
    "entity_set_name": "contacts",
7
    "fields": [
8
        "firstname",
9
        "lastname",
10
        "emailaddress1",
11
        "telephone1"
12
    ]
13
}

Sample Output

1
{
2
    "@odata.context": "https://myorg.crm.dynamics.com/api/data/v9.2/$metadata#contacts(firstname,lastname,emailaddress1,telephone1)/$entity",
3
    "@odata.etag": "W/\"2691174\"",
4
    "contactid": "00000000-0000-0000-0000-000000000001",
5
    "firstname": "John",
6
    "lastname": "Doe",
7
    "emailaddress1": "johndoe@example.com",
8
    "telephone1": "+1 (555) 123-4567"
9
}

Get user information
Copy

Retrieves stored information about the user.

Sample Input

1
{
2
    "instance_url": "https://mycompany.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpM...",
4
    "api_version": "v9.2"
5
}

Sample Output

1
{
2
    "instance_url": "https://mycompany.crm.dynamics.com",
3
    "token": {
4
        "given_name": "John",
5
        "name": "John Doe",
6
        "unique_name": "john.doe@mycompany.com",
7
        "upn": "john.doe@mycompany.com"
8
    }
9
}

List entities
Copy

Get a list of entities from your Microsoft Dynamics 365 account.

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "entity_set_name": "contacts",
5
    "fields": [
6
        "firstname",
7
        "lastname",
8
        "emailaddress1"
9
    ],
10
    "conditions": [
11
        {
12
            "field": "createdon",
13
            "operator": "gt",
14
            "value": "2023-01-01T00:00:00Z"
15
        }
16
    ],
17
    "conditions_strictness": "and",
18
    "order_by": [
19
        {
20
            "field": "lastname",
21
            "order": "asc"
22
        }
23
    ],
24
    "per_page": 50
25
}

Sample Output

1
{
2
    "@odata.context": "https://myorg.crm.dynamics.com/api/data/v9.2/$metadata#contacts(firstname,lastname,emailaddress1)",
3
    "value": [
4
        {
5
            "@odata.etag": "W/\"54321\"",
6
            "firstname": "John",
7
            "lastname": "Doe",
8
            "emailaddress1": "john.doe@example.com"
9
        },
10
        {
11
            "@odata.etag": "W/\"54322\"",
12
            "firstname": "Jane",
13
            "lastname": "Smith",
14
            "emailaddress1": "jane.smith@example.com"
15
        }
16
    ],
17
    "@odata.nextLink": "https://myorg.crm.dynamics.com/api/data/v9.2/contacts?$select=firstname,lastname,emailaddress1&$filter=createdon gt 2023-01-01T00:00:00Z&$orderby=lastname asc&$skiptoken=12345",
18
    "next_page_token": "12345"
19
}

List entities (raw filter)
Copy

Get a list of entities from your Microsoft Dynamics 365 account and filter them with a user defined query.

Sample Input

1
{
2
    "instance_url": "https://your-org.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "entity_set_name": "contacts",
5
    "fields": [
6
        "firstname",
7
        "lastname",
8
        "emailaddress1"
9
    ],
10
    "raw_filter": "startswith(lastname, 'Sm')",
11
    "order_by": [
12
        {
13
            "field": "lastname",
14
            "order": "asc"
15
        }
16
    ],
17
    "per_page": 50
18
}

Sample Output

1
{
2
    "@odata.context": "https://your-org.crm.dynamics.com/api/data/v9.2/$metadata#contacts(firstname,lastname,emailaddress1)",
3
    "value": [
4
        {
5
            "@odata.etag": "W/\"3042492\"",
6
            "firstname": "John",
7
            "lastname": "Smith",
8
            "emailaddress1": "john.smith@example.com"
9
        },
10
        {
11
            "@odata.etag": "W/\"3042493\"",
12
            "firstname": "Jane",
13
            "lastname": "Smythe",
14
            "emailaddress1": "jane.smythe@example.com"
15
        }
16
    ],
17
    "@odata.nextLink": "https://your-org.crm.dynamics.com/api/data/v9.2/contacts?$select=firstname,lastname,emailaddress1&$filter=startswith(lastname, 'Sm')&$orderby=lastname asc&$skiptoken=3042493",
18
    "next_page_token": "3042493"
19
}

List entity type attributes
Copy

List entity type attributes

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "entity_type_metadata_id": "00000000-0000-0000-0000-000000000001",
5
    "api_version": "9.2",
6
    "fields": [
7
        "LogicalName",
8
        "DisplayName",
9
        "AttributeType"
10
    ]
11
}

Sample Output

1
{
2
    "@odata.context": "https://myorg.crm.dynamics.com/api/data/v9.2/$metadata#EntityDefinitions(00000000-0000-0000-0000-000000000001)/Attributes",
3
    "value": [
4
        {
5
            "LogicalName": "accountnumber",
6
            "DisplayName": {
7
                "LocalizedLabels": [
8
                    {
9
                        "Label": "Account Number",
10
                        "LanguageCode": 1033
11
                    }
12
                ],
13
                "UserLocalizedLabel": {
14
                    "Label": "Account Number",
15
                    "LanguageCode": 1033
16
                }
17
            },
18
            "AttributeType": "String"
19
        },
20
        {
21
            "LogicalName": "name",
22
            "DisplayName": {
23
                "LocalizedLabels": [
24
                    {
25
                        "Label": "Account Name",
26
                        "LanguageCode": 1033
27
                    }
28
                ],
29
                "UserLocalizedLabel": {
30
                    "Label": "Account Name",
31
                    "LanguageCode": 1033
32
                }
33
            },
34
            "AttributeType": "String"
35
        }
36
    ]
37
}

List entity types
Copy

List entity types in Microsoft Dynamics 365

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "v9.2",
5
    "fields": [
6
        "LogicalName",
7
        "DisplayName",
8
        "IsCustomEntity",
9
        "PrimaryNameAttribute"
10
    ],
11
    "conditions": [
12
        {
13
            "field": "IsCustomEntity",
14
            "operator": "eq",
15
            "value": true
16
        },
17
        {
18
            "field": "IsValidForAdvancedFind",
19
            "operator": "eq",
20
            "value": true
21
        }
22
    ],
23
    "conditions_strictness": "and"
24
}

Sample Output

1
{
2
    "@odata.context": "https://myorg.crm.dynamics.com/api/data/v9.2/$metadata#EntityDefinitions(LogicalName,DisplayName,IsCustomEntity,PrimaryNameAttribute)",
3
    "value": [
4
        {
5
            "LogicalName": "new_customentity1",
6
            "DisplayName": {
7
                "UserLocalizedLabel": {
8
                    "Label": "Custom Entity 1",
9
                    "LanguageCode": 1033
10
                }
11
            },
12
            "IsCustomEntity": true,
13
            "PrimaryNameAttribute": "new_name"
14
        },
15
        {
16
            "LogicalName": "new_customentity2",
17
            "DisplayName": {
18
                "UserLocalizedLabel": {
19
                    "Label": "Custom Entity 2",
20
                    "LanguageCode": 1033
21
                }
22
            },
23
            "IsCustomEntity": true,
24
            "PrimaryNameAttribute": "new_title"
25
        }
26
    ]
27
}

List one to many relationships
Copy

List one to many relationships

Sample Input

1
{
2
    "instance_url": "https://your-org.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "9.2",
5
    "fields": [
6
        "SchemaName",
7
        "ReferencingEntity",
8
        "ReferencingAttribute"
9
    ],
10
    "conditions": [
11
        {
12
            "field": "ReferencedEntity",
13
            "operator": "eq",
14
            "value": "account"
15
        }
16
    ],
17
    "conditions_strictness": "and"
18
}

Sample Output

1
{
2
    "result": [
3
        {
4
            "MetadataId": "00000000-0000-0000-0000-000000000001",
5
            "SchemaName": "contact_customer_accounts",
6
            "ReferencingEntity": "contact",
7
            "ReferencingAttribute": "parentcustomerid"
8
        },
9
        {
10
            "MetadataId": "00000000-0000-0000-0000-000000000002",
11
            "SchemaName": "opportunity_customer_accounts",
12
            "ReferencingEntity": "opportunity",
13
            "ReferencingAttribute": "customerid"
14
        },
15
        {
16
            "MetadataId": "00000000-0000-0000-0000-000000000003",
17
            "SchemaName": "lead_customer_accounts",
18
            "ReferencingEntity": "lead",
19
            "ReferencingAttribute": "parentaccountid"
20
        }
21
    ]
22
}

List status attribute options
Copy

Get a list of possible options for a dropdown attribute, such as lead status.

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "entity_type": "lead",
5
    "attribute": "statuscode"
6
}

Sample Output

1
{
2
    "options": [
3
        {
4
            "@odata.type": "#Microsoft.Dynamics.CRM.OptionSetMetadata",
5
            "Value": 1,
6
            "Label": {
7
                "LocalizedLabels": [
8
                    {
9
                        "Label": "New",
10
                        "LanguageCode": 1033,
11
                        "IsManaged": true,
12
                        "MetadataId": "7d8b6c9e-9c9a-4f3a-bb4f-4d41b9e4a9e0",
13
                        "HasChanged": null
14
                    }
15
                ],
16
                "UserLocalizedLabel": {
17
                    "Label": "New",
18
                    "LanguageCode": 1033,
19
                    "IsManaged": true,
20
                    "MetadataId": "7d8b6c9e-9c9a-4f3a-bb4f-4d41b9e4a9e0",
21
                    "HasChanged": null
22
                }
23
            },
24
            "Description": {
25
                "LocalizedLabels": [],
26
                "UserLocalizedLabel": null
27
            },
28
            "Color": "#0000FF",
29
            "IsManaged": true,
30
            "MetadataId": null,
31
            "HasChanged": null,
32
            "State": 0,
33
            "TransitionData": ""
34
        },
35
        {
36
            "@odata.type": "#Microsoft.Dynamics.CRM.OptionSetMetadata",
37
            "Value": 2,
38
            "Label": {
39
                "LocalizedLabels": [
40
                    {
41
                        "Label": "Qualified",
42
                        "LanguageCode": 1033,
43
                        "IsManaged": true,
44
                        "MetadataId": "8f8b6c9e-9c9a-4f3a-bb4f-4d41b9e4a9e1",
45
                        "HasChanged": null
46
                    }
47
                ],
48
                "UserLocalizedLabel": {
49
                    "Label": "Qualified",
50
                    "LanguageCode": 1033,
51
                    "IsManaged": true,
52
                    "MetadataId": "8f8b6c9e-9c9a-4f3a-bb4f-4d41b9e4a9e1",
53
                    "HasChanged": null
54
                }
55
            },
56
            "Description": {
57
                "LocalizedLabels": [],
58
                "UserLocalizedLabel": null
59
            },
60
            "Color": "#00FF00",
61
            "IsManaged": true,
62
            "MetadataId": null,
63
            "HasChanged": null,
64
            "State": 0,
65
            "TransitionData": ""
66
        }
67
    ]
68
}

Query entity data
Copy

Run queries against entity data (uses FetchXML query strings). Enables more advanced operations such as aggregation of data e.g sum, count, max, etc.

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "entity_type": "account",
5
    "fields": {
6
        "field_list": [
7
            "name",
8
            "revenue",
9
            "numberofemployees"
10
        ]
11
    },
12
    "conditions": [
13
        {
14
            "field": "revenue",
15
            "operator": "gt",
16
            "value": "1000000"
17
        },
18
        {
19
            "field": "numberofemployees",
20
            "operator": "between",
21
            "value": [
22
                50,
23
                500
24
            ]
25
        }
26
    ],
27
    "conditions_strictness": "and",
28
    "sort_order": [
29
        {
30
            "field_name": "revenue",
31
            "descending": true
32
        }
33
    ],
34
    "per_page": 10,
35
    "page": 1
36
}

Sample Output

1
{
2
    "@odata.context": "https://myorg.crm.dynamics.com/api/data/v9.2/$metadata#accounts(name,revenue,numberofemployees)",
3
    "value": [
4
        {
5
            "name": "Contoso Ltd",
6
            "revenue": 5000000,
7
            "numberofemployees": 250,
8
            "@odata.etag": "W/\"1039834\""
9
        },
10
        {
11
            "name": "Fabrikam, Inc.",
12
            "revenue": 3500000,
13
            "numberofemployees": 180,
14
            "@odata.etag": "W/\"1039835\""
15
        },
16
        {
17
            "name": "Adventure Works",
18
            "revenue": 2800000,
19
            "numberofemployees": 120,
20
            "@odata.etag": "W/\"1039836\""
21
        }
22
    ]
23
}

Run fetch XML query (advanced)
Copy

Run a raw fetch XML query against the Dynamics instance.

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "v9.2",
5
    "entity_set_name": "contacts",
6
    "xml_query": "<fetch mapping='logical'><entity name='contact'><attribute name='fullname'/><attribute name='emailaddress1'/><filter><condition attribute='createdon' operator='last-x-days' value='30'/></filter></entity></fetch>"
7
}

Sample Output

1
{
2
    "@odata.context": "https://myorg.crm.dynamics.com/api/data/v9.2/$metadata#contacts(fullname,emailaddress1)",
3
    "value": [
4
        {
5
            "fullname": "John Doe",
6
            "emailaddress1": "john.doe@example.com",
7
            "@odata.etag": "W/\"3042492\""
8
        },
9
        {
10
            "fullname": "Jane Smith",
11
            "emailaddress1": "jane.smith@example.com",
12
            "@odata.etag": "W/\"3042493\""
13
        },
14
        {
15
            "fullname": "Mike Johnson",
16
            "emailaddress1": "mike.johnson@example.com",
17
            "@odata.etag": "W/\"3042494\""
18
        }
19
    ]
20
}

Update entity
Copy

Update an entity of any type in your Microsoft Dynamics 365 account.

Sample Input

1
{
2
    "instance_url": "https://your-org.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik...",
4
    "entity_id": "00000000-0000-0000-0000-000000000001",
5
    "entity_set_name": "contacts",
6
    "fields": [
7
        {
8
            "field": "firstname",
9
            "value": "John"
10
        },
11
        {
12
            "field": "lastname",
13
            "value": "Doe"
14
        },
15
        {
16
            "field": "emailaddress1",
17
            "value": "john.doe@example.com"
18
        },
19
        {
20
            "field": "telephone1",
21
            "value": "+1 (555) 123-4567"
22
        }
23
    ],
24
    "allow_empty_party_list": false
25
}

Sample Output

1
{
2
    "id": "00000000-0000-0000-0000-000000000001"
3
}

DDL operations
Copy

List entity set attributes (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "v9.2"
5
}

Sample Output

1
{
2
    "entitySets": [
3
        {
4
            "name": "accounts",
5
            "attributes": [
6
                {
7
                    "name": "accountid",
8
                    "type": "Edm.Guid",
9
                    "isKey": true
10
                },
11
                {
12
                    "name": "name",
13
                    "type": "Edm.String"
14
                },
15
                {
16
                    "name": "accountnumber",
17
                    "type": "Edm.String"
18
                },
19
                {
20
                    "name": "revenue",
21
                    "type": "Edm.Decimal"
22
                }
23
            ]
24
        },
25
        {
26
            "name": "contacts",
27
            "attributes": [
28
                {
29
                    "name": "contactid",
30
                    "type": "Edm.Guid",
31
                    "isKey": true
32
                },
33
                {
34
                    "name": "firstname",
35
                    "type": "Edm.String"
36
                },
37
                {
38
                    "name": "lastname",
39
                    "type": "Edm.String"
40
                },
41
                {
42
                    "name": "emailaddress1",
43
                    "type": "Edm.String"
44
                }
45
            ]
46
        }
47
    ]
48
}

List entity sets (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "v9.2"
5
}

Sample Output

1
{
2
    "value": [
3
        {
4
            "name": "accounts",
5
            "kind": "EntitySet",
6
            "url": "accounts"
7
        },
8
        {
9
            "name": "contacts",
10
            "kind": "EntitySet",
11
            "url": "contacts"
12
        },
13
        {
14
            "name": "leads",
15
            "kind": "EntitySet",
16
            "url": "leads"
17
        },
18
        {
19
            "name": "opportunities",
20
            "kind": "EntitySet",
21
            "url": "opportunities"
22
        }
23
    ]
24
}

List entity type attributes (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "v9.2"
5
}

Sample Output

1
{
2
    "value": [
3
        {
4
            "LogicalName": "accountnumber",
5
            "DisplayName": {
6
                "UserLocalizedLabel": {
7
                    "Label": "Account Number",
8
                    "LanguageCode": 1033
9
                }
10
            },
11
            "AttributeType": "String",
12
            "IsCustomAttribute": false,
13
            "IsPrimaryId": false,
14
            "SchemaName": "AccountNumber"
15
        },
16
        {
17
            "LogicalName": "name",
18
            "DisplayName": {
19
                "UserLocalizedLabel": {
20
                    "Label": "Account Name",
21
                    "LanguageCode": 1033
22
                }
23
            },
24
            "AttributeType": "String",
25
            "IsCustomAttribute": false,
26
            "IsPrimaryId": false,
27
            "SchemaName": "Name"
28
        },
29
        {
30
            "LogicalName": "emailaddress1",
31
            "DisplayName": {
32
                "UserLocalizedLabel": {
33
                    "Label": "Email",
34
                    "LanguageCode": 1033
35
                }
36
            },
37
            "AttributeType": "String",
38
            "IsCustomAttribute": false,
39
            "IsPrimaryId": false,
40
            "SchemaName": "EMailAddress1"
41
        }
42
    ]
43
}

List entity types (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "v9.2"
5
}

Sample Output

1
{
2
    "value": [
3
        {
4
            "LogicalName": "account",
5
            "SchemaName": "Account",
6
            "EntitySetName": "accounts",
7
            "PrimaryIdAttribute": "accountid",
8
            "PrimaryNameAttribute": "name",
9
            "ObjectTypeCode": 1
10
        },
11
        {
12
            "LogicalName": "contact",
13
            "SchemaName": "Contact",
14
            "EntitySetName": "contacts",
15
            "PrimaryIdAttribute": "contactid",
16
            "PrimaryNameAttribute": "fullname",
17
            "ObjectTypeCode": 2
18
        },
19
        {
20
            "LogicalName": "opportunity",
21
            "SchemaName": "Opportunity",
22
            "EntitySetName": "opportunities",
23
            "PrimaryIdAttribute": "opportunityid",
24
            "PrimaryNameAttribute": "name",
25
            "ObjectTypeCode": 3
26
        }
27
    ]
28
}

List party navigation property names (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{
2
    "instance_url": "https://myorg.crm.dynamics.com",
3
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCIsImtpZCI6Ik1yNS1BVWliZkJpaTdOZDFqQmViYXhib1hXMCJ9...",
4
    "api_version": "v9.2"
5
}

Sample Output

1
{}
Previous

Use cases

Next

Operations