Overview
A configuration is provided for establishing connections with the Agile CRM service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to AgileCRM REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select AgileCRM. Set Domain in the Server host parameter https://[Domain].agilecrm.com/dev/api to your desired domain . Then provide the value for the Username and password in the grid below
Step 3. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your AgileCRM instance.
In this guide, we will show how to read data from the AgileCRM service resource using COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select AgileCRM connection from the combo. Select from available AgileCRM resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select AgileCRM resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from AgileCRM service.
In this guide, we will show how to write data to the AgileCRM service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select AgileCRM connection from the combo. Also, select resource action and AgileCRM resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the AgileCRM resource.
Configuration
Base URL address: https://[Domain].agilecrm.com/dev/api.
- Basic
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Username: Required. Specify user name.
- Password: Required. Specify password.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.Username + ':' + connection.user.Password)}}
Documentation: https://en.wikipedia.org/wiki/Basic_access_authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.Documentation: https://github.com/agilecrm/rest-api#11-listing-contacts-.
- [Read single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the contact identifier.
Documentation: https://github.com/agilecrm/rest-api#12-get-contact-by-id.
- [Read email] action
-
Endpoint URL address:
/contacts/search/email/{{=parameters.email}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- email: Required. Please specify the email associated with the contact.
Documentation: https://github.com/agilecrm/rest-api#1101-search-contact-by-email.
- [Read phoneNumber] action
-
Endpoint URL address:
/contacts/search/phonenumber/{{=parameters.phone}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- phone: Required. Please specify the phonenumber associated with the contact.
Documentation: https://github.com/agilecrm/rest-api#120-get-contact-by-phone-number.
- [Read dynamic filter] action
-
Endpoint URL address:
/filters/filter/dynamic-filter.
The action uses POST method.The action has the following user-defined parameters:
- filterJson: Required. Please specify the filter criteria in JSON format.
Documentation: https://github.com/agilecrm/rest-api#12-dynamic-filters-on-contacts--deals.
- [Read search] action
-
Endpoint URL address:
/search.The action has the following user-defined parameters:
- q: Required. Please enter the search keyword.
The following request parameters will be automatically processed:
-
type:
PERSON
Documentation: https://github.com/agilecrm/rest-api#111-search-contactscompanies.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://github.com/agilecrm/rest-api#13-creating-a-contact.
- [Update] action
-
Endpoint URL address:
/contacts/edit-properties.Documentation: https://github.com/agilecrm/rest-api#14-update-properties-of-a-contact-by-id-partial-update.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://github.com/agilecrm/rest-api#110-delete-single-contact.
The resource includes the fields from the contactT template.
- name
Template: ShortText.
- value
Template: ShortText.
- deals
The value is gathered from
/contacts/{{=item.id}}/dealsaddress. Field components:- An array.
-
Uses template:
dealT.
- notes
The value is gathered from
/contacts/{{=item.id}}/notesaddress. Field components:- An array.
-
Uses template:
NoteT.
- tasks
The value is gathered from
/contacts/{{=item.id}}/tasksaddress. Field components:- An array.
-
Uses template:
taskT.
- events
The value is gathered from
/contacts/{{=item.id}}/events/sortaddress. Field components:- An array.
-
Uses template:
eventT.
- properties
Field components:
-
Uses template:
ShortText. - Contains the following components: first_name, last_name, address, bio, company, email, image, phone, title, website.
-
Uses template:
- [External]
-
The external fields URL address:
/custom-fields/scope/position. The external fields list is extracted from:{{=response}}.- properties.{{=external.field_label}}
Template: {{=AgileCRM.getFieldTemplate(external.field_type)}}. Before setting, the value is processed with
{{=AgileCRM.getCustomFieldValue(field, value)}}expression.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/contacts/email/tags/add.The following request parameters will be automatically processed:
-
item:
{{=item}}
Documentation: https://github.com/agilecrm/rest-api#112-adding-tags-to-a-contact-based-on-email.
-
item:
- [Delete] action
-
Endpoint URL address:
/contacts/email/tags/delete.
The action uses POST method.The following request parameters will be automatically processed:
-
item:
{{=item}}
Documentation: https://github.com/agilecrm/rest-api#113-delete-tags-to-a-contact-based-on-email.
-
item:
Template: ShortText.
- tags
Template: LongText. A composite field.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/campaigns/enroll/email.The following request parameters will be automatically processed:
-
application/x-www-form-urlencoded:
{{=item}}
Documentation: https://github.com/agilecrm/rest-api#118-add-contact-to-a-campaign.
-
application/x-www-form-urlencoded:
- [Delete] action
-
Endpoint URL address:
/workflows/remove-active-subscriber/{{=item['workflow-id']}}/{{=item.contact_id}}.Documentation: https://github.com/agilecrm/rest-api#119-remove-contact-from-a-campaign.
Template: ShortText.
- workflow-id
Template: ShortText.
- contact_id
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/companies/list.
The action uses POST method.The following request parameters will be automatically processed:
-
application/x-www-form-urlencoded:
Documentation: https://github.com/agilecrm/rest-api#23-get-list-of-companies.
-
application/x-www-form-urlencoded:
- [Read single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the company identifier.
- [Read search] action
-
Endpoint URL address:
/search.The action has the following user-defined parameters:
- q: Required. Please enter the search keyword.
The following request parameters will be automatically processed:
-
type:
COMPANY
Documentation: https://github.com/agilecrm/rest-api#111-search-contactscompanies.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://github.com/agilecrm/rest-api#21-creating-a-company.
- [Update] action
-
Endpoint URL address:
/contacts/edit-properties.Documentation: https://github.com/agilecrm/rest-api#22-updating-a-company.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://github.com/agilecrm/rest-api#25-delete-single-company.
The resource includes the fields from the contactT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/opportunity.Documentation: https://github.com/agilecrm/rest-api#31-listing-deals.
- [Read single] action
-
Endpoint URL address:
/opportunity/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the deal identifier.
Documentation: https://github.com/agilecrm/rest-api#32-get-deal-by-its-id.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}/deals.The action has the following user-defined parameters:
- id: Required. Please specify the contact identifier.
- [Read current user] action
-
Endpoint URL address:
/opportunity/my/deals.Documentation: https://github.com/agilecrm/rest-api#312-get-deals-of-current-user-my-deals.
- [Read dynamic filter] action
-
Endpoint URL address:
/filters/filter/dynamic-filter.
The action uses POST method.The action has the following user-defined parameters:
- filterJson: Required. Please specify the filter criteria in JSON format.
Documentation: https://github.com/agilecrm/rest-api#12-dynamic-filters-on-contacts--deals.
- [Read milestone] action
-
Endpoint URL address:
/opportunity/byMilestone.
The result is extracted from:{{=response[parameters.milestone]}}.The action has the following user-defined parameters:
- milestone: Required. Please specify milestone.
Documentation: https://github.com/agilecrm/rest-api#38-get-deals-from-default-track-grouped-by-milestones.
- [Read track] action
-
Endpoint URL address:
/opportunity/byPipeline/based.
The result is extracted from:{{=response[parameters.milestone]}}.The action has the following user-defined parameters:
- milestone: Required. Please specify milestone.
- track: Please specify track identifier.
The following request parameters will be automatically processed:
-
pipeline_id:
{{=parameters.get('track')}}
Documentation: https://github.com/agilecrm/rest-api#39-get-deals-for-a-particular-track-grouped-by-milestone.
- [Create] action
-
Endpoint URL address:
/opportunity{{=item.contact_email && '/email/' + item.contact_email || ''}}.Documentation: https://github.com/agilecrm/rest-api#33-create-deal.
- [Update] action
-
Endpoint URL address:
/opportunity/partial-update.Documentation: https://github.com/agilecrm/rest-api#34-update-deal-partial-update.
- [Delete] action
-
Endpoint URL address:
/opportunity/{{=item.id}}.Documentation: https://github.com/agilecrm/rest-api#36-delete-deal.
The resource includes the fields from the dealT template.
- contact_email
A key field. Template: ShortText.
- notes
The value is gathered from
/opportunity/{{=item.id}}/notesaddress. Field components:- An array.
-
Uses template:
NoteT.
- [External]
-
The external fields URL address:
/custom-fields/scope/position. The external fields list is extracted from:{{=response}}.- custom_data.{{=external.field_label}}
Template: {{=AgileCRM.getFieldTemplate(external.field_type)}}. Before setting, the value is processed with
{{=AgileCRM.getCustomFieldValue(field, value)}}expression.
Based on resource template Base.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}/notes.The action has the following user-defined parameters:
- id: Required. Please specify the contact identifier.
Documentation: https://github.com/agilecrm/rest-api#43-gets-notes-related-to-specific-contact-.
- [Read deal] action
-
Endpoint URL address:
/opportunity/{{=parameters.id}}/notes.The action has the following user-defined parameters:
- id: Required. Please specify the deal identifier.
Documentation: https://github.com/agilecrm/rest-api#47-gets-notes-related-to-specific-deal-.
- [Create] action
-
Endpoint URL address:
{{=item.deal_ids && '/opportunity/deals' || ''}}/notes.Documentation: https://github.com/agilecrm/rest-api#41-create-a-note-and-relate-that-to-contacts- https://github.com/agilecrm/rest-api#45-create-note-to-a-deal .
- [Update] action
-
Endpoint URL address:
{{=item.deal_ids && '/opportunity/deals' || ''}}/notes.Documentation: https://github.com/agilecrm/rest-api#46-update-note-to-a-deal.
- [Delete] action
-
Endpoint URL address:
/contacts/notes/bulk.
The action uses POST method.The following request parameters will be automatically processed:
-
application/x-www-form-urlencoded:
{{=item}}
Documentation: https://github.com/agilecrm/rest-api#48-delete-notes-from-specific-deal-.
-
application/x-www-form-urlencoded:
The resource includes the fields from the NoteT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tasks.Documentation: https://github.com/agilecrm/rest-api#58-listing-tasks-.
- [Read single] action
-
Endpoint URL address:
/tasks/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the task identifier.
Documentation: https://github.com/agilecrm/rest-api#53-get-the-task-based-on-id.
- [Read pending] action
-
Endpoint URL address:
/tasks/pending/{{=parameters.num_days}}.The action has the following user-defined parameters:
- num_days: Required. Please specify the number of days the task is away from the due date.
Documentation: https://github.com/agilecrm/rest-api#51-get-the-list-of-pending-tasks-depending-on-the-number-of-pending-days.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}/tasks.The action has the following user-defined parameters:
- id: Required. Please specify the contact identifier.
Documentation: https://github.com/agilecrm/rest-api#59-get-tasks-related-to-contact.
- [Read filter] action
-
Endpoint URL address:
/tasks/based.Documentation: https://github.com/agilecrm/rest-api#52-get-the-list-of-tasks-based-on-given-filters.
- [Create] action
-
Endpoint URL address:
/tasks{{=item.contact_email && '/email/' + item.contact_email || ''}}.Documentation: https://github.com/agilecrm/rest-api#54-create-a-task https://github.com/agilecrm/rest-api#55-create-a-task-based-on-contact-email .
- [Update] action
-
Endpoint URL address:
/tasks/partial-update.Documentation: https://github.com/agilecrm/rest-api#56-update-a-task-partial-update.
- [Delete] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://github.com/agilecrm/rest-api#57-delete-a-task-based-on-id.
The resource includes the fields from the taskT template.
- contact_email
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/events.The action has the following user-defined parameters:
- start: Required. Please specify the start time in UnixTimeStamp (e.g) 1659148200.
- end: Required. Please specify the end time in UnixTimeStamp (e.g) 1659148200.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}/events/sort.The action has the following user-defined parameters:
- id: Required. Please specify the contact identifier to get events for.
Documentation: https://github.com/agilecrm/rest-api#62-get-events-related-to-contact.
- [Create] action
-
Endpoint URL address:
/events.Documentation: https://github.com/agilecrm/rest-api#63-create-event.
- [Update] action
-
Endpoint URL address:
/events.Documentation: https://github.com/agilecrm/rest-api#64-update-event.
- [Delete] action
-
Endpoint URL address:
/events/{{=item.id}}.Documentation: https://github.com/agilecrm/rest-api#65-delete-an-event.
The resource includes the fields from the eventT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/milestone/pipelines.Documentation: https://github.com/agilecrm/rest-api#71-get-all-the-tracks.
- [Create] action
-
Endpoint URL address:
/milestone/pipelines.Documentation: https://github.com/agilecrm/rest-api#72-create-a-track.
- [Update] action
-
Endpoint URL address:
/milestone/pipelines.Documentation: https://github.com/agilecrm/rest-api#73-update-a-track.
- [Delete] action
-
Endpoint URL address:
/milestone/pipelines/{{=item.id}}.Documentation: https://github.com/agilecrm/rest-api#74-delete-a-track.
- id
Template: Id.
- milestones
Template: ShortText.
- name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workflows.Documentation: https://github.com/agilecrm/rest-api#8-list-of-campaigns.
- id
Template: Id.
- created_time
Template: UnixTime. A read-only field.
- updated_time
Template: UnixTime. A read-only field.
- name
Template: ShortText.
- updated_time_update
Data type: DT_BOOL
- rules
Template: ShortText.
- unsubscribe
Field components:
-
Uses template:
ShortText. - Contains the following components: action, tag, unsubscribe_email, unsubscribe_name, unsubscribe_subject, is_unsubscribe_email_disabled.
-
Uses template:
- is_disabled
Data type: DT_BOOL
- access_level
Data type: DT_I4
- trigger
Field components:
-
Uses template:
ShortText. - Contains the following components: email_tracking_type, event_owner_id, event_type, trigger_run_on_new_contacts, new_email_trigger_run_on_new_contacts, is_disabled, contactFilter, campaign.
-
Uses template:
- category
Data type: DT_I4
- domainUserId
Template: ShortText.
- backupExists
Data type: DT_BOOL
- creatorName
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/documents/contact/{{=parameters.contact_id}}/docs.The action has the following user-defined parameters:
- contact_id: Required. Please specify the contact identifier.
Documentation: https://github.com/agilecrm/rest-api#91-get-documents-related-to-specific-contact-.
- [Create] action
-
Endpoint URL address:
/documents.Documentation: https://github.com/agilecrm/rest-api#92-create-a-document-to-a-contact.
- [Update] action
-
Endpoint URL address:
/documents.Documentation: https://github.com/agilecrm/rest-api#93-update-a-document-to-a-contact.
- id
Template: Id.
- name
Template: ShortText.
- dummy_name
Template: ShortText.
- uploaded_time
Template: UnixTime. A read-only field.
- extension
Template: ShortText.
- doc_type
Template: ShortText.
- text
Template: ShortText.
- template_type
Template: ShortText.
- size
Data type: DT_I4
- network_type
Template: ShortText.
- url
Template: ShortText.
- entity_type
Template: ShortText.
- contact_ids
Template: LongText. A composite field.
- case_ids
Template: LongText. A composite field.
- deal_ids
Template: LongText. A composite field.
- owner
Template: UserT.
- update
Template: ShortText.
- relatedContacts
Field components:
- An array.
-
Uses template:
contactT.
- contacts
Field components:
- An array.
-
Uses template:
contactT.
- deals
Field components:
- An array.
- Contains the following components: id, name.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/filter.The action has the following user-defined parameters:
- filter_id: Required. Please specify the filter identifier.
Documentation: https://github.com/agilecrm/rest-api#101-get-all-tickets-.
- [Create] action
-
Endpoint URL address:
/tickets/new-ticket.Documentation: https://github.com/agilecrm/rest-api#102-create-a-ticket.
- [Delete] action
-
Endpoint URL address:
/tickets/{{=item.id}}.Documentation: https://github.com/agilecrm/rest-api#103-delete-a-ticket.
- id
Template: Id.
- groupID
Template: ShortText.
- group
Field components:
-
Uses template:
Id. - Contains the following components: id, group_name, group_email.
-
Uses template:
- assigned_to_group
Data type: DT_BOOL
- assigneeID
Template: Id.
- assigned_time
Template: UnixTime.
- assignee
Template: UserT.
- requester_name
Template: ShortText.
- requester_email
Template: ShortText.
- contactID
Template: Id.
- subject
Template: ShortText.
- cc_emails
Template: LongText. A composite field.
- created_time
Template: UnixTime.
- last_updated_time
Template: UnixTime.
- last_updated_by
Template: ShortText.
- last_customer_replied_time
Template: UnixTime.
- first_notes_text
Template: ShortText.
- last_reply_text
Template: ShortText.
- is_compressed
Data type: DT_BOOL
- status
Template: ShortText.
- type
Template: ShortText.
- priority
Template: ShortText.
- source
Template: ShortText.
- created_by
Template: ShortText.
- user_replies_count
Data type: DT_I4
- no_of_reopens
Data type: DT_I4
- attachments_exists
Data type: DT_BOOL
- is_favorite
Data type: DT_BOOL
- is_spam
Data type: DT_BOOL
- requester_ip_address
Template: ShortText.
- html_text
Template: LongText.
- entity_type
Template: ShortText.
- attachments_list
Template: LongText. A composite field.
- labels
Template: LongText. A composite field.
- contact_ids
Template: LongText. A composite field.
- last_ticket_notes
Field components:
-
Uses template:
Id. - Contains the following components: id, plain_text, created_time, ticket_notes_assinee.
-
Uses template:
- contact
Template: contactT.
- dueOn
Template: ShortText.
- createdOn
Template: ShortText.
- lastUpdatedOn
Template: ShortText.
- attachments_existsString
Template: ShortText.
- is_favoriteString
Template: ShortText.
- stringTicketID
Template: ShortText.
- closedOn
Template: ShortText.
- statusName
Template: ShortText.
- priorityName
Template: ShortText.
- sourceFrom
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/filters.Documentation: https://github.com/agilecrm/rest-api#104-get-all-filter-ids-.
- id
Template: Id.
- name
Template: ShortText.
- conditions
Field components:
- An array.
- Contains the following components: LHS, CONDITION, RHS.
- owner_id
Template: Id.
- updated_time
Template: UnixTime.
- is_default_filter
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/notes/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. Please specify the ticket identifier.
Documentation: https://github.com/agilecrm/rest-api#105-get-all-messages-within-a-ticket-.
- [Create] action
-
Endpoint URL address:
/tickets/notes/{{=item.ticket_id}}.Documentation: https://github.com/agilecrm/rest-api#106-add-note-to-a-ticket-using-ticket-id-.
- ticket_id
Data type: DT_I4
- id
Template: Id.
- group_id
Template: Id.
- feedback_time
Template: UnixTime.
- feedback_comment
Template: ShortText.
- assignee_id
Template: Id.
- feedback_flag
Data type: DT_BOOL
- created_by
Template: ShortText.
- requester_name
Template: ShortText.
- requester_email
Template: ShortText.
- created_time
Template: UnixTime.
- event_description
Template: ShortText.
- plain_text
Template: ShortText.
- html_text
Template: ShortText.
- mime_object
Template: ShortText.
- note_type
Template: ShortText.
- attachments_list
Template: LongText. A composite field.
- requester_viewed_time
Data type: DT_I4
- domain_user
Template: UserT.
- cc_emails
Template: LongText. A composite field.
- close_ticket
Data type: DT_BOOL
- requester_viewed_email
Data type: DT_BOOL
- is_compressed
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/labels.Documentation: https://github.com/agilecrm/rest-api#105-get-all-messages-within-a-ticket-.
- [Create] action
-
Endpoint URL address:
/tickets/notes/{{=item.ticket_id}}.Documentation: https://github.com/agilecrm/rest-api#106-add-note-to-a-ticket-using-ticket-id-.
- id
A key field. Template: Id.
- label
Template: ShortText.
- created_time
Template: UnixTime. A read-only field.
- updated_time
Template: UnixTime. A read-only field.
- availableCount
Data type: DT_I4
- entity_type
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/groups.Documentation: https://github.com/agilecrm/rest-api#105-get-all-messages-within-a-ticket-.
- [Read current user] action
-
Endpoint URL address:
/tickets/groups/current-user.Documentation: https://github.com/agilecrm/rest-api#105-get-all-messages-within-a-ticket-.
- id
A key field. Template: Id.
- group_name
Template: ShortText.
- send_as
Template: ShortText.
- updated_time
Template: UnixTime.
- is_live_chat_enabled
Data type: DT_BOOL
- agents_keys
Template: LongText. A composite field.
- is_default
Data type: DT_BOOL
- group_email
Template: ShortText.
- group_users
Field components:
- An array.
-
Uses template:
UserT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/custom-fields/scope/position.The action has the following user-defined parameters:
- scope: Required. Select entity.
- id
A key field. Template: ShortText.
- field_type
Template: ShortText.
- version
Template: ShortText.
- field_label
Template: ShortText.
- field_description
Template: ShortText.
- field_data
Template: ShortText.
- is_required
Data type: DT_BOOL
- searchable
Data type: DT_BOOL
- showInFilter
Data type: DT_BOOL
- search_key
Template: ShortText.
- scope
Template: ShortText.
- position
Data type: DT_I4
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
cursor:
{{=parameters.iterator}} -
page_size:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
cursor:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Id
Data type: DT_I8
- Number
Data type: DT_R8
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=AgileCRM.getTimeStamp(value)}}expression. Before setting, the value is processed with{{=value && new Date(value).valueOf()}}expression.- CheckBox
Data type: DT_BOOL The gathered value is processed with
{{=value && value === 'on'}}expression.- productT
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, created_time, updated_time, price, qty, total, image.
-
Uses template:
- tagsWithTimeT
Field components:
-
Uses template:
ShortText. - Contains the following components: tag, createdTime, availableCount, entity_type.
-
Uses template:
- UserT
Field components:
-
Uses template:
Id. - Contains the following components: id, domain, email, phone, name, pic, schedule_id, calendar_url, calendarURL.
-
Uses template:
- contactT
Field components:
-
Uses template:
Id. - Contains the following components: id, type, created_time, updated_time, last_contacted, last_emailed, last_campaign_emaild, last_called, viewed_time, viewed, star_value, lead_score, klout_score, tags, tagsWithTime, campaignStatus, entity_type, source, unsubscribeStatus, emailBounceStatus, formId, browserId, lead_source_id, lead_status_id, is_lead_converted, lead_converted_time, is_duplicate_existed, trashed_time, restored_time, is_duplicate_verification_failed, is_client_import, concurrent_save_allowed, owner, domainUser, email, owner_email, score.
-
Uses template:
- NoteT
Field components:
-
Uses template:
Id. - Contains the following components: id, created_time, subject, email, description, entity_type, deal_ids, ids, contact_ids, contacts, domainOwner.
-
Uses template:
- eventT
Field components:
-
Uses template:
Id. - Contains the following components: id, start, end, is_event_starred, allDay, title, color, created_time, contacts, entity_type, type, backgroundColor, description, deal_ids, status, owner, search_range, owner_id, sendInvite, deals.
-
Uses template:
- custom_dataT
Field components:
- An array.
- Contains the following components: name, value.
- prefsT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, pic, template, width, currency, signature, task_reminder, currentDomainUserName.
-
Uses template:
- taskOwnerT
Field components:
-
Uses template:
Id. - Contains the following components: id, domain, email, is_admin.
-
Uses template:
- ownerT
Field components:
-
Uses template:
ShortText. - Contains the following components: cursor, count, id, domain, email, is_admin, is_account_owner, is_disabled, name, email_template.
-
Uses template:
- propertiesT
Field components:
- An array.
- Contains the following components: type, name, value.
- milestoneT
Field components:
-
Uses template:
ShortText. - Contains the following components: cursor, count, colorName, id, apply_discount, discount_value, discount_amt, discount_type, name, contact_ids, custom_data, products, description, expected_value, milestone, probability, close_date, owner_id, created_time, milestone_changed_time, track, entity_type, notes, note_ids, note_description, note_subject, note_created_time, pipeline_id, archived, won_date, lost_reason_id, deal_source_id, total_deal_value, updated_time, isCurrencyUpdateRequired, currency_conversion_value, currency_type, tags, tagsWithTime, owner, contacts.
-
Uses template:
- taskT
Field components:
-
Uses template:
Id. - Contains the following components: id, type, task_ending_time, priority_type, due, created_time, is_complete, contacts, subject, entity_type, notes, progress, status, taskOwner.
-
Uses template:
- dealT
Field components:
-
Uses template:
Id. - Contains the following components: id, name, custom_data, contacts, description, expected_value, isCurrencyUpdateRequired, pipeline_id, milestone, won_date, probability, close_date, created_time, updated_time, entity_type, note_created_time, milestone_changed_time, owner, prefs, pic, currency_conversion_value, note_ids, contact_ids, tags, colorName, lost_reason_id, deal_source_id, total_deal_value, apply_discount, discount_value, discount_amt, discount_type, notes, products.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.