Description of the Rest-service Platform

SYSTEMZ Platform for SharePoint 2013 > 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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/DocTrix.Platform.Delegation/GetDelegates(logins=@param,withInput=true,recursive=true)@param=’i%3A0%23.w%7Cdomain%5Cuser1%3Brole’
Method GET
ContentType application/json; odata=verbose

Response example:
{“d”:{“GetDelegates”:”i:0#.w|domain\user2;i:0#.w|domain\user3″}}

Processing SharePoint groups:

  • if the input line contains a unique group name, then delegates of the group members will be received.
  • the withInput parameter controls the inclusion in the result of users for whom delegates were requested. When searching a group, members of this group will be included or not included.
  • if the user met again during further search, he will be included in the result once.

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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/DocTrix.Platform.TableField/CreateFolder(listUrl=’Lists/List1′,fieldName=’DTTab1′)
Method GET
ContentType application/json; odata=verbose

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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/DocTrix.Platform.ItemReferences/GetFieldValue(listUrl=’Lists/List1′,itemId=1)
Method GET
ContentType application/json; odata=verbose

Response example:

{“d”:{“GetFieldValue”:”71b4897f-4879-429b-b225-cab13982a44e00000000-0000-0000-0000-0000000000002004feed52-31a0-4417-8e84-7506ee20b1101300000000-0000-0000-0000-0000000000002017-04-26T07:23:24.3622381ZSHAREPOINT\system”}}

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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/doctrix.platform.flow.patternValue/execute(listUrl=’Lists/List1′,itemId=1,field=’Field1′,overrideValue=’true’)
Method POST
ContentType application/json; odata=verbose

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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/doctrix.platform.flow.getDetailFolderUrl/execute(masterListUrl=’Lists/List1′,masterListItemId=’1′,tableFieldName=’DTTab1′)
Method GET
ContentType application/json; odata=verbose

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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/doctrix.platform.flow.ensureDetailFolder/execute(listUrl=’Lists/List1′,itemId=’1′,tableFieldName=’DTTab1′)
Method POST
ContentType application/json; odata=verbose

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

The tabular part folder creation service belongs to the outdated tabular part list functionality (not related to a field like “Platform: 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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/doctrix.platform.flow.createChildFolder/execute(childListUrl=’Lists/ListDetail1,parentListItemId=1)
Method POST
ContentType application/json; odata=verbose

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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/doctrix.platform.flow.getLoginsFromField /execute(ListUrl=’Lists/List1′,itemId=1,fieldName=’Field1′)
Method GET
ContentType application/json; odata=verbose

Response example:
{“d”: {“execute”:”i:0#.w|domain\user1;role1;role2;i:0#.w|domain\user2″ }}

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:

Acceptapplication/json; odata=verboseX-RequestDigest get from request to /_api/contextinfo

URL http://server:1234/sites/site1/_api/doctrix.platform.flow.getLinksToDetails/execute(absoluteWebUrl=@absoluteWebUrl,masterListUrl=’Lists/List1′,masterListItemId=’1′,tableFieldName=’DTTab1t’,linkSeparator=@linkSeparator)?@absoluteWebUrl=’Lists/List1’&@linkSeparator=’;’
Method GET
ContentType application/json; odata=verbose

Response example:
{“d”:{“execute”:” Doc1.docx;Doc2.docx}}

Contents