Easy API: Difference between revisions
From MobileX for SageCRM
Crmtogether (talk | contribs) No edit summary |
Crmtogether (talk | contribs) No edit summary |
||
Line 2: | Line 2: | ||
New Easy API - Designed to make "some" screens easy to provide in the interface | New Easy API - Designed to make "some" screens easy to provide in the interface | ||
---- | |||
* showScreens - screens with optional edit | * showScreens - screens with optional edit | ||
- Parameters | |||
1. Entity - name of the entity | |||
2. EntityIdField - id field of the entity | |||
3. Screens - Comma seperated list of CRM screens | |||
4. EntityToUse - name field to make ContextEntityfield value to | |||
5. ContextEntityfield - name of the entity context (tab) we are in | |||
6. allowEdit - boolean - set to true to show edit button | |||
Example: | |||
showScreens(cApp.EntityName, cApp.EntityId,'CustomCompanyScreenMX1,CustomCompanyScreenMX2', 'company', 'comp_companyid','comp_companyid',true); | |||
---- | |||
* cugetList – Table style lists | * cugetList – Table style lists | ||
Line 16: | Line 29: | ||
7. CRMListToUse - optional - name of a list in CRM alternatively use displayfields | 7. CRMListToUse - optional - name of a list in CRM alternatively use displayfields | ||
cugetList('ctproject','ctpr_companyid','ctpr_createddate','',true,'','mxcustomlist'); | Example: | ||
cugetList('ctproject','ctpr_companyid','ctpr_createddate','',true,'','mxcustomlist'); | |||
---- | |||
* getListScreen – repeating screens style list | * getListScreen – repeating screens style list | ||
Line 23: | Line 40: | ||
- Notes | - Notes | ||
1. Expects view "ventitynamesummary" to exist and must contain fields "pers_firstname,pers_lastname,pers_personid,comp_name,comp_companyid". | 1. Expects view "ventitynamesummary" to exist and must contain fields "pers_firstname,pers_lastname,pers_personid,comp_name,comp_companyid". | ||
Example: | |||
getListScreen('ctproject'); |
Revision as of 13:56, 19 September 2019
New Easy API - Designed to make "some" screens easy to provide in the interface
- showScreens - screens with optional edit
- Parameters 1. Entity - name of the entity 2. EntityIdField - id field of the entity 3. Screens - Comma seperated list of CRM screens 4. EntityToUse - name field to make ContextEntityfield value to 5. ContextEntityfield - name of the entity context (tab) we are in 6. allowEdit - boolean - set to true to show edit button
Example:
showScreens(cApp.EntityName, cApp.EntityId,'CustomCompanyScreenMX1,CustomCompanyScreenMX2', 'company', 'comp_companyid','comp_companyid',true);
- cugetList – Table style lists
- Parameters 1. Entity - name of the entity 2. EntityIdField - id field of the entity 3. EntityOrderBy - order date by this column 4. displayfields - optional - comma delimited list of fields, alternatively use CRMListToUse 5. linktoEntity - boolean - allows the item be clicked on to navigate the user to that entity record summary page 6. customlink - optional - set linktoEntity to false and instead set your own function call 7. CRMListToUse - optional - name of a list in CRM alternatively use displayfields
Example:
cugetList('ctproject','ctpr_companyid','ctpr_createddate',,true,,'mxcustomlist');
- getListScreen – repeating screens style list
- Parameters 1. entityname - Notes 1. Expects view "ventitynamesummary" to exist and must contain fields "pers_firstname,pers_lastname,pers_personid,comp_name,comp_companyid".
Example:
getListScreen('ctproject');