Overview
Configuration is provided for establishing connections with the Alchemer 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 Alchemer REST API using COZYROC's REST Connection Manager.
Congratulations! You have now established a connection to your Alchemer instance.
In this guide, we will show how to read data from the Alchemer service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Alchemer service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://api.alchemer.com/v5
.
- OAuth 1
-
The authentication uses an authorized token.
The authentication has the following user-defined parameters:
- ConsumerKey: Required. Specify consumer key.
- ConsumerSecret: Required. Specify consumer secret.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=OA1a.getAuthorizationHeader(token, request)}}
Documentation: https://apihelp.alchemer.com/help/authentication.
- API KEY
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- api_token: Required. Please specify api_token.
- api_token_secret: Required. Please specify api_token_secret.
The following request parameters will be automatically processed during the authentication process:
-
api_token:
{{=connection.user.api_token}}
-
api_token_secret:
{{=connection.user.api_token_secret}}
Documentation: https://apihelp.alchemer.com/help/authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/account
.
The result is extracted from:{{=[response.data] }}
.Documentation: https://apihelp.alchemer.com/help/accountteams-object-v5.
- id
A key field. Data type: DT_I4
- organization
Template: ShortText.
- contact_phone
Template: ShortText.
- reseller
Data type: DT_BOOL
- resellers_customer_id
Template: ShortText.
- reseller_uuid
Template: ShortText.
- sso
Template: LongText. A composite field.
- date_created
Template: DateTime. A read-only field.
- login_link
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accountteams
.Documentation: https://apihelp.alchemer.com/help/accountteams-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/accountteams/{{=parameters.team_id}}
.
The result is extracted from:{{=[response.data]}}
.The action has the following user-defined parameters:
- team_id: Required. Please specify the team identifier.
Documentation: https://apihelp.alchemer.com/help/accountteams-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/accountteams
.Documentation: https://apihelp.alchemer.com/help/accountteams-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/accountteams/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/accountteams-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/accountteams/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/accountteams-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- team_name
Template: ShortText.
- description
Template: ShortText.
- default_role
Template: ShortText.
- status
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accountuser
.Documentation: https://apihelp.alchemer.com/help/accountuser-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/accountuser/{{=parameters.user_id}}
.
The result is extracted from:{{=[response.data]}}
.The action has the following user-defined parameters:
- user_id: Required. Please specify the user identifier.
Documentation: https://apihelp.alchemer.com/help/accountuser-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/accountuser
.The action has the following user-defined parameters:
- userID: Required. Please specify the userID.
Documentation: https://apihelp.alchemer.com/help/accountuser-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/accountuser/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/accountuser-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/accountuser/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/accountuser-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- username
Template: ShortText.
Template: ShortText.
- admin
Data type: DT_I4
- phone_support
Data type: DT_I4
- userdata
The gathered value is processed with
{{=_.values(value)}}
expression. Field components:- An array.
- Contains the following components: id, name, description, value.
- license
Template: ShortText.
- defaultteam
Template: ShortText.
- status
Template: ShortText.
- last_login
Template: ShortText.
- api_key
Template: ShortText.
- api_secret
Template: ShortText.
- [External]
-
The external fields URL address:
/accountuser/{{=parameters.userID}}
. The external fields list is extracted from:{{= _.values(response.data.userdata) }}
.- userdata.{{=external.name}}
Template: ShortText. Before setting, the value is processed with
{{=SG.getSetExtValue(field, value)}}
expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/domain
.
The result is extracted from:{{= [response.data] }}
.Documentation: https://apihelp.alchemer.com/help/domain-object-v5.
- [Read single] action
-
Endpoint URL address:
/domain/{{=parameters.domain_id}}
.
The result is extracted from:{{=[response.data] }}
.The action has the following user-defined parameters:
- domain_id: Required. Please specify the domain identifier.
Documentation: https://apihelp.alchemer.com/help/domain-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/domain
.Documentation: https://apihelp.alchemer.com/help/domain-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/domain/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/domain-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/domain/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/domain-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- customerID
Template: ShortText.
- type
Template: ShortText.
- domain
Template: ShortText.
- redirect
Template: ShortText.
- eStatus
Template: ShortText.
- created
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contactlist
.Documentation: https://apihelp.alchemer.com/help/contactlist-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/contactlist/{{=parameters.list_id}}
.
The result is extracted from:{{= [response.data] }}
.The action has the following user-defined parameters:
- list_id: Required. Please specify the list identifier.
Documentation: https://apihelp.alchemer.com/help/contactlist-object-v5#getcontactlist.
- [Create] action
-
Endpoint URL address:
/contactlist
.Documentation: https://apihelp.alchemer.com/help/contactlist-object-v5#createcontactlist.
- [Update] action
-
Endpoint URL address:
/contactlist/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/contactlist-object-v5#changecontactlist.
- [Delete] action
-
Endpoint URL address:
/contactlist/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/contactlist-object-v5#deletecontactlist.
- id
A key field. Data type: DT_I4
- list_name
Template: ShortText.
- date_modified
Template: DateTime. A read-only field.
- date_created
Template: DateTime. A read-only field.
- user_id_created
Data type: DT_I4
- user_id_modified
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contactlist/{{=parameters.list_id}}/contactlistcontact
.The action has the following user-defined parameters:
- list_id: Required. Please specify the contact list identifier.
Documentation: https://apihelp.alchemer.com/help/contactlistcontact-sub-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/contactlist/{{=parameters.list_id}}/contactlistcontact/{{=parameters.contact_id}}
.
The result is extracted from:{{= [response.data] }}
.The action has the following user-defined parameters:
- list_id: Required. Please specify the contact list identifier.
- contact_id: Required. Please specify the contact list contact identifier.
Documentation: https://apihelp.alchemer.com/help/contactlistcontact-sub-object-v5#getcontactlist.
- [Create] action
-
Endpoint URL address:
/contactlist/{{=item.contactlistid}}/contactlistcontact
.Documentation: https://apihelp.alchemer.com/help/contactlistcontact-sub-object-v5#createcontactlist.
- [Update] action
-
Endpoint URL address:
/contactlist/{{=item.contactlistid}}/contactlistcontact
.Documentation: https://apihelp.alchemer.com/help/contactlistcontact-sub-object-v5#changecontactlist.
- [Delete] action
-
Endpoint URL address:
/contactlist/{{=item.contactlistid}}/contactlistcontact/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/contactlistcontact-sub-object-v5#deletecontactlist.
- id
A key field. Data type: DT_I4
- email_address
Template: ShortText.
- status
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- organization
Template: ShortText.
- division
Template: ShortText.
- department
Template: ShortText.
- group
Template: ShortText.
- role
Template: ShortText.
- is_manager
Template: ShortText.
- team
Template: ShortText.
- home_phone
Template: ShortText.
- fax_phone
Template: ShortText.
- business_phone
Template: ShortText.
- mailing_address
Template: ShortText.
- mailing_address2
Template: ShortText.
- mailing_address_city
Template: ShortText.
- mailing_address_state
Template: ShortText.
- mailing_address_postal
Template: ShortText.
- mailing_address_country
Template: ShortText.
- title
Template: ShortText.
- url
Template: ShortText.
- contactlistid
Data type: DT_I4
- [External]
-
The external fields URL address:
/contactcustomfield
. The external fields list is extracted from:{{= _.values(response.data) }}
.- custom.{{=external.name}}
Template: {{=SG.getFieldTemplate(external.type)}}. Data type: DT_WSTR Before setting, the value is processed with
{{=SG.getSetExtValue(field, value)}}
expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contactcustomfield
.
The result is extracted from:{{=_.values(response.data)}}
.Documentation: https://apihelp.alchemer.com/help/contactcustomfield-object#getlist.
- [Read single] action
-
Endpoint URL address:
/contactcustomfield/{{=parameters.field_id}}
.
The result is extracted from:{{=[response.data]}}
.The action has the following user-defined parameters:
- field_id: Required. Please specify the field identifier.
Documentation: https://apihelp.alchemer.com/help/contactcustomfield-object#getcontactcustomfield.
- [Create] action
-
Endpoint URL address:
/contactcustomfield
.Documentation: https://apihelp.alchemer.com/help/contactcustomfield-object#createcontactcustomfield.
- [Update] action
-
Endpoint URL address:
/contactcustomfield/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/contactcustomfield-object#changecontactcustomfield.
- [Delete] action
-
Endpoint URL address:
/contactcustomfield/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/contactcustomfield-object#deletecontactcustomfield.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- type
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey
.Documentation: https://apihelp.alchemer.com/help/survey-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}
.
The result is extracted from:{{= [response.data] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/survey-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/
.Documentation: https://apihelp.alchemer.com/help/survey-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/survey-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/survey-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- team
Template: ShortText.
- type
Template: ShortText.
- status
Template: ShortText.
- created_on
Template: DateTime. A read-only field.
- modified_on
Template: DateTime. A read-only field.
- title
Template: ShortText.
- statistics
Template: ShortText. A read-only field.
- links
A read-only field. Field components:
-
Uses template:
ShortText
. - Contains the following components: edit, publish, default.
-
Uses template:
- blockby
Template: ShortText.
- theme
Template: ShortText.
- options
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: internal_title, overall_quota, auto_close, folder_id.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveypage
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/surveypage-sub-object-v5.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveypage/{{=parameters.page_id}}
.
The result is extracted from:{{= [response.data] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- page_id: Required. Please specify the page identifier.
Documentation: https://apihelp.alchemer.com/help/surveypage-sub-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveypage
.Documentation: https://apihelp.alchemer.com/help/surveypage-sub-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveypage/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveypage-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveypage/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveypage-sub-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- title
Field components:
-
Uses template:
ShortText
. - Contains the following components: English.
-
Uses template:
- description
Field components:
-
Uses template:
ShortText
. - Contains the following components: English.
-
Uses template:
- questions
Field components:
- An array.
- Contains the following components: id, base_type, type, title, shortname, varname, description, has_showhide_deps, comment, properties, options.
- properties
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:- Contains the following components: hidden, piped_from.
- survey_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveyquestion
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/surveyquestion-sub-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveyquestion/{{=parameters.question_id}}
.
The result is extracted from:{{= [response.data] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- question_id: Required. Please specify the question identifier.
Documentation: https://apihelp.alchemer.com/help/surveyquestion-sub-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveypage/{{=item.page_id}}/surveyquestion
.Documentation: https://apihelp.alchemer.com/help/surveyquestion-sub-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyquestion/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveyquestion-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyquestion/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveyquestion-sub-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- base_type
Template: ShortText.
- type
Template: ShortText.
- title
Field components:
-
Uses template:
ShortText
. - Contains the following components: English.
-
Uses template:
- shortname
Template: ShortText.
- varname
Template: LongText. A composite field.
- description
Template: LongText. A composite field.
- has_showhide_deps
Data type: DT_BOOL
- comment
Data type: DT_BOOL
- properties
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: option_sort, required, hidden, orientation, labels_right, map_key, show_title, question_description, question_description_above, soft-required, disabled, messages, hide_after_response, custom_css, break_after, url, exclude_number, placeholder, force_numeric, force_percent, force_currency, subtype, min_number, max_number, min_answers_per_row, minimum_response, mask, message, defaulttext, piped_from, max_total, max_total_noshow, must_be_max, maxfiles, extentions, variable_name, questionid, default_value, heatmap_image, data_type, data_json.
-
Uses template:
- options
Field components:
- An array.
- Contains the following components: id, title, value, properties.
- survey_id
A key field. Data type: DT_R8
- page_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveyquestion/{{=parameters.question_id}}/surveyoption
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- question_id: Required. Please specify the question identifier.
Documentation: https://apihelp.alchemer.com/help/surveyoption-sub-object-v5.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveyquestion/{{=parameters.question_id}}/surveyoption/{{=parameters.option_id}}
.
The result is extracted from:{{=[response.data]}}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- question_id: Required. Please specify the question identifier.
- option_id: Required. Please specify the option identifier.
Documentation: https://apihelp.alchemer.com/help/surveyoption-sub-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveypage/{{=item.page_id}}/surveyquestion/{{=item.question_id}}/surveyoption
.Documentation: https://apihelp.alchemer.com/help/surveyoption-sub-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyquestion/{{=item.question_id}}/surveyoption/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveyoption-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyquestion/{{=item.question_id}}/surveyoption/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveyoption-sub-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- title
Field components:
-
Uses template:
ShortText
. - Contains the following components: English.
-
Uses template:
- value
Template: ShortText.
- survey_id
A key field. Data type: DT_I4
- page_id
A key field. Data type: DT_I4
- question_id
A key field. Data type: DT_I4
- properties
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: other, requireother, na, none, all, fixed, heatmap-color, disabled.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveycampaign
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/surveycampaign-sub-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveycampaign/{{=parameters.id}}
.
The result is extracted from:{{= [response.data ] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- id: Required. Please specify the campaign identifier.
Documentation: https://apihelp.alchemer.com/help/surveycampaign-sub-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign
.Documentation: https://apihelp.alchemer.com/help/surveycampaign-sub-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveycampaign-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveycampaign-sub-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- invite_id
A key field. Data type: DT_I4
- type
Template: ShortText.
- link_type
Template: ShortText.
- subtype
Template: ShortText.
- status
Template: ShortText.
- name
Template: ShortText.
- uri
Template: ShortText.
- SSL
Template: ShortText.
- primary_theme_options
Template: ShortText.
- primary_theme_content
Template: ShortText.
- token_variables
Template: ShortText.
- limit_responses
Template: ShortText.
- close_message
Template: ShortText.
- linkdates
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
DateTime
. - Contains the following components: open, close.
-
Uses template:
- language
Template: ShortText.
- date_created
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- survey_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveycampaign/{{=parameters.campaign_id}}/surveycontact
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- campaign_id: Required. Please specify the campaign identifier.
Documentation: https://apihelp.alchemer.com/help/survey-contact-sub-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveycampaign/{{=parameters.campaign_id}}/surveycontact/{{=parameters.id}}
.
The result is extracted from:{{=[response.data] }}
.The action has the following user-defined parameters:
- survey_id: Required. Specify survey identifier.
- campaign_id: Required. Specify campaign identifier.
- contact_id: Required. Specify contact identifier.
Documentation: https://apihelp.alchemer.com/help/survey-contact-sub-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign/{{=item.campaign_id}}/surveycontact/
.Documentation: https://apihelp.alchemer.com/help/survey-contact-sub-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign/{{=item.campaign_id}}/surveycontact/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/survey-contact-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign/{{=item.campaign_id}}/surveycontact/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/survey-contact-sub-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- email_address
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- survey_id
Data type: DT_I4
- campaign_id
Data type: DT_I4
- organization
Template: ShortText.
- department
Template: ShortText.
- division
Template: ShortText.
- status
Template: ShortText.
- team
Template: ShortText.
- group
Template: ShortText.
- role
Template: ShortText.
- title
Template: ShortText.
- url
Template: ShortText.
- home_phone
Template: ShortText.
- fax_phone
Template: ShortText.
- business_phone
Template: ShortText.
- mailing_address
Template: ShortText.
- [External]
-
The external fields URL address:
/contactcustomfield
. The external fields list is extracted from:{{= _.values(response.data) }}
.- custom.{{=external.name}}
Template: {{=SG.getFieldTemplate(external.type)}}. Data type: DT_WSTR Before setting, the value is processed with
{{=SG.getSetExtValue(field, value)}}
expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveyresponse
.The action has the following user-defined parameters:
- survey_id: Required. Please provide the survey identifier.
Documentation: https://apihelp.alchemer.com/help/surveyresponse-sub-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveyresponse/{{=parameters.response_id}}
.
The result is extracted from:{{= [response.data] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please provide the survey identifier.
- response_id: Required. Please provide the response identifier.
Documentation: https://apihelp.alchemer.com/help/surveyresponse-sub-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyresponse
.Documentation: https://apihelp.alchemer.com/help/surveyresponse-sub-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyresponse/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveyresponse-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyresponse/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveyresponse-sub-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- contact_id
Template: ShortText.
- status
Template: ShortText.
- is_test_data
Template: ShortText.
- date_submitted
Template: ShortText.
- session_id
Template: ShortText.
- language
Template: ShortText.
- date_started
Template: ShortText.
- link_id
Template: ShortText.
- url_variables
Template: LongText. A composite field.
- ip_address
Template: ShortText.
- referer
Template: ShortText.
- user_agent
Template: ShortText.
- response_time
Template: ShortText.
- data_quality
Template: LongText. A composite field.
- longitude
Template: ShortText.
- latitude
Template: ShortText.
- country
Template: ShortText.
- city
Template: ShortText.
- region
Template: ShortText.
- postal
Template: ShortText.
- dma
Template: ShortText.
- survey_data
The gathered value is processed with
{{=_.values(value)}}
expression. Field components:- An array.
- Contains the following components: id, type, question, section_id, answer, answer_id, shown.
- survey_id
Data type: DT_I4
- option_sku
Template: Number.
- question_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveystatistic
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/surveystatistic-sub-object-v5.
- id
Data type: DT_I4
- type
Template: ShortText.
- breakdown
Field components:
- An array.
- Contains the following components: label, percentage, count.
- total responses
Template: ShortText.
- sum
Template: ShortText.
- average
Template: ShortText.
- stdDev
Template: ShortText.
- min
Template: ShortText.
- max
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveyreport
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/surveyreport-sub-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveyreport/{{=parameters.report_id}}
.
The result is extracted from:{{= [response.data] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- report_id: Required. Please specify the report identifier.
Documentation: https://apihelp.alchemer.com/help/surveyreport-sub-object-v5#getobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyreport/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveyreport-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveyreport/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveyreport-sub-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- survey_id
Data type: DT_I4
- name
Template: ShortText.
- title
Template: ShortText.
- type
Template: ShortText.
- status
Template: ShortText.
- last_run
Template: ShortText.
- created_on
Data type: DT_R8 A read-only field.
- modified_on
Data type: DT_R8 A read-only field.
- created_by
Data type: DT_I4
- modified_by
Data type: DT_I4
- published
Data type: DT_BOOL
- password_protected
Data type: DT_I4
- responses
Data type: DT_I4
- version
Template: ShortText.
- publish_link
Template: ShortText.
- scheduled
Field components:
-
Uses template:
ShortText
. - Contains the following components: type, status, next_run, last_run, recurring.
-
Uses template:
- filters
Field components:
-
Uses template:
ShortText
. - Contains the following components: filter, filter_map.
-
Uses template:
- filter_dates
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
Date
. - Contains the following components: after, before.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveycampaign/{{=parameters.campaign_id}}/emailmessage
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- campaign_id: Required. Please specify the campaign identifier.
Documentation: https://apihelp.alchemer.com/help/emailmessage-sub-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/surveycampaign/{{=parameters.campaign_id}}/emailmessage/{{=parameters.message_id}}
.
The result is extracted from:{{= [response.data] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- campaign_id: Required. Please specify the campaign identifier.
- message_id: Required. Please specify the message identifier.
Documentation: https://apihelp.alchemer.com/help/emailmessage-sub-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign/{{=item.campaign_id}}/emailmessage
.Documentation: https://apihelp.alchemer.com/help/emailmessage-sub-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign/{{=item.campaign_id}}/emailmessage/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/emailmessage-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveycampaign/{{=item.campaign_id}}/emailmessage/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/emailmessage-sub-object-v5#deleteobject.
- id
A key field. Template: ShortText.
- subtype
Template: ShortText.
- message_type
Template: ShortText.
- medium
Template: ShortText.
- invite_identity
Template: ShortText.
- status
Template: ShortText.
- subject
Template: ShortText.
- footer
Template: ShortText.
- date_created
Template: DateTime. A read-only field.
- date_modified
Template: DateTime. A read-only field.
- embed_question
Data type: DT_BOOL
- disable_styles
Data type: DT_BOOL
- surveyid
A key field. Data type: DT_R8
- campaign_id
Data type: DT_I4
- replies
Template: ShortText.
- from
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: name, email.
-
Uses template:
- body
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
LongText
. - Contains the following components: text, html.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/quotas
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/quotas-sub-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/quotas/{{=parameters.quota_id}}
.
The result is extracted from:{{= [response] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- quota_id: Required. Please specify the quota identifier.
Documentation: https://apihelp.alchemer.com/help/quotas-sub-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/quotas
.Documentation: https://apihelp.alchemer.com/help/quotas-sub-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/quotas/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/quotas-sub-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/quotas/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/quotas-sub-object-v5#deleteobject.
- id
Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- limit
Template: ShortText.
- responses
Template: ShortText.
- distributed
Template: ShortText.
- groups
Field components:
- An array.
- Contains the following components: id, rules.
- survey_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/reporting
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/reporting-object.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/reporting/{{=parameters.report_id}}
.
The result is extracted from:{{= [response.result] }}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- report_id: Required. Please specify the report identifier.
Documentation: https://apihelp.alchemer.com/help/reporting-object#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/reporting
.Documentation: https://apihelp.alchemer.com/help/reporting-object#createobject.
- [Update] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/reporting/{{=item.report_id}}
.Documentation: https://apihelp.alchemer.com/help/reporting-object#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/reporting/{{=item.report_id}}
.Documentation: https://apihelp.alchemer.com/help/reporting-object#deleteobject.
- report_id
A key field. Data type: DT_I4
- survey_id
A key field. Data type: DT_I4
- report_name
Template: ShortText.
- status
Template: ShortText.
- data_ready
Data type: DT_BOOL
- data_progress
Data type: DT_I4
- public_url
Template: ShortText.
- element_options
Template: LongText. A composite field.
- elements_ready
Template: LongText. A composite field.
- options
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: name.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/surveytheme
.
The result is extracted from:{{=_values(response.data)}}
.Documentation: https://apihelp.alchemer.com/help/surveytheme-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/surveytheme/{{=parameters.theme_id}}
.
The result is extracted from:{{= _.values([response.data]) }}
.The action has the following user-defined parameters:
- theme_id: Required. Please specify the theme identifier.
Documentation: https://apihelp.alchemer.com/help/surveytheme-object-v5#getobject.
- [Create] action
-
Endpoint URL address:
/surveytheme
.Documentation: https://apihelp.alchemer.com/help/surveytheme-object-v5#createobject.
- [Update] action
-
Endpoint URL address:
/surveytheme/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveytheme-object-v5#updateobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/surveytheme/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/surveytheme-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- status
Template: ShortText.
- created
Template: DateTime. A read-only field.
- name
Template: ShortText.
- style_options
Field components:
-
Uses template:
ShortText
. - Contains the following components: custom-head, theme_version, header image url, image align, img width, img width max, body background opacity, background image style, body background color, background grad orient, header background color, header background opacity, page background color, accent, accent text, title font family, title font size, title font weight, header text color, base font family, base font size, base font weight, base font color, survey title, title align, page title, page title align, page description, question numbers, required ast, question border, back button, progress bar, survey width number, survey width unit, page width number, page width unit, survey round corner number, question title, survey width, page width, powered by, auto mobile, so-masthead-image-show, replace icons, custom-head checked, theme_version checked, header image url checked, image align checked, img width checked, img width max checked, body background opacity checked, background image style checked, body background color checked, background grad orient checked, header background color checked, header background opacity checked, page background color checked, accent checked, accent text checked, title font family checked, title font size checked, title font weight checked, header text color checked, base font family checked, base font size checked, base font weight checked, base font color checked, survey title checked, title align checked, page title checked, page title align checked, page description checked, question numbers checked, required ast checked, question border checked, back button checked, progress bar checked, survey width number checked, survey width unit checked, page width number checked, page width unit checked, survey round corner number checked, question title checked, survey width checked, page width checked, powered by checked, auto mobile checked, so-masthead-image-show checked, replace icons checked, theme_id, style mode, theme_upgraded, background image, background gradient, page background opacity, title web font name, title web font url, base web font name, base web font url, page top margin, comment width, table header width, column width.
-
Uses template:
- Body
Template: ShortText.
- css
Template: ShortText.
- header_image_url
Template: ShortText.
- image_align
Template: ShortText.
- img_width
Template: ShortText.
- img_width_max
Template: ShortText.
- survey_title
Template: ShortText.
- page_title
Template: ShortText.
- background_image
Template: ShortText.
- accent
Template: ShortText.
- question_numbers
Template: ShortText.
- custom_html
Template: ShortText.
- survey_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sso
.
The result is extracted from:{{=_.values(response.data)}}
.Documentation: https://apihelp.alchemer.com/help/sso-object-v5#getlist.
- [Read single] action
-
Endpoint URL address:
/sso/{{=parameters.sso_id}}
.
The result is extracted from:{{=_.values(response.data)}}
.The action has the following user-defined parameters:
- sso_id: Required. Please specify the SSO identifier.
Documentation: https://apihelp.alchemer.com/help/sso-object-v5#getlist.
- [Create] action
-
Endpoint URL address:
/sso
.The following request parameters will be automatically processed:
-
attributes[attribute name]:
{{=item.attribute_name}}
-
attributes[attribute name]:
- [Update] action
-
Endpoint URL address:
/sso/{{=item.id}}
.The following request parameters will be automatically processed:
-
attributes[attribute name]:
{{=item.attribute_name}}
Documentation: https://apihelp.alchemer.com/help/sso-object-v5#updateobject.
-
attributes[attribute name]:
- [Delete] action
-
Endpoint URL address:
/domain/{{=item.domain_id}}
.Documentation: https://apihelp.alchemer.com/help/sso-object-v5#deleteobject.
- id
A key field. Data type: DT_I4
- entity_id
Data type: DT_I4
- login
Template: ShortText.
- logout
Template: ShortText.
- cert_fingerprint
Template: ShortText.
- customerid
Template: ShortText.
- created
Data type: DT_R8 A read-only field.
- dModified
Data type: DT_R8 A read-only field.
- status
Template: ShortText.
- cert_domain
Template: ShortText.
- user_last_modified
Data type: DT_R8 A read-only field.
- creatusers
Data type: DT_BOOL
- userteam
Template: ShortText.
- userlicense
Template: ShortText.
- userrole
Template: ShortText.
- iUserIDCreated
Template: ShortText.
- usersolo
Template: ShortText.
- email_notification
Template: ShortText.
- disable_users
Template: ShortText.
- weeks_to_disable
Template: ShortText.
- type
Template: ShortText.
- attributes
Template: LongText. A composite field.
- name
Template: ShortText.
- force_sso_login
Template: ShortText.
- user_deleted
Data type: DT_R8 A read-only field.
- deleted
Template: ShortText.
- sp_metadata
Template: ShortText.
- sp_login
Template: ShortText.
- attribute_name
Template: ShortText.
- domain_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/results
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
Documentation: https://apihelp.alchemer.com/help/results-object.
- report_id
A key field. Data type: DT_I4
- survey_id
Data type: DT_I4
- report_name
Template: ShortText.
- status
Template: ShortText.
- data_ready
Data type: DT_BOOL
- data_progress
Data type: DT_I4
- public_url
Template: ShortText.
- element_options
Template: LongText. A composite field.
- elements_ready
Field components:
- Contains the following components: 2, 3, responsemetrics_5f6b0b0d51a1f, map_5f6b0b0d51b3a.
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
/survey/{{=parameters.survey_id}}/reporting/{{=parameters.report_id}}/reportelement/{{=parameters.element_id}}
.
The result is extracted from:{{=[response.result]}}
.The action has the following user-defined parameters:
- survey_id: Required. Please specify the survey identifier.
- report_id: Required. Please specify the report identifier.
- element_id: Required. Please specify the element identifier.
Documentation: https://apihelp.alchemer.com/help/reportelement-object#getobject.
- [Create] action
-
Endpoint URL address:
/survey/{{=item.survey_id}}/reporting/{{=item.report_id}}/reportelement
.Documentation: https://apihelp.alchemer.com/help/reportelement-object#createobject.
- [Delete] action
-
Endpoint URL address:
/survey/{{=item.surveyid}}/reporting/{{=item.report_id}}/reportelement/{{=item.id}}
.Documentation: https://apihelp.alchemer.com/help/reportelement-object#deleteobject.
- id
A key field. Data type: DT_I4
- total
Data type: DT_I4
- buckets
Field components:
- An array.
- Contains the following components: bucket, count, percent, option_title, rep_val.
- survey_id
Data type: DT_I4
- report_id
Data type: DT_I4
- options
Before setting, the value is processed with
{{=SG.getSetValue(value)}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: type, script_id, question.
-
Uses template:
- [Read] action
-
The result is extracted from:{{=response.data}}
.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
-
resultsperpage:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The result is extracted from:{{=response.data}}
.
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
item:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The result is extracted from:{{=response.data}}
.
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
item:
{{=item}}
-
_includeUserParameters:
- [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
- Number
Data type: DT_R8
What's New
- New: Introduced connection.
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.