acl

This tag pulls back a list of ACL IDs for the current user based on the attributes values so they can be referenced inside of a script.

Hierarchy

Syntax

Copy 
<acl
     id = string
     typeartifactid= string
     typeartifactguid= string
     type = string
/>

Attributes

Name Description Data Type Required
id the ID for the field you want to reference inside the Relativity script. string yes
typeartifactid the Artifact ID for the object type that the ACL ID's are referencing. string no
typeartifactguid the Artifact Guid for the object that the ACL ID's are referencing. string no
type the permission type for the ACL ID's. Accepted values:
  • View
  • Edit
  • Delete
 string yes

Note: You have to specify either the artifact guide or the artifact ID of the object type in order for the list to return correctly.

Example

This script shows how to add security, enabling developers to write security-aware scripts.

Copy 
<script>
     <name>Security Example</name>
     <description>Examples of how to use security</description>
     <category></category>
     <input></input>
     <security>
          <acl id="id" type="delete" typeartifactguid="<!--guid of an object type -->" />
            
     </security>
     <action returns="table"><![CDATA[
          SELECT * FROM [Field] WHERE [AccessControlListID] in (#id#)
     ]]></action>
</script>