...
To receive data via API, you can use different users with different access rights. Access rights to the objects defined in the Administration/Plugins/CRM/Access:
Supported methods
Method's name | User right | Description |
---|---|---|
getcompanybyname | CRM Main Menu | Return company by name or ID |
getcontactbyname | CRM Main Menu | Return contact by name or ID |
getcompanies | CRM Main Menu | Return all companies |
getcontacts | CRM Main Menu | Return all contacts |
sync | CRM Main Menu | Start synchronization of JIRA users |
setcrmproperties | CRM Main Menu | Set custom field type "Crm Property" in issue |
addcompany | Add companies | Add company |
setcontact | Add contacts | Set company for contacts |
adddictionaryvalue | Add the values to dictionaries | Add new value to a custom dictionary |
removedictionaryvalue | Remove the values from dictionaries | Remove value from a custom dictionary |
searchentities | Search CRM objects by parameters | Search CRM objects by parameters |
Calls examples
Start synchronization:
http:
//YOURDOMAIN/plugins/servlet/crm/api?apiKey=${apiKey}&userName=${userName}&command=sync
...
Add value "Green" to the custom dictionary "Colors":
http:
//YOURDOMAIN
/plugins/servlet/crm/api?command=adddictionaryvalue&userName=${userName}&apiKey=${apiKey}&dictionaryName=Colors&newvalue=Green
Remove value "Green" from the custom dictionary "Colors":
http:
//YOURDOMAIN
/plugins/servlet/crm/api?command=removedictionaryvalue&userName=${userName}&apiKey=${apiKey}&dictionaryName=Colors&valuetoremove=Green
Search for all contacts of "Teamlead" organization:
http:
//YOURDOMAIN/plugins/servlet/crm/api?command=searchEntities&crm_param_1=Company&crm_param_1_value=Teamlead&tableName=CONTACTS&userName=
${userName}&apiKey=${apiKey}
where:
${apiKey} - API Key (password) in the Administration/Plugins/CRM/Access
${userName} - JIRA user's login