| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /elements | Retrieve an element by path. |
| get | GET /elements/{webId} | Retrieve an element. |
| update | PATCH /elements/{webId} | Update an element by replacing items in its definition. |
| delete | DELETE /elements/{webId} | Delete an element. |
| getAnalyses | GET /elements/{webId}/analyses | Retrieve analyses based on the specified conditions. |
| createAnalysis | POST /elements/{webId}/analyses | Create an Analysis. |
| getAttributes | GET /elements/{webId}/attributes | Get the attributes of the specified element. |
| createAttribute | POST /elements/{webId}/attributes | Create a new attribute of the specified element. |
| getCategories | GET /elements/{webId}/categories | Get an element's categories. |
| createConfig | POST /elements/{webId}/config | Executes the create configuration function of the data references found within the attributes of the element, and optionally, its children. |
| findElementAttributes | GET /elements/{webId}/elementattributes | Retrieves a list of element attributes matching the specified filters from the specified element. |
| getElements | GET /elements/{webId}/elements | Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified element. |
| createElement | POST /elements/{webId}/elements | Create a child element. |
| getEventFrames | GET /elements/{webId}/eventframes | Retrieve event frames that reference this element based on the specified conditions. By default, returns all event frames that reference this element that have been active in the past 8 hours. |
| getReferencedElements | GET /elements/{webId}/referencedelements | Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements of the current resource. |
| addReferencedElement | POST /elements/{webId}/referencedelements | Add a reference to an existing element to the child elements collection. |
| removeReferencedElement | DELETE /elements/{webId}/referencedelements | Remove a reference to an existing element from the child elements collection. |
| getSecurity | GET /elements/{webId}/security | Get the security information of the specified security item associated with the element for a specified user. |
| getSecurityEntries | GET /elements/{webId}/securityentries | Retrieve the security entries associated with the element based on the specified criteria. By default, all security entries for this element are returned. |
| createSecurityEntry | POST /elements/{webId}/securityentries | Create a security entry owned by the element. |
| getSecurityEntryByName | GET /elements/{webId}/securityentries/{name} | Retrieve the security entry associated with the element with the specified name. |
| updateSecurityEntry | PUT /elements/{webId}/securityentries/{name} | Update a security entry owned by the element. |
| deleteSecurityEntry | DELETE /elements/{webId}/securityentries/{name} | Delete a security entry owned by the element. |
| getMultiple | GET /elements/multiple | Retrieve multiple elements by web id or path. |
| getElementsQuery | GET /elements/search | Retrieve elements based on the specified conditions. By default, returns all the elements. |
| createSearchByAttribute | POST /elements/searchbyattribute | Create a link for a "Search Elements By Attribute Value" operation, whose queries are specified in the request content. The SearchRoot is specified by the Web Id of the root Element. If the SearchRoot is not specified, then the search starts at the Asset Database. ElementTemplate must be provided as the Web ID of the ElementTemplate, which are used to create the Elements. All the attributes in the queries must be defined as AttributeTemplates on the ElementTemplate. An array of attribute value queries are ANDed together to find the desired Element objects. At least one value query must be specified. There are limitations on SearchOperators. |
| executeSearchByAttribute | GET /elements/searchbyattribute/{searchId} | Execute a "Search Elements By Attribute Value" operation. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve an element by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the element.. | [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 element.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element.. | [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]
update(String webId, PIElement element)
Update an element by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element.. | [required] |
| element | PIElement | A partial element containing the desired changes.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
delete(String webId)
Delete an element.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getAnalyses(String webId, Integer maxCount, String selectedFields, String sortField, String sortOrder, Integer startIndex, String webIdType)
Retrieve analyses based on the specified conditions.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element, which is the Target of the analyses.. | [required] |
| maxCount | Integer | The maximum number of objects to be returned per call (page size). The default is 1000.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createAnalysis(String webId, PIAnalysis analysis, String webIdType)
Create an Analysis.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element on which to create the Analysis.. | [required] |
| analysis | PIAnalysis | The new Analysis 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]
getAttributes(String webId, String categoryName, Integer maxCount, String nameFilter, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String sortField, String sortOrder, Integer startIndex, String templateName, String valueType, String webIdType)
Get the attributes of the specified element.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element.. | [required] |
| categoryName | String | Specify that returned attributes must have this category. The default is no category 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 attributes. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes 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] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [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 attributes must be members of this template. The default is no template filter.. | [optional] |
| valueType | String | Specify that returned attributes' value type must be the given value type. The default is no value type 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createAttribute(String webId, PIAttribute attribute, String webIdType)
Create a new attribute of the specified element.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element on which to create the attribute.. | [required] |
| attribute | PIAttribute | The definition of the new attribute.. | [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]
getCategories(String webId, String selectedFields, String webIdType)
Get an element's categories.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element.. | [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]
createConfig(String webId, Boolean includeChildElements)
Executes the create configuration function of the data references found within the attributes of the element, and optionally, its children.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element.. | [required] |
| includeChildElements | Boolean | If true, includes the child elements of the specified element.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
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 element.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
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 element.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createElement(String webId, PIElement element, String webIdType)
Create a child element.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the parent element 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getEventFrames(String webId, Boolean canBeAcknowledged, String categoryName, String endTime, Boolean isAcknowledged, Integer maxCount, String nameFilter, String searchMode, String selectedFields, List severity, String sortField, String sortOrder, Integer startIndex, String startTime, String templateName, String webIdType)
Retrieve event frames that reference this element based on the specified conditions. By default, returns all event frames that reference this element that have been active in the past 8 hours.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element whose related event frames are sought.. | [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] |
| 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
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 of the current resource.
| 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
addReferencedElement(String webId, List referencedElementWebId, String referenceType)
Add a reference to an existing element to the child elements collection.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element 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. The default is "parent-child".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
removeReferencedElement(String webId, List referencedElementWebId)
Remove a reference to an existing element from the child elements collection.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurity(String webId, List userIdentity, Boolean forceRefresh, String selectedFields, String webIdType)
Get the security information of the specified security item associated with the element for a specified user.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityEntries(String webId, String nameFilter, String selectedFields, String webIdType)
Retrieve the security entries associated with the element based on the specified criteria. By default, all security entries for this element are returned.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element.. | [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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createSecurityEntry(String webId, PISecurityEntry securityEntry, Boolean applyToChildren, String webIdType)
Create a security entry owned by the element.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the element 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSecurityEntryByName(String name, String webId, String selectedFields, String webIdType)
Retrieve the security entry associated with the element 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 element.. | [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]
updateSecurityEntry(String name, String webId, PISecurityEntry securityEntry, Boolean applyToChildren)
Update a security entry owned by the element.
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the security entry.. | [required] |
| webId | String | The ID of the element 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
deleteSecurityEntry(String name, String webId, Boolean applyToChildren)
Delete a security entry owned by the element.
| 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 element 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getMultiple(Boolean asParallel, String includeMode, List path, String selectedFields, List webId, String webIdType)
Retrieve multiple elements by web id or path.
| Name | Type | Description | Notes |
|---|---|---|---|
| asParallel | Boolean | Specifies if the retrieval processes should be run in parallel on the server. This may improve the response time for large amounts of requested attributes. The default is 'false'.. | [optional] |
| includeMode | String | The include mode for the return list. The default is 'All'.. | [optional] |
| path | List | The path of an element. Multiple elements may be specified with multiple instances of the parameter.. | [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] |
| webId | List | The ID of an element. Multiple elements may be specified with multiple instances of the parameter.. | [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]
getElementsQuery(String databaseWebId, Integer maxCount, String query, String selectedFields, Integer startIndex, String webIdType)
Retrieve elements based on the specified conditions. By default, returns all the elements.
| Name | Type | Description | Notes |
|---|---|---|---|
| databaseWebId | String | The ID of the asset database to use as the root of the query.. | [optional] |
| maxCount | Integer | The maximum number of objects to be returned per call (page size). The default is 1000.. | [optional] |
| query | String | The query string is a list of filters used to perform an AFSearch for the elements in the asset database. An example would be: "query=Name:=MyElement* Template:=ElementTemplate*".. | [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] |
| 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] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
createSearchByAttribute(PISearchByAttribute query, Boolean noResults, String webIdType)
Create a link for a "Search Elements By Attribute Value" operation, whose queries are specified in the request content. The SearchRoot is specified by the Web Id of the root Element. If the SearchRoot is not specified, then the search starts at the Asset Database. ElementTemplate must be provided as the Web ID of the ElementTemplate, which are used to create the Elements. All the attributes in the queries must be defined as AttributeTemplates on the ElementTemplate. An array of attribute value queries are ANDed together to find the desired Element objects. At least one value query must be specified. There are limitations on SearchOperators.
| Name | Type | Description | Notes |
|---|---|---|---|
| query | PISearchByAttribute | The query of search by attribute.. | [required] |
| noResults | Boolean | If false, the response content will contain the first page of the search results. If true, the response content will be empty. The default is false.. | [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]
executeSearchByAttribute(String searchId, String categoryName, String descriptionFilter, Integer maxCount, String nameFilter, Boolean searchFullHierarchy, String selectedFields, String sortField, String sortOrder, Integer startIndex, String webIdType)
Execute a "Search Elements By Attribute Value" operation.
| Name | Type | Description | Notes |
|---|---|---|---|
| searchId | String | The encoded search Id of the "Search Elements By Attribute Value" operation.. | [required] |
| categoryName | String | Specify that the owner of the returned attributes must have this category. 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] |
| descriptionFilter | 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] |
| maxCount | Integer | The maximum number of objects to be returned. 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] |
| 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]