| Method | HTTP request | Description |
|---|---|---|
| get_by_path | GET /tablecategories | Retrieve a table category by path. |
| get | GET /tablecategories/{webId} | Retrieve a table category. |
| update | PATCH /tablecategories/{webId} | Update a table category by replacing items in its definition. |
| delete | DELETE /tablecategories/{webId} | Delete a table category. |
| get_security | GET /tablecategories/{webId}/security | Get the security information of the specified security item associated with the table category for a specified user. |
| get_security_entries | GET /tablecategories/{webId}/securityentries | Retrieve the security entries associated with the table category based on the specified criteria. By default, all security entries for this table category are returned. |
| create_security_entry | POST /tablecategories/{webId}/securityentries | Create a security entry owned by the table category. |
| get_security_entry_by_name | GET /tablecategories/{webId}/securityentries/{name} | Retrieve the security entry associated with the table category with the specified name. |
| update_security_entry | PUT /tablecategories/{webId}/securityentries/{name} | Update a security entry owned by the table category. |
| delete_security_entry | DELETE /tablecategories/{webId}/securityentries/{name} | Delete a security entry owned by the table category. |
get_by_path('path', 'selected_fields', 'web_id_type')
Retrieve a table category by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | str | The path to the target table category.. | [required] |
| selected_fields | str | 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] |
| web_id_type | str | 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get('web_id', 'selected_fields', 'web_id_type')
Retrieve a table category.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The id of the table category.. | [required] |
| selected_fields | str | 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] |
| web_id_type | str | 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
update('web_id', 'table_category')
Update a table category by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the table category to update.. | [required] |
| table_category | PITableCategory | A partial table category containing the desired changes.. | [required] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete('web_id')
Delete a table category.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the table category to delete.. | [required] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get_security('web_id', 'user_identity', 'force_refresh', 'selected_fields', 'web_id_type')
Get the security information of the specified security item associated with the table category for a specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the table category for the security to be checked.. | [required] |
| user_identity | list[str] | 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] |
| force_refresh | bool | Indicates if the security cache should be refreshed before getting security information. The default is 'false'.. | [optional] |
| selected_fields | str | 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] |
| web_id_type | str | 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get_security_entries('web_id', 'name_filter', 'selected_fields', 'web_id_type')
Retrieve the security entries associated with the table category based on the specified criteria. By default, all security entries for this table category are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the table category.. | [required] |
| name_filter | str | The name query string used for filtering security entries. The default is no filter.. | [optional] |
| selected_fields | str | 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] |
| web_id_type | str | 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
create_security_entry('web_id', 'security_entry', 'apply_to_children', 'web_id_type')
Create a security entry owned by the table category.
| Name | Type | Description | Notes |
|---|---|---|---|
| web_id | str | The ID of the table category where the security entry will be created.. | [required] |
| security_entry | PISecurityEntry | The new security entry definition. The full list of allow and deny rights must be supplied.. | [required] |
| apply_to_children | bool | 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] |
| web_id_type | str | 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] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get_security_entry_by_name('name', 'web_id', 'selected_fields', 'web_id_type')
Retrieve the security entry associated with the table category with the specified name.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | 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] |
| web_id | str | The ID of the table category.. | [required] |
| selected_fields | str | 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] |
| web_id_type | str | 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
update_security_entry('name', 'web_id', 'security_entry', 'apply_to_children')
Update a security entry owned by the table category.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | The name of the security entry.. | [required] |
| web_id | str | The ID of the table category where the security entry will be updated.. | [required] |
| security_entry | PISecurityEntry | The new security entry definition. The full list of allow and deny rights must be supplied or they will be removed.. | [required] |
| apply_to_children | bool | 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] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete_security_entry('name', 'web_id', 'apply_to_children')
Delete a security entry owned by the table category.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | 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] |
| web_id | str | The ID of the table category where the security entry will be deleted.. | [required] |
| apply_to_children | bool | 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] |
None
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]