Description of the Rest-service Platform

Description of the Rest-service Platform

Rest-service for receiving delegates

{0}/_api/DocTrix.Platform.Delegation/GetDelegates(logins=@param,withInput={2},recursive={3})?@param='{1}',

has following values:
0 – website address;
1 – logins of users or groups of SharePoint to receive delegates. Value separator “;”. The parameter must be encoded;
2 – include in the result users for whom delegates were requested (true/false);
3 – perform recursive search (true/false).

Call example:

Response example:

{"d":{"GetDelegates":"i:0#.w|domainuser2;i:0#.w|domainuser3"}}

Rest-service for creating a tabular part folder (without binding to parent)

{0}/_api/DocTrix.Platform.TableField/CreateFolder(listUrl='{1}',fieldName='{2}'),

has following values:
0 – website address;
1 – relative address of the list in which the tabular part field is located;
2 – internal name of the field of the the tabular part for which you want to create a folder.

Call example:

Response example:

{
  "d":{
    "CreateFolder":{
      "results":[
        {
          "__metadata":{"type":"SP.KeyValue"},
          "Key":"ID",
          "Value":"899",
          "ValueType":"Edm.Int32"
        },
        {
          "__metadata":{"type":"SP.KeyValue"},
          "Key":"ServerRelativeUrl",
          "Value":"/Lists/ListDetail1/CTR_NBAVIUR8KR4FKHQ9R7OQA7L3J7/D_N0F9NEKAUR994C6LAV709ATF43",
          "ValueType":"Edm.String"
        }
      ]
    }
  }
}

Rest service for receiving item links (for later copying to a new item)

{0}/_api/DocTrix.Platform.ItemReferences/GetFieldValue(listUrl='{1}',itemId={2}),

has following values:
0 – website address;
1 – relative address of the list in which the related items field is located;
2 – id of the item for which you want to get links.

Call example:

Response example:

{"d":{"GetFieldValue":"<ItemRelationDraftData><ItemRelations><ItemRelation><ID>71b4897f-4879-429b-b225-cab13982a44e</ID><FromListId>00000000-0000-0000-0000-000000000000</FromListId><FromItemId>20</FromItemId><ToListId>04feed52-31a0-4417-8e84-7506ee20b110</ToListId><ToItemId>1</ToItemId><TypeItemId>3</TypeItemId><BackId>00000000-0000-0000-0000-000000000000</BackId></ItemRelation></ItemRelations><UtcUpdateDate>2017-04-26T07:23:24.3622381Z</UtcUpdateDate><EditorUserName>SHAREPOINTsystem</EditorUserName></ItemRelationDraftData>"}}

Rest service for calling a function for calculating a value from a pattern

{0}/_api/doctrix.platform.flow.patternValue/execute(listUrl='{1}',itemId={2},field='{3}',overrideValue='{4}'),

has following values:
0 – website address;
1 – the relative address of the list in which the field of type “Platform: Calculated” is located;
2 – id of the item for which to calculate the value;
3 – internal name of the field for which to calculate the value;
4 – update field value (true/false).

Call example:

Rest service for calling the function to obtain the URL of a folder with children of the tabular part field

{0}/_api/doctrix.platform.flow.getDetailFolderUrl/execute(masterListUrl='{1}',masterListItemId={2},tableFieldName='{3}'),

has following values:
0 – website address;
1 – relative address of parent list;
2 – id of parent item;
3 – internal name of the field tabular part;

Call example:

Response example:

{"d":{"execute":"/sites/site1/Lists/ListDetail1/CTR_71CCQIERPKU44HAOS366SS4UD7/D_E7NKV7ACA7B2KR67F5E9N0AQ16"}}

Rest-service of calling the function of binding the folder with the field of the tabular part

{0}/_api/doctrix.platform.flow.ensureDetailFolder/execute(masterListUrl='{1}',masterListItemId='{2}',tableFieldName='{3}'),

has following values:
0 – website address;
1 – relative address of parent list;
2 – id of parent item;
3 – internal name of the field tabular part.

Call example:

Rest-service for calling the function of creating a folder of the tabular part

{0}/_api/doctrix.platform.flow.createChildFolder/execute(childListUrl='{1}',parentListItemId={2}),

has following values:
0 – website address;
1 – relative address of subsidiary list;
2 – id of parent item.

Call example:

Rest-service of calling the function to get the list of logins as a string

{0}/_api/doctrix.platform.flow.getLoginsFromField/execute(listUrl='{1}',itemId={2},fieldName='{3}'),

has following values:
0 – website address;
1 – relative address of list;
2 – id item;
3 – internal name of the field containing logins.

Call example:

Response example:

{"d": {"execute":"i:0#.w|domainuser1;role1;role2;i:0#.w|domainuser2" }}

Rest-service of the function call to receive html-links to the files of the tabular part field

{0}/_api/doctrix.platform.flow.getLinksToDetails/execute(absoluteWebUrl=@absoluteWebUrl,masterListUrl='{1}',masterListItemId={2},tableFieldName='{3}',linkSeparator='{4}')?@absoluteWebUrl='{5}',

has following values:
0 – website address;
1 – relative address of parent list;
2 – id of parent item;
3 – internal name of the field tabular part;
4 – link delimiter;
5 – absolute website address.

Call example:

Response example:
{"d":{"execute":"<a href="http://server:1234/sites/site1/ListAttachment1/CTR_G2VA0EMFRGTUK82N1DUMH5VJ02/D_SFE1I6J5LPUS4Q2QC88E6GN7L1/Doc1.docx"> Doc1.docx</a>;<a href="http://server:1234/sites/site1/ ListAttachment1/CTR_G2VA0EMFRGTUK82N1DUMH5VJ02/D_SFE1I6J5LPUS4Q2QC88E6GN7L1/ Doc2.docx">Doc2.docx</a>}}