Overview
Configuration is provided for establishing connections with the Parature 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.
Configuration
Base URL address: https://[customerId].prod.parature.com/api/v1/[instanceId]/[departmentId].
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Token:
The following request parameters will be automatically processed during the authentication process:
-
_token_:
{{=connection.user.Token}}
Documentation: https://success.parature.com/link/portal/3/51/Article/2793/How-can-we-receive-access-to-the-Parature-API.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Article/Search.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "_keywords_").
The following request parameters will be automatically processed:
-
_keywords_:
{{=parameters.search}}
Documentation: https://support.parature.com/public/doc/api.html#article-search.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#article-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#article-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#article-delete.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#articletranslation-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#articletranslation-create.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#articlefolder-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#articlefolder-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#articlefolder-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#articlefolder-delete.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#download-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#download-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#download-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#download-delete.
- MimeType
Template: ShortText.
- Guid
Template: ShortText. Before setting, the value is processed with
{{=Parature.UploadFile('/Download/upload', item)}}expression.- Content
Data type: DT_IMAGE
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#downloadfolder-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#downloadfolder-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#downloadfolder-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#downloadfolder-delete.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#eula-list.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#account-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#account-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#account-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#account-delete.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Account/view.
The result is extracted from:{{=response.AccountView}}.Documentation: https://support.parature.com/public/doc/api.html#accountview-list.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#customer-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#customer-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#customer-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#customer-delete.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Customer/view.
The result is extracted from:{{=response.CustomerView}}.Documentation: https://support.parature.com/public/doc/api.html#customerview-list.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Customer/status.
The result is extracted from:{{=response.Status}}.Documentation: https://support.parature.com/public/doc/api.html#customerview-list.
- Description
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Name
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Text
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Customer/role.
The result is extracted from:{{=response.CustomerRole}}.Documentation: https://support.parature.com/public/doc/api.html#customerrole-list.
- Description
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Name
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#product-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#product-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#product-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#product-delete.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#productfolder-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#productfolder-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#productfolder-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#productfolder-delete.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#asset-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#asset-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#asset-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#asset-delete.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Asset/status.
The result is extracted from:{{=response.Status}}.Documentation: https://support.parature.com/public/doc/api.html#assetstatus-list.
- Description
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Name
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Text
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
The following request parameters will be automatically processed:
-
_fields_:
{{=_.without(parameters.fields, 'MimeType', 'Ticket_Attachments', 'Content').join()}}
Documentation: https://support.parature.com/public/doc/api.html#ticket-list.
-
_fields_:
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#ticket-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#ticket-update.
- [Delete] action
-
Documentation: https://support.parature.com/public/doc/api.html#ticket-delete.
- MimeType
Template: ShortText.
- Ticket_Attachments
Template: AttachmentMultiple. Before setting, the value is processed with
{{? value }}{{=value.Attachment.push(Parature.UploadFile('/Ticket/upload', item))}}{{??}}{{={'Attachment':[Parature.UploadFile('/Ticket/upload', item)]} }}{{?}}expression.- Content
Data type: DT_IMAGE
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Ticket/view.
The result is extracted from:{{=response.TicketView}}.Documentation: https://support.parature.com/public/doc/api.html#ticketview-list.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Ticket/status.
The result is extracted from:{{=response.Status}}.Documentation: https://support.parature.com/public/doc/api.html#ticketstatus-list.
- Customer_Text
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Name
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#ticketqueue-list.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#department-list.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#chat-list.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Chat/{{=parameters.chat}}/Transcript.
The result is extracted from:{{=response.Transcript}}.The action has the following user-defined parameters:
- chat: Required. Specify chat identifier.
Documentation: https://support.parature.com/public/doc/api.html#chat-retrieve-transcript.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#csr-list.
- [Create] action
-
Documentation: https://support.parature.com/public/doc/api.html#csr-create.
- [Update] action
-
Documentation: https://support.parature.com/public/doc/api.html#csr-update.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Csr/role.
The result is extracted from:{{=response.CsrRole}}.Documentation: https://support.parature.com/public/doc/api.html#csrrole-list.
- Description
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Name
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Csr/status.
The result is extracted from:{{=response.Status}}.Documentation: https://support.parature.com/public/doc/api.html#csrstatus-list.
- Description
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Name
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#sla-list.
Based on resource template Base.
- [Read] action
-
Documentation: https://support.parature.com/public/doc/api.html#timezone-list.
- Abbreviation
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.- Timezone
Template: ShortText. The gathered value is processed with
{{=value['#text']}}expression.
- [External]
-
The external fields URL address:
. The external fields list is extracted from:.
- [Read] action
-
Endpoint URL address:
/{{=resource.object}}.
The result is extracted from:{{=response.Entities[resource.object]}}.
The result is paginated.The following request parameters will be automatically processed:
-
_fields_:
{{=parameters.fields.join()}} -
_startPage_:
{{=parameters.iterator}} -
_pageSize_:
{{=parameters.batchSize}} -
_output_:
json -
_includeUserParameters:
{{=parameters}}
-
_fields_:
- [Create] action
-
Endpoint URL address:
/{{=resource.object}}.
The result is extracted from:{{=response[resource.object]}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml(_.object([resource.object], [item]))}}
-
application/xml:
- [Update] action
-
Endpoint URL address:
/{{=resource.object}}/{{=item[resource.keyField]}}.
The result is extracted from:{{=response[resource.object]}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/xml:
{{=json2xml(_.object([resource.object], [item]))}}
-
application/xml:
- [Delete] action
-
Endpoint URL address:
/{{=resource.object}}/{{=item[resource.keyField]}}.
The action uses DELETE method.The following request parameters will be automatically processed:
-
_purge_:
{{=parameters._purge_}}
-
_purge_:
- @id
A key field. Data type: DT_I4
- @uid
Template: ShortText. A read-only field.
- @href
Template: ShortText. A read-only field.
- @service-desk-uri
Template: ShortText. A read-only field.
- [External]
-
The external fields URL address:
/{{=resource.object}}/schema. The external fields list is extracted from:{{=_.pairs(response[resource.object])}}.- {{=external[0]}}
Template: {{? external[1]['@field-type'] == 'entity'}}{{='Entity'}}{{?? external[1]['@field-type'] == 'entitymultiple'}}{{='EntityMultiple'}}{{?? external[1]['@field-type'] == 'attachmentmultiple'}}{{='AttachmentMultiple'}}{{??}}{{=''}}{{?}}. Data type: {{=Parature.getDataType([external[1]['@data-type'])}} ( length {{=255}} ) The gathered value is processed with
{{=(item[field.name] || {})['#text']}}expression.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- Entity
The gathered value is processed with
{{=(item[field.name] || {})[_.last(_.pairs(field.external[1]))[0]]}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: @id, @uid, @href, Full_Name.
-
Uses template:
- EntityMultiple
Data type: DT_WSTR ( length 4000 ) A composite field. The gathered value is processed with
{{=(item[field.name] || {})[_.last(_.pairs(field.external[1]))[0]]}}expression.- AttachmentMultiple
Data type: DT_WSTR ( length 4000 ) A composite field. The gathered value is processed with
{{=item[field.name].Attachment}}expression.
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.