AssetDatabaseApi.md

AssetDatabaseApi

Method	HTTP request	Description
getByPath	GET /assetdatabases	Retrieve an Asset Database by path.
get	GET /assetdatabases/{webId}	Retrieve an Asset Database.
update	PATCH /assetdatabases/{webId}	Update an asset database by replacing items in its definition.
delete	DELETE /assetdatabases/{webId}	Delete an asset database.
findAnalyses	GET /assetdatabases/{webId}/analyses	Retrieve analyses based on the specified conditions.
getAnalysisCategories	GET /assetdatabases/{webId}/analysiscategories	Retrieve analysis categories for a given Asset Database.
createAnalysisCategory	POST /assetdatabases/{webId}/analysiscategories	Create an analysis category at the Asset Database root.
getAnalysisTemplates	GET /assetdatabases/{webId}/analysistemplates	Retrieve analysis templates based on the specified criteria. By default, all analysis templates in the specified Asset Database are returned.
createAnalysisTemplate	POST /assetdatabases/{webId}/analysistemplates	Create an analysis template at the Asset Database root.
getAttributeCategories	GET /assetdatabases/{webId}/attributecategories	Retrieve attribute categories for a given Asset Database.
createAttributeCategory	POST /assetdatabases/{webId}/attributecategories	Create an attribute category at the Asset Database root.
findElementAttributes	GET /assetdatabases/{webId}/elementattributes	Retrieves a list of element attributes matching the specified filters from the specified asset database.
getElementCategories	GET /assetdatabases/{webId}/elementcategories	Retrieve element categories for a given Asset Database.
createElementCategory	POST /assetdatabases/{webId}/elementcategories	Create an element category at the Asset Database root.
getElements	GET /assetdatabases/{webId}/elements	Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified asset database.
createElement	POST /assetdatabases/{webId}/elements	Create a child element.
getElementTemplates	GET /assetdatabases/{webId}/elementtemplates	Retrieve element templates based on the specified criteria. Only templates of instance type "Element" and "EventFrame" are returned. By default, all element and event frame templates in the specified Asset Database are returned.
createElementTemplate	POST /assetdatabases/{webId}/elementtemplates	Create a template at the Asset Database root. Specify InstanceType of "Element" or "EventFrame" to create element or event frame template respectively. Only these two types of templates can be created.
getEnumerationSets	GET /assetdatabases/{webId}/enumerationsets	Retrieve enumeration sets for given asset database.
createEnumerationSet	POST /assetdatabases/{webId}/enumerationsets	Create an enumeration set at the Asset Database.
findEventFrameAttributes	GET /assetdatabases/{webId}/eventframeattributes	Retrieves a list of event frame attributes matching the specified filters from the specified asset database.
getEventFrames	GET /assetdatabases/{webId}/eventframes	Retrieve event frames based on the specified conditions. By default, returns all children of the specified root resource that have been active in the past 8 hours.
createEventFrame	POST /assetdatabases/{webId}/eventframes	Create an event frame.
export	GET /assetdatabases/{webId}/export	Export the asset database.
importData	POST /assetdatabases/{webId}/import	Import an asset database.
getReferencedElements	GET /assetdatabases/{webId}/referencedelements	Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements at the root level of the asset database.
addReferencedElement	POST /assetdatabases/{webId}/referencedelements	Add a reference to an existing element to the specified database.
removeReferencedElement	DELETE /assetdatabases/{webId}/referencedelements	Remove a reference to an existing element from the specified database.
getSecurity	GET /assetdatabases/{webId}/security	Get the security information of the specified security item associated with the asset database for a specified user.
getSecurityEntries	GET /assetdatabases/{webId}/securityentries	Retrieve the security entries of the specified security item associated with the asset database based on the specified criteria. By default, all security entries for this asset database are returned.
createSecurityEntry	POST /assetdatabases/{webId}/securityentries	Create a security entry owned by the asset database.
getSecurityEntryByName	GET /assetdatabases/{webId}/securityentries/{name}	Retrieve the security entry of the specified security item associated with the asset database with the specified name.
updateSecurityEntry	PUT /assetdatabases/{webId}/securityentries/{name}	Update a security entry owned by the asset database.
deleteSecurityEntry	DELETE /assetdatabases/{webId}/securityentries/{name}	Delete a security entry owned by the asset database.
getTableCategories	GET /assetdatabases/{webId}/tablecategories	Retrieve table categories for a given Asset Database.
createTableCategory	POST /assetdatabases/{webId}/tablecategories	Create a table category on the Asset Database.
getTables	GET /assetdatabases/{webId}/tables	Retrieve tables for given Asset Database.
createTable	POST /assetdatabases/{webId}/tables	Create a table on the Asset Database.

getByPath

getByPath(String path, String selectedFields, String webIdType)

Retrieve an Asset Database by path.

Parameters

Name	Type	Description	Notes
path	String	The path to the database..	[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 an Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[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, PIAssetDatabase database)

Update an asset database by replacing items in its definition.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[required]
database	PIAssetDatabase	A partial database 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 an asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[required]

Return type

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

findAnalyses

findAnalyses(String webId, List field, Integer maxCount, String query, String selectedFields, String sortField, String sortOrder, Integer startIndex, String webIdType)

Retrieve analyses based on the specified conditions.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database to search for the analyses..	[required]
field	List	Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'..	[required]
maxCount	Integer	The maximum number of objects to be returned per call (page size). The default is 1000..	[optional]
query	String	The query string used for finding analyses. The default is null..	[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]
startIndex	Integer	The starting index (zero based) of the items to be returned. The default is 0..	[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]

getAnalysisCategories

getAnalysisCategories(String webId, String selectedFields, String webIdType)

Retrieve analysis categories for a given Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[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]

createAnalysisCategory

createAnalysisCategory(String webId, PIAnalysisCategory analysisCategory, String webIdType)

Create an analysis category at the Asset Database root.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database in which to create the analysis category..	[required]
analysisCategory	PIAnalysisCategory	The new analysis category 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]

Return type

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

getAnalysisTemplates

getAnalysisTemplates(String webId, List field, Integer maxCount, String query, String selectedFields, String sortField, String sortOrder, String webIdType)

Retrieve analysis templates based on the specified criteria. By default, all analysis templates in the specified Asset Database are returned.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database to search..	[required]
field	List	Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'..	[required]
maxCount	Integer	The maximum number of objects to be returned per call (page size). 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]

Return type

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

createAnalysisTemplate

createAnalysisTemplate(String webId, PIAnalysisTemplate template, String webIdType)

Create an analysis template at the Asset Database root.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database in which to create the analysis template..	[required]
template	PIAnalysisTemplate	The new analysis template 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]

Return type

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

getAttributeCategories

getAttributeCategories(String webId, String selectedFields, String webIdType)

Retrieve attribute categories for a given Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[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]

createAttributeCategory

createAttributeCategory(String webId, PIAttributeCategory attributeCategory, String webIdType)

Create an attribute category at the Asset Database root.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database in which to create the attribute category..	[required]
attributeCategory	PIAttributeCategory	The new attribute category 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]

Return type

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

findElementAttributes

findElementAttributes(String webId, String attributeCategory, String attributeDescriptionFilter, String attributeNameFilter, String attributeType, String elementCategory, String elementDescriptionFilter, String elementNameFilter, String elementTemplate, String elementType, Integer maxCount, Boolean searchFullHierarchy, String selectedFields, String sortField, String sortOrder, Integer startIndex, String webIdType)

Retrieves a list of element attributes matching the specified filters from the specified asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the asset database to use as the root of the search..	[required]
attributeCategory	String	Specify that returned attributes must have this category. The default is no filter..	[optional]
attributeDescriptionFilter	String	The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter..	[optional]
attributeNameFilter	String	The attribute name filter string used for finding objects. The default is no filter..	[optional]
attributeType	String	Specify that returned attributes' value type must be this value type. The default is no filter..	[optional]
elementCategory	String	Specify that the owner of the returned attributes must have this category. The default is no filter..	[optional]
elementDescriptionFilter	String	The element description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter..	[optional]
elementNameFilter	String	The element name filter string used for finding objects. The default is no filter..	[optional]
elementTemplate	String	Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter..	[optional]
elementType	String	Specify that the element of the returned attributes must have this AFElementType. The default is no filter..	[optional]
maxCount	Integer	The maximum number of objects to be returned (the page size). The default is 1000..	[optional]
searchFullHierarchy	Boolean	Specifies if the search should include objects nested further than immediate children of the given resource. 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]
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]
startIndex	Integer	The starting index (zero based) of the items to be returned. The default is 0..	[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]

getElementCategories

getElementCategories(String webId, String selectedFields, String webIdType)

Retrieve element categories for a given Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[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]

createElementCategory

createElementCategory(String webId, PIElementCategory elementCategory, String webIdType)

Create an element category at the Asset Database root.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database in which to create the element category..	[required]
elementCategory	PIElementCategory	The new element category 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]

Return type

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

getElements

getElements(String webId, String categoryName, String descriptionFilter, String elementType, Integer maxCount, String nameFilter, Boolean searchFullHierarchy, String selectedFields, String sortField, String sortOrder, Integer startIndex, String templateName, String webIdType)

Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database to use as the root of the search..	[required]
categoryName	String	Specify that returned elements must have this category. The default is no category filter..	[optional]
descriptionFilter	String	Specify that returned elements must have this description. The default is no description filter..	[optional]
elementType	String	Specify that returned elements must have this type. The default type is 'Any'..	[optional]
maxCount	Integer	The maximum number of objects to be returned per call (page size). The default is 1000..	[optional]
nameFilter	String	The name query string used for finding objects. The default is no filter..	[optional]
searchFullHierarchy	Boolean	Specifies if the search should include objects nested further than the immediate children of the searchRoot. 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]
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]
startIndex	Integer	The starting index (zero based) of the items to be returned. The default is 0..	[optional]
templateName	String	Specify that returned elements must have this template or a template derived from this template. The default is no template filter..	[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]

createElement

createElement(String webId, PIElement element, String webIdType)

Create a child element.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the asset database on which to create the element..	[required]
element	PIElement	The new element 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]

Return type

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

getElementTemplates

getElementTemplates(String webId, List field, Integer maxCount, String query, String selectedFields, String sortField, String sortOrder, String webIdType)

Retrieve element templates based on the specified criteria. Only templates of instance type "Element" and "EventFrame" are returned. By default, all element and event frame templates in the specified Asset Database are returned.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database to search..	[required]
field	List	Specifies which of the object's properties are searched. Multiple search fields may be specified with multiple instances of the parameter. The default is 'Name'..	[required]
maxCount	Integer	The maximum number of objects to be returned per call (page size). 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]

Return type

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

createElementTemplate

createElementTemplate(String webId, PIElementTemplate template, String webIdType)

Create a template at the Asset Database root. Specify InstanceType of "Element" or "EventFrame" to create element or event frame template respectively. Only these two types of templates can be created.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database in which to create the element template..	[required]
template	PIElementTemplate	The new element template 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]

Return type

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

getEnumerationSets

getEnumerationSets(String webId, String selectedFields, String webIdType)

Retrieve enumeration sets for given asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[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]

createEnumerationSet

createEnumerationSet(String webId, PIEnumerationSet enumerationSet, String webIdType)

Create an enumeration set at the Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database in which to create the enumeration set..	[required]
enumerationSet	PIEnumerationSet	The new enumeration set 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]

Return type

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

findEventFrameAttributes

findEventFrameAttributes(String webId, String attributeCategory, String attributeDescriptionFilter, String attributeNameFilter, String attributeType, String endTime, String eventFrameCategory, String eventFrameDescriptionFilter, String eventFrameNameFilter, String eventFrameTemplate, Integer maxCount, String referencedElementNameFilter, Boolean searchFullHierarchy, String searchMode, String selectedFields, String sortField, String sortOrder, Integer startIndex, String startTime, String webIdType)

Retrieves a list of event frame attributes matching the specified filters from the specified asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the asset database to use as the root of the search..	[required]
attributeCategory	String	Specify that returned attributes must have this category. The default is no filter..	[optional]
attributeDescriptionFilter	String	The attribute description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter..	[optional]
attributeNameFilter	String	The attribute name filter string used for finding objects. The default is no filter..	[optional]
attributeType	String	Specify that returned attributes' value type must be this value type. The default is no filter..	[optional]
endTime	String	A string representing the latest ending time for the event frames to be matched. The endTime must be greater than or equal to the startTime. The default is '*'..	[optional]
eventFrameCategory	String	Specify that the owner of the returned attributes must have this category. The default is no filter..	[optional]
eventFrameDescriptionFilter	String	The event frame description filter string used for finding objects. Only the first 440 characters of the description will be searched. For Asset Servers older than 2.7, a 400 status code (Bad Request) will be returned if this parameter is specified. The default is no filter..	[optional]
eventFrameNameFilter	String	The event frame name filter string used for finding objects. The default is no filter..	[optional]
eventFrameTemplate	String	Specify that the owner of the returned attributes must have this template or a template derived from this template. The default is no filter..	[optional]
maxCount	Integer	The maximum number of objects to be returned (the page size). The default is 1000..	[optional]
referencedElementNameFilter	String	The name query string which must match the name of a referenced element. The default is no filter..	[optional]
searchFullHierarchy	Boolean	Specifies if the search should include objects nested further than immediate children of the given resource. The default is 'false'..	[optional]
searchMode	String	Determines how the startTime and endTime parameters are treated when searching for event frames. The default is 'Overlapped'..	[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]
startIndex	Integer	The starting index (zero based) of the items to be returned. The default is 0..	[optional]
startTime	String	A string representing the earliest starting time for the event frames to be matched. startTime must be less than or equal to the endTime. The default is '*-8h'..	[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]

getEventFrames

getEventFrames(String webId, Boolean canBeAcknowledged, String categoryName, String endTime, Boolean isAcknowledged, Integer maxCount, String nameFilter, String referencedElementNameFilter, String referencedElementTemplateName, Boolean searchFullHierarchy, String searchMode, String selectedFields, List severity, String sortField, String sortOrder, Integer startIndex, String startTime, String templateName, String webIdType)

Retrieve event frames based on the specified conditions. By default, returns all children of the specified root resource that have been active in the past 8 hours.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the asset database to use as the root of the search..	[required]
canBeAcknowledged	Boolean	Specify the returned event frames' canBeAcknowledged property. The default is no canBeAcknowledged filter..	[optional]
categoryName	String	Specify that returned event frames must have this category. The default is no category filter..	[optional]
endTime	String	The ending time for the search. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '' if searchMode is not one of the 'Backward' or 'Forward*' values..	[optional]
isAcknowledged	Boolean	Specify the returned event frames' isAcknowledged property. The default no isAcknowledged filter..	[optional]
maxCount	Integer	The maximum number of objects to be returned per call (page size). The default is 1000..	[optional]
nameFilter	String	The name query string used for finding event frames. The default is no filter..	[optional]
referencedElementNameFilter	String	The name query string which must match the name of a referenced element. The default is no filter..	[optional]
referencedElementTemplateName	String	Specify that returned event frames must have an element in the event frame's referenced elements collection that derives from the template. Specify this parameter by name..	[optional]
searchFullHierarchy	Boolean	Specifies whether the search should include objects nested further than the immediate children of the search root. The default is 'false'..	[optional]
searchMode	String	Determines how the startTime and endTime parameters are treated when searching for event frame objects to be included in the returned collection. If this parameter is one of the 'Backward*' or 'Forward*' values, none of endTime, sortField, or sortOrder may be specified. The default is 'Overlapped'..	[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]
severity	List	Specify that returned event frames must have this severity. Multiple severity values may be specified with multiple instances of the parameter. The default is no severity filter..	[optional]
sortField	String	The field or property of the object used to sort the returned collection. The default is 'Name' if searchMode is not one of the 'Backward*' or 'Forward*' values..	[optional]
sortOrder	String	The order that the returned collection is sorted. The default is 'Ascending' if searchMode is not one of the 'Backward*' or 'Forward*' values..	[optional]
startIndex	Integer	The starting index (zero based) of the items to be returned. The default is 0..	[optional]
startTime	String	The starting time for the search. startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the event frame's startTime or endTime. The default is '*-8h'..	[optional]
templateName	String	Specify that returned event frames must have this template or a template derived from this template. The default is no template filter. Specify this parameter by name..	[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]

createEventFrame

createEventFrame(String webId, PIEventFrame eventFrame, String webIdType)

Create an event frame.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database on which to create the event frame..	[required]
eventFrame	PIEventFrame	The new event frame 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]

Return type

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

export

export(String webId, String endTime, List exportMode, String startTime)

Export the asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[required]
endTime	String	The latest ending time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*'..	[optional]
exportMode	List	Indicates the type of export to perform. The default is 'StrongReferences'. Multiple export modes may be specified by using multiple instances of exportMode..	[optional]
startTime	String	The earliest starting time for AFEventFrame, AFTransfer, and AFCase objects that may be part of the export. The default is '*-30d'..	[optional]

Return type

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

importData

importData(String webId, List importMode)

Import an asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the asset database..	[required]
importMode	List	Indicates the type of import to perform. The default is 'AllowCreate	AllowUpdate

Return type

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

getReferencedElements

getReferencedElements(String webId, String categoryName, String descriptionFilter, String elementType, Integer maxCount, String nameFilter, String selectedFields, String sortField, String sortOrder, Integer startIndex, String templateName, String webIdType)

Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements at the root level of the asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the resource to use as the root of the search..	[required]
categoryName	String	Specify that returned elements must have this category. The default is no category filter..	[optional]
descriptionFilter	String	Specify that returned elements must have this description. The default is no description filter..	[optional]
elementType	String	Specify that returned elements must have this type. The default type is 'Any'..	[optional]
maxCount	Integer	The maximum number of objects to be returned per call (page size). The default is 1000..	[optional]
nameFilter	String	The name query string used for finding objects. 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]
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]
startIndex	Integer	The starting index (zero based) of the items to be returned. The default is 0..	[optional]
templateName	String	Specify that returned elements must have this template or a template derived from this template. The default is no template filter..	[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]

addReferencedElement

addReferencedElement(String webId, List referencedElementWebId, String referenceType)

Add a reference to an existing element to the specified database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database which the referenced element will be added to..	[required]
referencedElementWebId	List	The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter..	[required]
referenceType	String	The name of the reference type between the parent and the referenced element. This must be a "strong" reference type. The default is "parent-child"..	[optional]

Return type

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

removeReferencedElement

removeReferencedElement(String webId, List referencedElementWebId)

Remove a reference to an existing element from the specified database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database which the referenced element will be removed from..	[required]
referencedElementWebId	List	The ID of the referenced element. Multiple referenced elements may be specified with multiple instances of the parameter..	[required]

Return type

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

getSecurity

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 database for a specified user.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the asset database 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]

Return type

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

getSecurityEntries

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

Retrieve the security entries of the specified security item associated with the asset database based on the specified criteria. By default, all security entries for this asset database are returned.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the asset database..	[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]

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 securityItem, String webIdType)

Create a security entry owned by the asset database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the asset database 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]

Return type

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

getSecurityEntryByName

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

Retrieve the security entry of the specified security item associated with the asset database 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 asset database..	[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]

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, String securityItem)

Update a security entry owned by the asset database.

Parameters

Name	Type	Description	Notes
name	String	The name of the security entry..	[required]
webId	String	The ID of the asset database 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]

Return type

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

deleteSecurityEntry

deleteSecurityEntry(String name, String webId, Boolean applyToChildren, String securityItem)

Delete a security entry owned by the asset database.

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 asset database 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]

Return type

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

getTableCategories

getTableCategories(String webId, String selectedFields, String webIdType)

Retrieve table categories for a given Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[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]

createTableCategory

createTableCategory(String webId, PITableCategory tableCategory, String webIdType)

Create a table category on the Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database in which to create the table category..	[required]
tableCategory	PITableCategory	The new table category 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]

Return type

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

getTables

getTables(String webId, String selectedFields, String webIdType)

Retrieve tables for given Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database..	[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]

createTable

createTable(String webId, PITable table, String webIdType)

Create a table on the Asset Database.

Parameters

Name	Type	Description	Notes
webId	String	The ID of the database in which to create the table..	[required]
table	PITable	The new table 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]

Return type

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