Follow

API Reference

Applies ToInformation Worker for SharePoint 2013/2016

 

This article describes available web services. 

For usage example proceed to the following article: Duplicating and deploying templates by web service

1. Designer Services

1.png

All operations provided by designer services can be accessed from the following URL: http://{yourWebSiteUrl}/_layouts/15/pdfsf/services/DesignerService.asmx

1.1 DeployTemplate - deploys specified template to the destination site collection, specifies forms name and target library.

DeployTemplate(templateName, targetListName, contentTypeName, webUrl, userLogin) 
Parameters:

  • templateName – (string) name of a template that must be deployed;
  • targetListName – (string) SharePoint library name where new content type must be published;
  • contentTypeName – (string) new content type name;
  • webUrl – (string) URL of a site collection where template must be deployed;
  • userLogin – (string) user who has permissions on a source and target site collections.

1.2 DuplicateTemplate - duplicates specified template and sets duplicate’s name.

DuplicateTemplate (templateName, newTemplateName, userLogin) 

Parameters:

  • templateName – (string) name of a template that must be duplicated;
  • newTemplateName – (string) name of a duplicated template (we suggest using templateName_<siteCollectionName> in order to ease sorting);
  • userLogin – (string) user who has permissions on a source and target site collections.

1.3 GetCurrentUser - returns current user name with domain

GetCurrentUser() - do not take parameters;

1.4 UpdateListDataSource - if duplicated template contains datasources, they can be updated in order to take data from correct lists on a new site collection.

UpdateListDataSource(templateName, existingDataSourceName, dataSourceListName, webUrl, userLogin) 

Parameters:

  • templateName: (string) name of a duplicated template;
  • existingDataSourceName: (string) name of a data source to update (from original template);
  • dataSourceListName: (string) name of a SharePoint list, from which data source takes information;
  • webUrl: (string) site collection URL where duplicated template is created;
  • userLogin: user who has permissions on a source and target site collections.

2. Workflow Services

All operations provided by WorkflowService can be accessed from the following URL: http://{yourWebsiteURL}/_vti_bin/PDFSF/WorkflowService.svc

2.1 CreatePDFFormInstance - creates PDF form with specified properties, in specified list.

CreatePDFFormInstance (listUrl, listItemProperties, overwrite)

Parameters:

  • listUrl: (string) target list URL;
  • listItemProperties: (IDictionary <string, object>) 
  • overwrite: (boolean) determines if new PDF form can replace document with equal name.

Returns:

  • GUID of a newly created PDF form instance. This GUID can be used in order to access the instance.

2.2 ExecuteFormRule - executes server-side function/rule.

ExecuteFormRule (fileUrl, ruleName)

Parameters:

  • fileUrl: (string) URL of a form where server-side rule must be triggered;
  • ruleName: (string) name of a server-side rule that must be triggered;

2.3 ExportDataToPDF - take information from one PDF document, takes layout from another PDF document and merges both as a new file in specified library.

ExportDataToPDF (dataListId, dataItemGuid, templateListId, templateItemGuid, resultListId, resultListItemProperties, fileRef, resultOverwrite)

Parameters:

  • dataListId: (Guid) id of the list where is stored a PDF document from which data will be taken
  • dataItemGuid: (Guid) id of the document data will be taken from;
  • templateListId: (Guid) list id where is stored a PDF document which will be used as layout;
  • templateItemGuid: (Guid) identifier of a PDF document that will be used as a layout;
  • resultListId: (Guid) id of a list where a new merged document will be saved;
  • resultListItemProperties: (IDictionary<string, object>) object that describes list items by using key and value pairs. F.e. "WebId":"47fd4cd3-8e52-4586-a3d7-0416b03dfb9a" etc.
  • fileRef: (String) new file name;
  • resultOverwrite: (Boolean) determines if a file with the same name will be overwritten.

 

2.4 FlattenPDFForm - flattens PDF document.

FlattenPDFForm (fileUrl)

Parameters:

  • fileUrl: (string) URL of a form that must be flattened.

 

2.5 GetFormStage - returns specified PDF document's stage.

GetFormStage (fileUrl)

Parameters:

  • fileUrl: (string) URL of a form stage must be read from.

 

2.6 ReadFieldValues - reads specified fields from specific document.

ReadFieldValues (fileUrl, fieldNames)

Parameters:

  • fileUrl: (string) URL of a form fields must be read from.
  • fileNames: (string) names of fields from which values will be read. Field names must be listed and separated by commas; F.e: "TextField1,TextField2,TextField3" etc.

Returns:

  • Dictionary <string, string> object where dictionary's key is field name and dictionary value is field value.

 

2.7 SetFormStage - sets specified stage in specified PDF document.

SetFormStage (fileUrl, stage)

Parameters:

  • fileUrl: (string) URL of a form where stage must be set; 
  • stage: (string) name of a stage that must be set in the specified form.

 

2.8 UpdateFieldValues - updates specified fields with specified values in specific PDF document.

UpdateFieldValues (fileUrl, fieldValues)

Parameters:

  • fileUrl: (string) URL of a form where fields must be updated; 
  • fieldValues: (Dictionary <string, object>) where dictionary's key is field name and dictionary value is field value (can be specified value's type and actual value).

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk