M3 Experience Designer
M3 Experience Designer applications can use M3 CLM APIs as data sources to retrieve and display information. The APIs documented in this section are intended for use by M3 Experience Designer applications. Access to the data is controlled by the user's assigned roles and permissions in M3 CLM.
You can use these REST APIs when configuring the Data Service Configuration in the M3 Experience Designer application:
| Resource | Create (POST) | Update (POST) | Delete (DELETE) |
|---|---|---|---|
| Account | External/User/Account/Create | External/User/Account/Update | External/User/Account/Delete |
| AccountNotebook | External/User/AccountNotebook/Create | External/User/AccountNotebook/Update | External/User/AccountNotebook/Delete |
| Resource | Create (POST) | Update (POST) | Delete (POST) |
|---|---|---|---|
| Activity | External/User/Activity/Create | External/User/Activity/Update | External/User/Activity/Delete |
| ActivityNotebook | External/User/ActivityNotebook/Create | External/User/ActivityNotebook/Update | External/User/ActivityNotebook/Delete |
| Resource | Create (POST) | Update (POST) | Delete (POST) |
|---|---|---|---|
| Opportunity | External/User/Opportunity/Create | External/User/Opportunity/Update | External/User/Opportunity/Delete |
| OpportunityNotebook | External/User/OpportunityNotebook/Create | External/User/OpportunityNotebook/Update | External/User/OpportunityNotebook/Delete |
| Search (GET) | |
|---|---|
| External/User/Account/Search | Retrieves accounts that matches the search query |
| External/User/Activity/Search | Retrieves activities that matches the search query |
| External/User/Contact/Search | Retrieves contacts that matches the search query |
| External/User/Opportunity/Search | Retrieves opportunities that matches the search query |
| Account/xxxList (GET) | |
|---|---|
| AccountList | Lists all accounts that the user has a permission |
| AccountAddressList | Retrieves all address records for the selected account |
| AccountCommunicationList | Retrieves all communication records for the selected account |
| ActivityList | Retrieves all activities for the selected account |
| OpportunityList | Retrieves all opportunities for the selected account |
| ContactList | Retrieves all contacts for the selected account |
| QuotesList | Retrieves all quotes for the selected account. |
| External/User/AccountList | Lists all accounts that the user has a permission |
| External/User/AccountAddressList | Retrieves all address records for the selected account |
| External/User/AccountCommunicationList | Retrieves all communication records for the selected account |
| External/User/ActivityList | Retrieves all activities for the selected account |
| External/User/OpportunityList | Retrieves all opportunities for the selected account |
| External/User/ContactList | Retrieves all contacts for the selected account |
| External/User/QuotesList | Retrieves all quotes for the selected account. |
| External/User/AccountAddressListByAccountNumber | Retrieves address list of the account using the account number |
| External/User/CommunicationListByAccountNumber | Retrieves the communication records of the account using the account number |
| External/User/ActivityListByAccountNumber | Retrieves the activities of the account using the account number |
| External/User/ContactListByAccountNumber | Retrieves the contacts of the account using the account number |
| External/User/OpportunityListByAccountNumber | Retrieves the opportunities of the account using the account number |
| External/User/QuotesListByAccountNumber | Retrieves the quotes of the account using the account number |
| Activity/xxxList (GET) | |
|---|---|
| ActivityList | Lists all activities that the user has a permission |
| ActivityAddressList | Retrieves all address records for the selected activity |
| ActivityContactList | Retrieves all contacts for the selected activity |
| External/User/ActivityList | Lists all activities that the user has a permission |
| External/User/ActivityAddressList | Retrieves all address records for the selected activity |
| External/User/ActivityContactList | Retrieves all contacts for the selected activity |
| Details (GET) | |
|---|---|
| Account/GetAccountDetails | Retrieves the account information when an account is selected |
| Account/GetActivityDetails | Retrieves the activity information when an activity is selected |
| Opportunity/GetOpportunityDetails | Retrieves the opportunity information when an opportunity is selected |
| Contact/GetContactDetails | Retrieves the contact information when contact is selected |
| QuoteHeader/GetQuoteHeaderDetails | Retrieves quote header information when a quote is selected |
| relAccountAddressActivity/GetRelAccountAddressActivityDetails | Retrieves account address information linked to the selected activity |
| relActivityContact/GetRelActivityContactDetails | Retrieves contact information linked to the selected activity |
| External/User/Account/AccountDetails | Retrieves the account information when an account is selected |
| External/User/Activity/ActivityDetails | Retrieves the activity information when an activity is selected |
| External/User/Opportunity/OpportunityDetails | Retrieves the opportunity information when an opportunity is selected from an account |
| External/User/Contact/ContactDetails | Retrieves contact information from the selected contact in an account |
| External/User/QuoteHeader/QuoteHeaderDetails | Retrieves quote header information from the quotes of an account |
| External/User/relAccountAddressActivity/RelAccountAddressActivityDetails | Retrieves account address information linked to the selected activity |
| External/User/relActivityContact/RelActivityContactDetails | Retrieves contact information linked to the selected activity |
| External/User/AccountDetailsByAccountNumber | Retrieves the information of an account using the account number |
| External/User/Contact/ContactDetailsByContactIdentifier | Retrieves contact information from the selected contact in an account using the contact identifier |
| Opportunity (GET) | |
|---|---|
| External/User/Opportunity/OpportunityList | Lists all opportunities that the user has a permission. |
| Contact (GET) | |
|---|---|
| External/User/Contact/ContactList | Lists all contacts that the user has a permission. |
| CODE Details (GET) | |
|---|---|
| External/User/Code/CodeDetailsByCodeGroup | Allows the user to search for Codes with Code Group (code group name) search parameter. |