Show/Hide Toolbars

Additional Resources

Introduction > Integration of Additional Thereforeā„¢ eSignature Providers > Interface

GET ?[lcid=1033]

Scroll

This method is called from the Workflow Task and the Thereforeā„¢ Content Connector when selecting an eSignature provider configuration or when a saved Workflow Task or Signature Monitoring item is opened and the eSignature provider configuration points to the implemented Thereforeā„¢ eSignature service URL.

It returns all available settings for this provider.

 

Request

 

Query parameters:

 

Parameter Name

Description

lcid

The LCID of the calling Designer. Can be used to send language sensitive display names to the Designer.

 

 

Response

 

Sample body:

 

{

 "templates": {

   "456": "Template Name 1",

   "457": "Template Name 2",

 },

 "signerProperties": [

   {

     "id": "recipient_name",

     "display": "Name",

     "mandatory": true

   },

   {

     "id": "authentication",

     "display": "Authentication",

     "mandatory": false,

     "options": {

       "email": "Email",

       "sms": "PIN via SMS"

     }

   }

 ],

 "supportedWorkflowFeatures": {

   "subject": true,

   "context": false,

   "forcePdfConversion": false,

   "signingOrder": true,

   "templateFields": true,

   "predefinedTemplateFields": false

 },

 "documentProperties": [

  {

     "id": "description",

     "display": "Description",

     "mandatory": false

        }    

  {

     "id": "lang",

     "display": "Language",

     "mandatory": true,

     "options": {

       "lang_en": "English",  

          "lang_de": "German"      

     }

   }

 ],

 "downloadContentOptions": [

   {

     "id": 1,

     "name": "File only"

   },

   {

     "id": 2,

     "name": "File with extras"

   }

 ],

 "deleteDocumentOptions": [

   {

     "id": 1,

     "name": "Don't delete document"

   },

   {

     "id": 2,

     "name": "Delete document"

   }

 ]

}

 

 

Parameter Name

Type

Description

templates

List of key/value pairs

The templates available at the eSignature provider. If empty, control will be disabled in Designer.
The key is the template id, the values is displayed in the Workflow Task dialog.

signerProperties

List of Objects

The columns in the "Signatories" table in the Workflow Task dialog. These properties will be used in the recipients parameter of POST /Documents.

id

String

For identifying the property when calling POST /Documents. Saved in the Workflow Task settings.

display

String

The column header text.

mandatory

Boolean

If true, the value has to be filled for every row. If false, it can stay empty.

options

List of key/value pairs

This key/value pair can be used to display a dropdown. Optional.
The key will be saved in the Workflow Task settings and sent as values with POST /Documents. The pair is used for displaying in the Workflow Task dialog.

If empty or not set, it will be a normal text cell.

supportedWorkflowFeatures

Object

Used for controlling the UI of the WorkflowTask dialog.

subject

Boolean

If false, the "Subject" textbox will be disabled.

context

Boolean

If false, the "Context" textbox will be disabled.

forcePdfConversion

Boolean

If true, the "Convert To PDF" checkbox will be checked and disabled.

signingOrder

Boolean

If false, the "Set signing order" checkbox will be disabled.

templateFields

Boolean

If false, the "Template Fields" button will be disabled.

predefinedTemplateFields

Boolean

If true, the "Template Fields" dialog will only list the template fields returned from GET /Templates/{TemplateID}. If no template fields are returned, the button stays disabled.

If false, the "Template Fields" button will always be enabled and the dialog will display an empty list with the possibility to add fields.

documentProperties

List of Objects

Optional. A list that is displayed in the "Additional Settings" dialog in the Workflow Task. It follows the same pattern as signerProperties.

id

String

For identifying the property when calling POST /Documents. Saved in the Workflow Task settings.

display

String

The setting text.

mandatory

Boolean

If true, the value has to be filled. If false, it can remain empty.

options

List of key/value pairs

This key/value pair can be used to display a dropdown. Optional.
The key will be saved in the Workflow Task settings and sent as values with POST /Documents. The pair is used for displaying in the Workflow Task dialog.

If empty or not set, it will be a normal text cell.

downloadContentOptions

List of Objects

Optional. Used by the Content Connector in the jobs dialog. If this list is empty, the dropdown control in the jobs dialog will not visible.

id

integer

The ID of the setting. Will be used as parameter in GET /Documents/{DocumentID}.

name

String

The text in the dropdown.

deleteDocumentOptions

List of Objects

Optional. Used by the Content Connector in the jobs dialog. If this list is empty, the dropdown control in the jobs dialog will not visible.

id

integer

The ID of the setting. Will be used as parameter in GET /Documents/{DocumentID}.

name

String

The text in the dropdown.

Ā© 2024 Therefore Corporation, all rights reserved.