Overview
Configuration is provided for establishing connections with Act-On via its REST API. The configuration is used in the REST Connection Manager.
Quick Start
In this task, we will show you step-by-step how to create a connection to a Act-On 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 Act-On. You have 2 types of authentication:
Authentication Password Based
In this authentication mode you need to provide Username, Password, client_id and client_secret received in your welcome email.
Authentication Code Based
In this authentication mode you need to specify a Token (via a Wizard) and to save the credentials to a password-protected Token file.
To obtain/specify an access token you need to perform the following 3 steps:
Step A: Provide application Scope or leave Scope field empty to gain application full access.
Step B: Provide Username and Password
Step C: Save generated access token to file.
Step 3: After setting up the authentication method, test your connection by clicking Test connection button.
Step 1. Open the right side panel and drag and drop REST Source component. Double click on it and select Rest Act-On connection, select from available Act-On resources listed in second drop-down menu (List) and click OK
Step 2. Check resource metadata by selecting Columns
Step 3. If necessary, you can configure the Error Output
Step 4. Connect REST Source component to desired destination component and edit mapping.
Step 1. Drag and drop REST Destination component from the SSIS Toolbox. Double click on it and select Rest Act-On connection, select from available Act-On resources listed in third drop-down menu (List) , select from available Action listed in second drop-down menu (Create).
Step 2. Connect desired source component to newly created REST Destination component and map columns.
Step 3. If necessary, you can configure the Error Output.
Configuration
Base URL address: https://restapi.actonsoftware.com/api/1.
- Password Based
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- username: Required. Specify user name.
- password: Required. Specify password.
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
For further information, please check here.
- Code Based
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
For further information, please check here.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- LargeText
Data type: DT_NTEXT
- DateTime
Data type: DT_DBTIMESTAMP
- UnixTimeStamp
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(parseFloat(value))}}expression. Before setting, the value is processed with{{=value && Math.floor(new Date(value).getTime()/1000.0)}}expression.- Userspecs
Field components:
-
Uses template:
ShortText. - Contains the following components: userType, email, firstName, lastName, password, title, phoneNumber, mobileNumber, faxNumber, timeZone, sendEmailConfirmation, marketingPrivileges, contactLists, content, programs, accountWideEmail.
-
Uses template:
- SEOCount
Field components:
- Contains the following components: error, good, warning.
- SEORule
Field components:
-
Uses template:
ShortText. - Contains the following components: icon, title, description.
-
Uses template:
- Uploadspecs
Field components:
-
Uses template:
ShortText. - Contains the following components: columnHeading, ignoreColumn, columnType, columnIndex.
-
Uses template:
- Mergespecs
Field components:
-
Uses template:
ShortText. - Contains the following components: dstListId, mergeMode, mergeKeyHeading, createSegment, columnMap.
-
Uses template:
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
item:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
item:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- [Read getSenders] action (alias: "Get email senders")
-
Endpoint URL address:
/account/senders.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
For further information check here.
-
_includeUserParameters:
- [Read getAccountInfo] action (alias: "Get account information")
-
Endpoint URL address:
/account.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
For further information check here.
-
_includeUserParameters:
- [Create] action
-
Endpoint URL address:
/user.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item.userspecs}}
For further information check here.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/user/{{=item.email}}.
The action uses DELETE method.For further information check here.
- cell
Template: ShortText. A read-only field.
- uuid
Template: ShortText. A read-only field.
- verified
Data type: DT_BOOL A read-only field.
- phone
Template: ShortText. A read-only field.
Template: ShortText.
- title
Template: ShortText. A read-only field.
- fax
Template: ShortText. A read-only field.
- name
Template: ShortText. A read-only field.
- account_id
Data type: DT_I4 A read-only field.
- cname
Template: ShortText. A read-only field.
- user_name
Template: ShortText. A read-only field.
- user_email
Template: ShortText. A read-only field.
- account_name
Template: ShortText. A read-only field.
- user_type
Template: ShortText. A read-only field.
- userspecs
Field components:
- An array.
-
Uses template:
Userspecs.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customevents/{{=parameters.jobid}}/status.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- jobid: Required. ID returned by upload request.
For further information check here.
- [Create] action
-
Endpoint URL address:
/customevents.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- status
Template: ShortText. A read-only field.
- jobDetails
Template: LongText. A read-only field.
- details
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: status, customEventsId, appendCount, rejectedCount, rejectedRecordsUrl.
-
Uses template:
- destination
Template: ShortText.
- firstrow
Template: ShortText.
- fieldseparator
Template: ShortText.
- quotecharacter
Template: ShortText.
- customeventaction
Template: ShortText.
- emailcolidx
Template: ShortText.
- datecolidx
Template: ShortText.
- titlecolidx
Template: ShortText.
- notecolidx
Template: ShortText.
- titlecount
Template: ShortText.
- dateformat
Template: ShortText.
- filename
Template: ShortText.
- fileMimeType
Template: ShortText.
- file
Data type: DT_IMAGE
Based on resource template Base.
- [Read getMessageReport] action (alias: "Get message report")
-
Endpoint URL address:
/message/{{=parameters.id}}/report.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. The id of the message on which you want a report.
For further information check here.
- [Read getMessageReportDrilldown] action (alias: "Get message report drilldown")
-
Endpoint URL address:
/message/{{=parameters.id}}/report/{{=parameters.drilldown}}.
The result is extracted from:{{=response.result}}.The action has the following user-defined parameters:
- id: Required. The id of the message to get a report about.
- drilldown: Required. The drilldown type. Valid values:SENT;SUPPRESSED;OPENED;CLICKED;BOUNCED;OPT_OUT,SPAM
For further information check here.
- [Read getMessageReportByTimePeriod] action (alias: "Get message report by time period")
-
Endpoint URL address:
/message/report.
The result is extracted from:{{=response.counts}}.The action has the following user-defined parameters:
- period: The time period for which you are requesting a report.
For further information check here.
- status
Template: ShortText.
- delivered
Data type: DT_I4
- opened
Template: LongText. A composite field.
- clicked
Template: LongText. A composite field.
- notsent
Template: LongText. A composite field.
- notopened
Data type: DT_I4
- optout
Data type: DT_I4
- spam
Data type: DT_I4
- lastOpen
Template: ShortText.
- lastClick
Template: ShortText.
- lastOpenTS
Template: UnixTimeStamp.
- lastClickTS
Template: UnixTimeStamp.
- rebroadcast
Data type: DT_I4
- rebroadcastClick
Data type: DT_I4
- msgId
Template: ShortText.
- subject
Template: ShortText.
- ts
Template: UnixTimeStamp.
Template: ShortText.
- recid
Template: ShortText.
- when
Template: ShortText.
- name
Template: ShortText.
- listid
Template: ShortText.
- optedOut
Data type: DT_I4
- sent
Data type: DT_I4
- dayOfMonth
Data type: DT_I4
- bounced
Data type: DT_I4
- dayOfWeek
Data type: DT_I4
Based on resource template Base.
- [Read getMediaReport] action (alias: "Get media report")
-
Endpoint URL address:
/media/{{=parameters.id}}/report.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. The id of the media object on which you want a report.
For further information check here.
- [Read getMediaMessageReport] action (alias: "Get media message report")
-
Endpoint URL address:
/media/{{=parameters.id}}/report/messages.The action has the following user-defined parameters:
- id: Required. The id of the media object on which you want a message report.
For further information check here.
- [Read getMediaViewReport] action (alias: "Get media view report")
-
Endpoint URL address:
/media/{{=parameters.id}}/report/views.The action has the following user-defined parameters:
- id: Required. The id of the media object you want a views report on.
For further information check here.
- [Read getMediaTimelineReport] action (alias: "Get media timeline report")
-
Endpoint URL address:
/media/{{=parameters.id}}/report/timeline.The action has the following user-defined parameters:
- id: Required. The id of the media object you want a timeline report for.
For further information check here.
- total_known_views
Data type: DT_I4
- total_unknown_views
Data type: DT_I4
- unique_known_views
Data type: DT_I4
- unique_unknown_views
Data type: DT_I4
- total_messages
Data type: DT_I4
- total_from_messages
Data type: DT_I4
- unique_from_messages
Data type: DT_I4
- msgid
Template: ShortText.
- subject
Template: ShortText.
- total_count
Data type: DT_I4
- unique_count
Data type: DT_I4
- timestamp
Template: DateTime.
- recipient
Template: ShortText.
- campaign
Template: ShortText.
- action
Template: ShortText.
- srcid
Template: ShortText.
- cid
Template: ShortText.
- tstamp
Template: DateTime.
- date
Data type: DT_DBDATE
- unique
Data type: DT_I4
- total
Data type: DT_I4
- known
Data type: DT_I4
- unknown
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.id}}/report.
The result is extracted from:{{=response.result}}.The action has the following user-defined parameters:
- id: Required. ID of the form.
For further information check here.
- source
Template: ShortText.
- submits
Data type: DT_I4
- unique
Data type: DT_I4
- views
Data type: DT_I4
- percent
Data type: DT_I4
- non_submitters
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/page/{{=parameters.id}}/report.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. The Act-On id of the page for which you want a report.
For further information check here.
- unique_known_visits
Data type: DT_I4
- unique_unknown_visits
Data type: DT_I4
- unique_known_clicks
Data type: DT_I4
- unique_unknown_clicks
Data type: DT_I4
- total_visits
Data type: DT_I4
- total_clicks
Data type: DT_I4
- incoming_traffic
Field components:
- Contains the following components: Default.
- outgoing_clicks
Template: LongText. A composite field.
Based on resource template Base.
- [Read getSpamcomplaintList] action (alias: "Get spam complaint list")
-
Endpoint URL address:
/list/spamcomplaint.
The result is extracted from:{{=response.result}}.For further information check here.
- [Read getHardBounceList] action (alias: "Get hard bounce list")
-
Endpoint URL address:
/list/hardbounce.
The result is extracted from:{{=response.result}}.For further information check here.
- [Read getOptoutList] action (alias: "Get optout list")
-
Endpoint URL address:
/list/optout.
The result is extracted from:{{=response.result}}.For further information check here.
- [Read getSubscriptionOptoutsByCategory] action (alias: "Get subscriptions opt-outs by category")
-
Endpoint URL address:
/subscription/optout.
The result is extracted from:{{=response.result}}.The action has the following user-defined parameters:
- category: Required. The subscription category (by name) you would like to obtain an itemized list of opted-out records.
For further information check here.
Template: ShortText.
- timestamp
Template: UnixTimeStamp.
- origin
Template: ShortText.
Based on resource template Base.
- [Read getSEOKeywords] action (alias: "Get SEO keywords")
-
Endpoint URL address:
/seokeywords.The action has the following user-defined parameters:
- url: Required. The URL-encoded URL string on which to generate a report.
For further information check here.
- [Read getNewSEOReport] action (alias: "Get new SEO report")
-
Endpoint URL address:
/seoreport.The action has the following user-defined parameters:
- url: Required. The URL-encoded URL string on which to generate a report.
- keyword: Required. Keyword to use when generating the report. If the keyword isn't already defined in the set of existing keywords in the account, it will be added.
For further information check here.
- seoId
Template: ShortText.
- urlResults
Field components:
-
Uses template:
SEOCount. - Contains the following components: counts, rules.
-
Uses template:
- titleResults
Field components:
-
Uses template:
SEOCount. - Contains the following components: counts, rules.
-
Uses template:
- h1Results
Field components:
-
Uses template:
LongText. - Contains the following components: additionalH1, counts, rules.
-
Uses template:
- descriptionResults
Field components:
-
Uses template:
SEOCount. - Contains the following components: counts, rules.
-
Uses template:
- altTagResults
Field components:
-
Uses template:
SEOCount. - Contains the following components: counts, altTags.
-
Uses template:
- counts
Template: SEOCount.
- bodyResults
Field components:
-
Uses template:
SEOCount. - Contains the following components: counts, rules.
-
Uses template:
- fields
Field components:
-
Uses template:
ShortText. - Contains the following components: title, description, selectedKeywordsTerms, selectedKeywords, url.
-
Uses template:
- id
Template: ShortText.
- text
Template: LongText.
Based on resource template Base.
- [Read getListingOfLists] action (alias: "Get listing of lists")
-
Endpoint URL address:
/list.
The result is extracted from:{{=response.result}}.For further information check here.
- [Read getListUploadStatus] action (alias: "Get list upload status")
-
Endpoint URL address:
/list/{{=parameters.jobid}}/status.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- jobid: Required. The jobid of the list upload.
For further information check here.
- [Create] action
-
Endpoint URL address:
/list.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- [Update] action
-
Endpoint URL address:
/list/{{=item.id}}.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- [Delete] action
-
Endpoint URL address:
/list/{{=item.id}}.For further information check here.
- status
Template: ShortText. A read-only field.
- jobDetails
Template: LongText. A read-only field.
- details
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: status, listId, appendCount, updateCount, failedCount, rejectedCount, rejectedRecordsUrl.
-
Uses template:
- id
A key field. Template: ShortText.
- name
Template: ShortText. A read-only field.
- folderName
Template: ShortText. A read-only field.
- sourceId
Template: ShortText. A read-only field.
- baseId
Template: ShortText. A read-only field.
- description
Template: ShortText. A read-only field.
- sourceSize
Template: ShortText. A read-only field.
- sourceName
Template: ShortText. A read-only field.
- tsLastModified
Template: UnixTimeStamp. A read-only field.
- tsLastCounted
Template: UnixTimeStamp. A read-only field.
- tsSource
Template: UnixTimeStamp. A read-only field.
- sourceTS
Template: ShortText. A read-only field.
- bIsSingleton
Data type: DT_BOOL A read-only field.
- bIsList
Data type: DT_BOOL A read-only field.
- bIsSforce
Data type: DT_BOOL A read-only field.
- bIsSforceReport
Data type: DT_BOOL A read-only field.
- bIsSforceAvailable
Data type: DT_BOOL A read-only field.
- bIsMSDyn
Data type: DT_BOOL A read-only field.
- bIsMSDynAvailable
Data type: DT_BOOL A read-only field.
- bIsSugar
Data type: DT_BOOL A read-only field.
- bIsSugarAvailable
Data type: DT_BOOL A read-only field.
- bIsSL
Data type: DT_BOOL A read-only field.
- bIsSLAvailable
Data type: DT_BOOL A read-only field.
- bIsNsuite
Data type: DT_BOOL A read-only field.
- bIsNsuiteAvailable
Data type: DT_BOOL A read-only field.
- listname
Template: ShortText.
- foldername
Template: ShortText.
- headings
Template: ShortText.
- fieldseparator
Template: ShortText.
- quotecharacter
Template: ShortText.
- putEmptyValues
Template: ShortText.
- filename
Template: ShortText.
- fileMimeType
Template: ShortText.
- file
Data type: DT_IMAGE
- uploadspecs
Field components:
- An array.
-
Uses template:
Uploadspecs.
- mergespecs
Field components:
- An array.
-
Uses template:
Mergespecs.
- [Read getContactRecord] action (alias: "Get contact record")
-
Endpoint URL address:
/list/{{=parameters.listid}}/record/{{=parameters.recordid}}.
The result is extracted from:{{=[{contactData:response}]}}.The action has the following user-defined parameters:
- listid: Required. The listid of the list.
- recordid: Required. The recordid of the contact.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
For further information check here.
- [Read getContactFactData] action (alias: "Get contact fact and score data")
-
Endpoint URL address:
/list/{{=parameters.listid}}/record/{{=parameters.recordid}}/facts.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- listid: Required. The listid of the list.
- recordid: Required. The recordid of the contact.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
For further information check here.
- [Create] action
-
Endpoint URL address:
/list/{{=item.listid}}/record.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item.columnNamesAndContent}} -
returncontact:
{{=item.returncontact}}
For further information check here.
-
application/json:
- [Update] action
-
Endpoint URL address:
/list/{{=item.listid}}/record/{{=item.recordid}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item.columnNamesAndContent}} -
returncontact:
{{=item.returncontact}}
For further information check here.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/list/{{=item.listid}}/record/{{=item.recordid}}.
The action uses DELETE method.For further information check here.
- listid
A key field. Template: ShortText.
- recordid
A key field. Template: ShortText.
- columnNamesAndContent
Template: LargeText. A composite field.
- contactData
Template: LargeText. A read-only field.
- returncontact
Template: ShortText.
- contactids
Template: LongText.
- activity
Field components:
-
Uses template:
ShortText. - Contains the following components: score, firstOutbound, lastOutbound, firstInbound, lastInbound, scorePeriod, scoreDetails, entryMonthsAvailable, hasProfileScore, hasScoreSheet, hasBehaviorScore, entries.
-
Uses template:
- activitylist
A read-only field. Field components:
- An array.
- Contains the following components: verb, idType, what, clickJS, adwordsId, whenMillis, inScoreRange, ago, id, d, y, responses, bin, icon, m.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/list/{{=parameters.id}}.
The result is extracted from:{{=ActOn.getCsvData(response)}}.The action has the following user-defined parameters:
- id: Required. The id of list.
The following request parameters will be automatically processed:
-
responseformat:
CSV
For further information check here.
- [Delete] action
-
Endpoint URL address:
/list/{{=parameters.listid}}/record.The action has the following user-defined parameters:
- listid: Required. The id of list.
- contactids: Required. A comma delimited list of recids you want to delete (example: l-761:f,l-761:6).
For further information check here.
- [External]
-
The external fields URL address:
/list/{{=parameters.id}}. The external fields list is extracted from:{{=ActOn.getCsvFields(response)}}.- {{=external.name}}
Template: {{=external.template}}.
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/list/optout.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- filename
Template: ShortText.
- fileMimeType
Template: ShortText.
- file
Data type: DT_IMAGE
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/message.
The result is extracted from:{{=response.msgresult}}.The action has the following user-defined parameters:
- type: Alllowed values: DRAFT, TEMPLATE, SENT, TRIGGERED, FAILED, SCHEDULED
For further information check here.
- [Create] action
-
Endpoint URL address:
/message/{{=item.msg_id}}/send.For further information check here.
- [Update] action
-
Endpoint URL address:
/message/{{=item.msg_id}}/send.For further information check here.
- [Delete] action
-
Endpoint URL address:
/message/{{=item.msg_id}}.For further information check here.
- msg_id
A key field. Template: ShortText.
- time_when
Template: ShortText. A read-only field.
- folder_name
Template: ShortText. A read-only field.
- timestamp
Template: UnixTimeStamp. A read-only field.
- title
Template: ShortText.
- iscustom
Template: ShortText.
- istextonly
Template: ShortText.
- istransactional
Template: ShortText.
- issuppressduplicates
Template: ShortText.
- senderemail
Template: ShortText.
- sendername
Template: ShortText.
- sendtoids
Template: LongText.
- suppressids
Template: LongText.
- sendtorecids
Template: LongText.
- when
Template: UnixTimeStamp.
- subject
Template: ShortText.
- htmlbody
Template: LargeText.
- textbody
Template: LargeText.
- headerid
Template: ShortText.
- footerid
Template: ShortText.
- categoryid
Template: ShortText.
- logoid
Template: ShortText.
- whenend
Template: UnixTimeStamp.
- timezone
Template: ShortText.
- createcrmmsgsentnotes
Data type: DT_BOOL
- replytoemail
Template: ShortText.
- replytoname
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/message.For further information check here.
- [Update] action
-
Endpoint URL address:
/message/{{=item.id}}.For further information check here.
- id
A key field. Template: ShortText.
- type
Template: ShortText.
- title
Template: ShortText.
- senderemail
Template: ShortText.
- sendername
Template: ShortText.
- foldername
Template: ShortText.
- subject
Template: ShortText.
- htmlbody
Template: LargeText.
- textbody
Template: LargeText.
- headerid
Template: ShortText.
- footerid
Template: ShortText.
- logoid
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/logo.
The result is extracted from:{{=response.result}}.For further information check here.
- [Create] action
-
Endpoint URL address:
/logo.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- [Update] action
-
Endpoint URL address:
/logo/{{=item.id}}.For further information check here.
- [Delete] action
-
Endpoint URL address:
/logo/{{=item.id}}.For further information check here.
- id
A key field. Template: ShortText.
- url_str
Template: ShortText. A read-only field.
- url_str_ts
Template: ShortText. A read-only field.
- alt_txt
Template: ShortText. A read-only field.
- tool_tip
Template: ShortText. A read-only field.
- target_url
Template: ShortText. A read-only field.
- title
Template: ShortText. A read-only field.
- name
Template: ShortText.
- alttext
Template: ShortText.
- tooltip
Template: ShortText.
- targeturl
Template: ShortText.
- imagelink
Template: ShortText.
- filename
Template: ShortText.
- fileMimeType
Template: ShortText.
- file
Data type: DT_IMAGE
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/header.
The result is extracted from:{{=response.result}}.For further information check here.
- [Create] action
-
Endpoint URL address:
/header.For further information check here.
- [Update] action
-
Endpoint URL address:
/header/{{=item.id}}.For further information check here.
- [Delete] action
-
Endpoint URL address:
/header/{{=item.id}}.For further information check here.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- text
Template: LargeText.
- html
Template: LargeText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/footer.
The result is extracted from:{{=response.result}}.For further information check here.
- [Create] action
-
Endpoint URL address:
/footer.For further information check here.
- [Update] action
-
Endpoint URL address:
/footer/{{=item.id}}.For further information check here.
- [Delete] action
-
Endpoint URL address:
/footer/{{=item.id}}.For further information check here.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- text
Template: LargeText.
- html
Template: LargeText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/image.For further information check here.
- [Create] action
-
Endpoint URL address:
/image.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- [Update] action
-
Endpoint URL address:
/image/{{=item.id}}.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- [Delete] action
-
Endpoint URL address:
/image/{{=item.id}}.For further information check here.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- foldername
Template: ShortText.
- ignorefolder
Template: ShortText.
- entries
A read-only field. Field components:
- An array.
- Contains the following components: id, last_modified, height, width, name, creation_time, thumb, url, size.
- filename
Template: ShortText.
- fileMimeType
Template: ShortText.
- file
Data type: DT_IMAGE
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/media.For further information check here.
- [Create] action
-
Endpoint URL address:
/media.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- [Update] action
-
Endpoint URL address:
/media/{{=item.id}}.The following request parameters will be automatically processed:
-
file:
{{=item.file}}
For further information check here.
-
file:
- [Delete] action
-
Endpoint URL address:
/media/{{=item.id}}.For further information check here.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- foldername
Template: ShortText.
- entries
A read-only field. Field components:
- An array.
- Contains the following components: id, last_modified, name, creation_time, url, size.
- filename
Template: ShortText.
- fileMimeType
Template: ShortText.
- file
Data type: DT_IMAGE
Based on resource template Base.
- [Read getFormList] action (alias: "Get form list")
-
Endpoint URL address:
/form.For further information check here.
- [Read getPromotionalFormUrls] action (alias: "Get promotional form URLs")
-
Endpoint URL address:
/form/{{=parameters.id}}/urls.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. The id of the form for which you are requesting URLs.
For further information check here.
- folder
Template: ShortText.
- entries
Field components:
- An array.
- Contains the following components: id, title, description, ecommerce, url, modified.
- id
Template: ShortText.
- title
Template: ShortText.
- description
Template: ShortText.
- urls
Field components:
- An array.
- Contains the following components: name, url, prefilled_url, report_url.
Based on resource template Base.
- [Read getPageList] action (alias: "Get page list")
-
Endpoint URL address:
/page.For further information check here.
- [Read getPromotionalPageUrls] action (alias: "Get promotional page URLs")
-
Endpoint URL address:
/page/{{=parameters.id}}/urls.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. The id of the page you're requesting a URL for.
For further information check here.
- [Delete] action
-
Endpoint URL address:
/page/{{=item.id}}.For further information check here.
- folder
Template: ShortText.
- entries
Field components:
- An array.
- Contains the following components: id, title, tags, url, modified.
- id
A key field. Template: ShortText.
- urls
Field components:
- An array.
- Contains the following components: name, url.
Based on resource template Base.
- [Read getSubscriptionCategories] action (alias: "Get subscription categories")
-
Endpoint URL address:
/subscription/category.For further information check here.
- [Read getSubscriptionCategoryByEmail] action (alias: "Get subscription category opt-ins by email")
-
Endpoint URL address:
/subscription/category.The action has the following user-defined parameters:
- email: Required. Email address of the record to retrieve explicit opt-ins.
For further information check here.
- [Update] action
-
Endpoint URL address:
/subscription/optout.For further information check here.
Template: ShortText.
- category
Template: ShortText.
- action
Template: ShortText.
- id
Template: ShortText. A read-only field.
- name
Template: ShortText. A read-only field.
- description
Template: ShortText. A read-only field.
- headerid
Template: ShortText. A read-only field.
- headername
Template: ShortText. A read-only field.
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.