TableApi.md

TableApi

Method	HTTP request	Description
getByPath	GET /tables	Retrieve a table by path.
get	GET /tables/{webId}	Retrieve a table.
update	PATCH /tables/{webId}	Update a table by replacing items in its definition.
delete	DELETE /tables/{webId}	Delete a table.
getCategories	GET /tables/{webId}/categories	Get a table's categories.
getData	GET /tables/{webId}/data	Get the table's data.
updateData	PUT /tables/{webId}/data	Update the table's data.
getSecurity	GET /tables/{webId}/security	Get the security information of the specified security item associated with the table for a specified user.
getSecurityEntries	GET /tables/{webId}/securityentries	Retrieve the security entries associated with the table based on the specified criteria. By default, all security entries for this table are returned.
createSecurityEntry	POST /tables/{webId}/securityentries	Create a security entry owned by the table.
getSecurityEntryByName	GET /tables/{webId}/securityentries/{name}	Retrieve the security entry associated with the table with the specified name.
updateSecurityEntry	PUT /tables/{webId}/securityentries/{name}	Update a security entry owned by the table.
deleteSecurityEntry	DELETE /tables/{webId}/securityentries/{name}	Delete a security entry owned by the table.

getByPath

getByPath(String path, String selectedFields, String webIdType)

Retrieve a table by path.

Parameters

Name	Type	Description	Notes
path	String	The path to the table..	[required]
selectedFields	String	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]
webIdType	String	Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType"..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

get

get(String webId, String selectedFields, String webIdType)

Retrieve a table.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table..	[required]
selectedFields	String	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]
webIdType	String	Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType"..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

update

update(String webId, PITable table)

Update a table by replacing items in its definition.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table to update..	[required]
table	PITable	A partial table containing the desired changes..	[required]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

delete

delete(String webId)

Delete a table.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table to delete..	[required]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

getCategories

getCategories(String webId, String selectedFields, String webIdType)

Get a table's categories.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table..	[required]
selectedFields	String	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]
webIdType	String	Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType"..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

getData

getData(String webId, String selectedFields)

Get the table's data.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table..	[required]
selectedFields	String	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

updateData

updateData(String webId, PITableData data)

Update the table's data.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table on which to update the data..	[required]
data	PITableData	The new table data definition..	[required]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

getSecurity

getSecurity(String webId, List userIdentity, Boolean forceRefresh, String selectedFields, String webIdType)

Get the security information of the specified security item associated with the table for a specified user.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table for the security to be checked..	[required]
userIdentity	List	The user identity for the security information to be checked. Multiple security identities may be specified with multiple instances of the parameter. If the parameter is not specified, only the current user's security rights will be returned..	[required]
forceRefresh	Boolean	Indicates if the security cache should be refreshed before getting security information. The default is 'false'..	[optional]
selectedFields	String	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]
webIdType	String	Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType"..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

getSecurityEntries

getSecurityEntries(String webId, String nameFilter, String selectedFields, String webIdType)

Retrieve the security entries associated with the table based on the specified criteria. By default, all security entries for this table are returned.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table..	[required]
nameFilter	String	The name query string used for filtering security entries. The default is no filter..	[optional]
selectedFields	String	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]
webIdType	String	Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType"..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

createSecurityEntry

createSecurityEntry(String webId, PISecurityEntry securityEntry, Boolean applyToChildren, String webIdType)

Create a security entry owned by the table.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the table where the security entry will be created..	[required]
securityEntry	PISecurityEntry	The new security entry definition. The full list of allow and deny rights must be supplied..	[required]
applyToChildren	Boolean	If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change..	[optional]
webIdType	String	Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType"..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

getSecurityEntryByName

getSecurityEntryByName(String name, String webId, String selectedFields, String webIdType)

Retrieve the security entry associated with the table with the specified name.

Parameters

Name	Type	Description	Notes
name	String	The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username..	[required]
webId	String	The ID of the table..	[required]
selectedFields	String	List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned..	[optional]
webIdType	String	Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType"..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

updateSecurityEntry

updateSecurityEntry(String name, String webId, PISecurityEntry securityEntry, Boolean applyToChildren)

Update a security entry owned by the table.

Parameters

Name	Type	Description	Notes
name	String	The name of the security entry..	[required]
webId	String	The ID of the table where the security entry will be updated..	[required]
securityEntry	PISecurityEntry	The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed..	[required]
applyToChildren	Boolean	If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]

deleteSecurityEntry

deleteSecurityEntry(String name, String webId, Boolean applyToChildren)

Delete a security entry owned by the table.

Parameters

Name	Type	Description	Notes
name	String	The name of the security entry. For every backslash character () in the security entry name, replace with asterisk (). As an example, use domainusername instead of domain\username..	[required]
webId	String	The ID of the table where the security entry will be deleted..	[required]
applyToChildren	Boolean	If false, the new access permissions are only applied to the associated object. If true, the access permissions of children with any parent-child reference types will change when the permissions on the primary parent change..	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]