| Method | HTTP request | Description |
|---|---|---|
| list | GET /assetservers | Retrieve a list of all Asset Servers known to this service. |
| getByName | GET /assetservers#name | Retrieve an Asset Server by name. |
| getByPath | GET /assetservers#path | Retrieve an Asset Server by path. |
| get | GET /assetservers/{webId} | Retrieve an Asset Server. |
| getAnalysisRulePlugIns | GET /assetservers/{webId}/analysisruleplugins | Retrieve a list of all Analysis Rule Plug-in's. |
| getDatabases | GET /assetservers/{webId}/assetdatabases | Retrieve a list of all Asset Databases on the specified Asset Server. |
| createAssetDatabase | POST /assetservers/{webId}/assetdatabases | Create an asset database. |
| getSecurity | GET /assetservers/{webId}/security | Get the security information of the specified security item associated with the asset server for a specified user. |
| getSecurityEntries | GET /assetservers/{webId}/securityentries | Retrieve the security entries of the specified security item associated with the asset server based on the specified criteria. By default, all security entries for this asset server are returned. |
| createSecurityEntry | POST /assetservers/{webId}/securityentries | Create a security entry owned by the asset server. |
| getSecurityEntryByName | GET /assetservers/{webId}/securityentries/{name} | Retrieve the security entry of the specified security item associated with the asset server with the specified name. |
| updateSecurityEntry | PUT /assetservers/{webId}/securityentries/{name} | Update a security entry owned by the asset server. |
| deleteSecurityEntry | DELETE /assetservers/{webId}/securityentries/{name} | Delete a security entry owned by the asset server. |
| getSecurityIdentities | GET /assetservers/{webId}/securityidentities | Retrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned. |
| createSecurityIdentity | POST /assetservers/{webId}/securityidentities | Create a security identity. |
| getSecurityIdentitiesForUser | GET /assetservers/{webId}/securityidentities#userIdentity | Retrieve security identities for a specific user. |
| getSecurityMappings | GET /assetservers/{webId}/securitymappings | Retrieve security mappings based on the specified criteria. By default, all security mappings in the specified Asset Server are returned. |
| createSecurityMapping | POST /assetservers/{webId}/securitymappings | Create a security mapping. |
| getTimeRulePlugIns | GET /assetservers/{webId}/timeruleplugins | Retrieve a list of all Time Rule Plug-in's. |
| getUnitClasses | GET /assetservers/{webId}/unitclasses | Retrieve a list of all unit classes on the specified Asset Server. |
| createUnitClass | POST /assetservers/{webId}/unitclasses | Create a unit class in the specified Asset Server. |
list(String selectedFields, String webIdType)
Retrieve a list of all Asset Servers known to this service.
| Name | Type | Description | Notes |
|---|---|---|---|
| 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getByName(String name, String selectedFields, String webIdType)
Retrieve an Asset Server by name.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the server.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getByPath(String path, String selectedFields, String webIdType)
Retrieve an Asset Server by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the server.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get(String webId, String selectedFields, String webIdType)
Retrieve an Asset Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getAnalysisRulePlugIns(String webId, String selectedFields, String webIdType)
Retrieve a list of all Analysis Rule Plug-in's.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server, where the Analysis Rule Plug-in's are installed.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getDatabases(String webId, String selectedFields, String webIdType)
Retrieve a list of all Asset Databases on the specified Asset Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createAssetDatabase(String webId, PIAssetDatabase database, String webIdType)
Create an asset database.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server on which to create the database.. | [required] |
| database | PIAssetDatabase | The new database definition.. | [required] |
| 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurity(String webId, List securityItem, List userIdentity, Boolean forceRefresh, String selectedFields, String webIdType)
Get the security information of the specified security item associated with the asset server for a specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server for the security to be checked.. | [required] |
| securityItem | List | The security item of the desired security information to be returned. Multiple security items may be specified with multiple instances of the parameter. If the parameter is not specified, only 'Default' security item of the security information will be returned.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityEntries(String webId, String nameFilter, String securityItem, String selectedFields, String webIdType)
Retrieve the security entries of the specified security item associated with the asset server based on the specified criteria. By default, all security entries for this asset server are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server.. | [required] |
| nameFilter | String | The name query string used for filtering security entries. The default is no filter.. | [optional] |
| securityItem | String | The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createSecurityEntry(String webId, PISecurityEntry securityEntry, Boolean applyToChildren, String securityItem, String webIdType)
Create a security entry owned by the asset server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server 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] |
| securityItem | String | The security item of the desired security entries to be created. If the parameter is not specified, security entries of the 'Default' security item will be created.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityEntryByName(String name, String webId, String securityItem, String selectedFields, String webIdType)
Retrieve the security entry of the specified security item associated with the asset server with the specified name.
| 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 asset server.. | [required] |
| securityItem | String | The security item of the desired security entries information to be returned. If the parameter is not specified, security entries of the 'Default' security item will be returned.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
updateSecurityEntry(String name, String webId, PISecurityEntry securityEntry, Boolean applyToChildren, String securityItem)
Update a security entry owned by the asset server.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the security entry.. | [required] |
| webId | String | The ID of the asset server 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] |
| securityItem | String | The security item of the desired security entries to be updated. If the parameter is not specified, security entries of the 'Default' security item will be updated.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
deleteSecurityEntry(String name, String webId, Boolean applyToChildren, String securityItem)
Delete a security entry owned by the asset server.
| 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 asset server 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] |
| securityItem | String | The security item of the desired security entries to be deleted. If the parameter is not specified, security entries of the 'Default' security item will be deleted.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityIdentities(String webId, String field, Integer maxCount, String query, String selectedFields, String sortField, String sortOrder, String webIdType)
Retrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server to search.. | [required] |
| field | String | Specifies which of the object's properties are searched. The default is 'Name'.. | [optional] |
| maxCount | Integer | The maximum number of objects to be returned. The default is 1000.. | [optional] |
| query | String | The query string used for finding objects. The default is no query string.. | [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] |
| sortField | String | The field or property of the object used to sort the returned collection. The default is 'Name'.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createSecurityIdentity(String webId, PISecurityIdentity securityIdentity, String webIdType)
Create a security identity.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server on which to create the security identity.. | [required] |
| securityIdentity | PISecurityIdentity | The new security identity definition.. | [required] |
| 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityIdentitiesForUser(String webId, String userIdentity, String selectedFields, String webIdType)
Retrieve security identities for a specific user.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [required] |
| userIdentity | String | The user identity to search for.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityMappings(String webId, String field, Integer maxCount, String query, String selectedFields, String sortField, String sortOrder, String webIdType)
Retrieve security mappings based on the specified criteria. By default, all security mappings in the specified Asset Server are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server to search.. | [required] |
| field | String | Specifies which of the object's properties are searched. The default is 'Name'.. | [optional] |
| maxCount | Integer | The maximum number of objects to be returned. The default is 1000.. | [optional] |
| query | String | The query string used for finding objects. The default is no query string.. | [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] |
| sortField | String | The field or property of the object used to sort the returned collection. The default is 'Name'.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createSecurityMapping(String webId, PISecurityMapping securityMapping, String webIdType)
Create a security mapping.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server on which to create the security mapping.. | [required] |
| securityMapping | PISecurityMapping | The new security mapping definition.. | [required] |
| 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getTimeRulePlugIns(String webId, String selectedFields, String webIdType)
Retrieve a list of all Time Rule Plug-in's.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the asset server, where the Time Rule Plug-in's are installed.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getUnitClasses(String webId, String selectedFields, String webIdType)
Retrieve a list of all unit classes on the specified Asset Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createUnitClass(String webId, PIUnitClass unitClass, String webIdType)
Create a unit class in the specified Asset Server.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the server.. | [required] |
| unitClass | PIUnitClass | The new unit class definition.. | [required] |
| 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]