Object Type Manager (REST)

The body of the request must contain the following fields unless specifically identified as optional:

• ObjectTypeRequest - represents a request to create or update an object type. It contains the following fields:
  • ParentObjectType - indicates the parent object type of the object type. For example, an object type may be a child of the Document object. This field contains the following subfields:
    • Value - contains an ArtifactTypeID, which is an identifier used to specify an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10. The Value field also contains the Artifact ID of the object type.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The object type is linked to the applications in this array. If the array is empty, then the object type isn't linked to any application.
  • Name - the user-friendly name of the object type.
  • CopyInstancesOnCaseCreation - a Boolean value indicating whether instances of this object type are copied when you create a new workspace. For more information, see Fields for an object type.
  • CopyInstancesOnParentCopy - a Boolean value indicating whether the child objects are copied when the parent object is copied. For more information, see Fields for an object type.
  • EnableSnapshotAuditingOnDelete - a Boolean value indicating whether to capture audit information about the current field values for an object. For more information, see Fields for an object type.
  • PersistentListsEnabled - a Boolean value indicating whether users can save lists of these object instances.
  • PivotEnabled - a Boolean value indicating whether pivot functionality is available on objects of this type. Pivot provides the functionality to analyze and report trends or patterns by querying specific sets of data and summarizing the results. For more information, see Pivot.
  • SamplingEnabled - a Boolean value indicating whether the sampling functionality is enabled on the object. You can use sampling to create a group of documents for quality control or other purposes. For more information, see Sampling.
  • Keywords - optional words or phrases used to describe the object type.
  • Notes - an optional description or other information about the object type.

{
   "ObjectTypeRequest" : {
       "ParentObjectType": {
           "Secured": false,
           "Value": {
               "ArtifactTypeID": 10,
               "ArtifactID": 1035231
           }
        },
        "RelativityApplications":[
           {
            "ArtifactID": 1045231
           }
         ],
        "Name": "My Custom Object Type",
        "CopyInstancesOnCaseCreation": false,
        "CopyInstancesOnParentCopy": false,
        "EnableSnapshotAuditingOnDelete": true,
        "PersistentListsEnabled": false,
        "PivotEnabled": true,
        "SamplingEnabled": false,
        "Keywords": "",
        "Notes": ""
   }
}

• ArtifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
• ParentObjectType - contains information about the parent object type, as follows:
  • Secured - indicates whether the current user has permission to view the setting in the Value field.
  • Value - contains the following fields:
    • Name - the user-friendly name for the parent object type.
    • ArtifactTypeID - an identifier used to specify an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
    • ArtifactID - the Artifact ID of the parent object type.
    • Guids - an array of GUIDs used to identify the parent object type.
• CopyInstancesOnCaseCreation - a Boolean value indicating whether instances of this object type are copied when you create a new workspace. For more information, see Fields for an object type.
• CopyInstancesOnParentCopy - a Boolean value indicating whether the child objects are copied when the parent object is copied. For more information, see Fields for an object type.
• EnableSnapshotAuditingOnDelete - a Boolean value indicating whether to capture audit information about the current field values for an object. For more information, see .
• IsDynamic - a Boolean value indicating whether this object type is a custom type that is user-created.
• IsSystem - a Boolean value indicating whether this object type is available as an out-of-the-box type provided with Relativity.
• IsViewEnabled - a Boolean value indicating whether the view for the object type is enabled.
• PersistentListsEnabled - a Boolean value indicating whether users can save lists of these object instances.
• PivotEnabled - a Boolean value indicating whether pivot functionality is available on objects of this type. Pivot provides the functionality to analyze and report trends or patterns by querying specific sets of data and summarizing the results. For more information, see Pivoton the RelativityOne Documentation site.
• SamplingEnabled - a Boolean value indicating whether the sampling functionality is enabled on the object. You can use sampling to create a group of documents for quality control or other purposes. For more information, see Sampling on the RelativityOne Documentation site.
• FieldByteUsage - an integer value indicating the number of bytes used by the fields on the object type.

• RelativityApplications - contains the following fields:
  • HasSecuredItems - a Boolean value indicating whether the application contains items that the current user doesn't have permission to access.
  • ViewableItems - an array of identifier objects for items that are accessible to the current user. For example, an object in this array would contain the name, Artifact IDs, and GUIDs for an application. See DisplayableObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.
• CreatedOn - the date and time when the object type was added to Relativity.
• CreatedBy - contains the Artifact ID and name of the user who created the object type. It also contains an array of GUIDs used to identify the user.
• LastModifiedBy - contains the Artifact ID and name of the user who recently updated the object type. It also contains an array of GUIDs used to identify the user.
• LastModifiedOn - the date and time when the object type was most recently modified.
• Keywords - optional words or phrases used to describe the object type.
• Notes - an optional description or other information about the object type.
• Meta - provides additional information available as extended metadata. It includes the following fields:
  • Unsupported - an array of properties that indicate functionality not available on the current instance of this object type. For example, if a user couldn't persist objects of this type in a list, then array would include PersistentListsEnabled.
  • ReadOnly - an array of object type properties that can't be modified, such its name or parent object type.
• Actions - an array of Action objects indicating operations that you have permissions to perform on this object type. For example, you may not have permissions to modify an object type that is part of a locked application. Each Action object contains the following fields that are available as extended metadata:
  • Name - name of an operation available through REST for the object type, such as delete, update, and so on.
  • Href - the URL used to make an HTTP request for the operation.
  • Verb - the name of the HTTP method for the operation.
  • IsAvailable - a Boolean value indicating whether you have permissions to perform the operation on this object type.
  • Reason - provides an explanation for the unavailability of an action.
• Name - the user-friendly name for the object type.
• ArtifactID - the Artifact ID of the object type.
• Guids - an array of GUIDs used to identify the object type.

{
    "ArtifactTypeID": 5,
    "ParentObjectType": {
        "Secured": false,
        "Value": {
            "Name": "System",
            "ArtifactTypeID": 1,
            "ArtifactID": 1016168,
            "Guids": []
        }
    },
    "CopyInstancesOnCaseCreation": false,
    "CopyInstancesOnParentCopy": false,
    "EnableSnapshotAuditingOnDelete": true,
    "IsDynamic": false,
    "IsSystem": true,
    "IsViewEnabled": true,
    "PersistentListsEnabled": false,
    "PivotEnabled": false,
    "SamplingEnabled": false,
    "FieldByteUsage": 0,
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": []
    },
    "CreatedOn": "2018-05-14T18:31:49.787",
    "CreatedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 9,
        "Guids": []
    },
    "LastModifiedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 9,
        "Guids": []
    },
    "LastModifiedOn": "2018-05-14T18:31:49.787",
    "Keywords": "",
    "Notes": "RDO in Admin",
    "Name": "Client",
    "ArtifactID": 1016170,
    "Guids": []
}

{
    "ArtifactTypeID": 5,
    "ParentObjectType": {
        "Secured": false,
        "Value": {
            "Name": "System",
            "ArtifactTypeID": 1,
            "ArtifactID": 1016168,
            "Guids": []
        }
    },
    "CopyInstancesOnCaseCreation": false,
    "CopyInstancesOnParentCopy": false,
    "EnableSnapshotAuditingOnDelete": true,
    "IsDynamic": false,
    "IsSystem": true,
    "IsViewEnabled": true,
    "PersistentListsEnabled": false,
    "PivotEnabled": false,
    "SamplingEnabled": false,
    "FieldByteUsage": 0,
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": []
    },
    "CreatedOn": "2018-05-14T18:31:49.787",
    "CreatedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 9,
        "Guids": []
    },
    "LastModifiedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 9,
        "Guids": []
    },
    "LastModifiedOn": "2018-05-14T18:31:49.787",
    "Keywords": "",
    "Notes": "RDO in Admin",
    "Meta": {
        "Unsupported": [
            "SamplingEnabled",
            "PersistentListsEnabled",
            "CopyInstancesOnCaseCreation",
            "RelativityApplications",
            "CopyInstancesOnParentCopy",
            "UseRelativityForms"
        ],
        "ReadOnly": [
            "ParentObjectType",
            "IsDynamic",
            "EnableSnapshotAuditingOnDelete",
            "PivotEnabled",
            "Name"
        ]
    },
    "Actions": [
        {
            "Name": "Delete",
            "Href": "Relativity.ObjectTypes/workspace/-1/objecttypes/1016170",
            "Verb": "DELETE",
            "IsAvailable": true,
            "Reason": []
        },
        {
            "Name": "Update",
            "Href": "Relativity.ObjectTypes/workspace/-1/objecttypes/1016170",
            "Verb": "PUT",
            "IsAvailable": true,
            "Reason": []
        }
    ],
    "Name": "Client",
    "ArtifactID": 1016170,
    "Guids": []
}

The body of the request must contain the following fields unless specifically identified as optional:

• ObjectTypeRequest - represents a request to create or update an object type. It contains the following fields:
  • ParentObjectType - indicates the parent object type of the object type. For example, an object type may be a child of the Document object. This field contains the following subfields:
    • Value - contains an ArtifactTypeID, which is an identifier used to specify an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10. The Value field also contains the Artifact ID of the object type.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The object type is linked to the applications in this array. If the array is empty, then the object type isn't linked to any application.
  • Name - the user-friendly name of the object type.
  • CopyInstancesOnCaseCreation - a Boolean value indicating whether instances of this object type are copied when you create a new workspace. For more information, see Fields for an object type.
  • CopyInstancesOnParentCopy - a Boolean value indicating whether the child objects are copied when the parent object is copied. For more information, see Fields for an object type.
  • EnableSnapshotAuditingOnDelete - a Boolean value indicating whether to capture audit information about the current field values for an object. For more information, see Fields for an object type.
  • PersistentListsEnabled - a Boolean value indicating whether users can save lists of these object instances.
  • PivotEnabled - a Boolean value indicating whether pivot functionality is available on objects of this type. Pivot provides the functionality to analyze and report trends or patterns by querying specific sets of data and summarizing the results. For more information, see Pivot.
  • SamplingEnabled - a Boolean value indicating whether the sampling functionality is enabled on the object. You can use sampling to create a group of documents for quality control or other purposes. For more information, see Sampling.
  • Keywords - optional words or phrases used to describe the object type.
  • Notes - an optional description or other information about the object type.

• LastModifiedOn - the date and time when the object type was most recently modified. This field is only required if you want to restrict the update of an object type to the date that it was last modified. The value must match the LastModifiedOn date for the object type stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.

{
   "ObjectTypeRequest":{
      "ParentObjectType":{
         "Secured":false,
        "Value": {
            "Name": "System",
            "ArtifactTypeID": 1,
            "ArtifactID": 1016168,
            "Guids": []
        }
      },
      "RelativityApplications":[
         {
            "ArtifactID": 1045231
         }
      ],
      "Name":"My Object Type",
      "CopyInstancesOnCaseCreation":false,
      "CopyInstancesOnParentCopy":false,
      "EnableSnapshotAuditingOnDelete":true,
      "PersistentListsEnabled":false,
      "PivotEnabled":false,
      "SamplingEnabled":false,
      "Keywords":"updated",
      "Notes":"Renamed object type"
   },
   "LastModifiedOn":"2018-10-19T18:41:20.54"
}

[
    {
        "Name": "Analytics Categorization Result",
        "ArtifactTypeID": 1000017,
        "ArtifactID": 1036390,
        "Guids": []
    },
    {
        "Name": "Analytics Categorization Set",
        "ArtifactTypeID": 1000018,
        "ArtifactID": 1036399,
        "Guids": []
    },
    {
        "Name": "Analytics Categorization Set Build History",
        "ArtifactTypeID": 1000045,
        "ArtifactID": 1039799,
        "Guids": []
    },
    {
        "Name": "Analytics Category",
        "ArtifactTypeID": 1000019,
        "ArtifactID": 1036408,
        "Guids": []
    },
    {
        "Name": "Workspace",
        "ArtifactTypeID": 8,
        "ArtifactID": 1035229,
        "Guids": []
    }
]

The response contains the following fields:

• ObjectType - the type of the Relativity object dependent on the object selected for deletion.
  • Secured - indicates whether the current user has permissions to view the setting in the Value field.
  • Value - represents a securable value, which is the object type.
• Action - indicates whether a dependent object is deleted or unlinked when a specific object is deleted.
• Count - indicates the number of objects with a dependency on a specific object selected for deletion.
  • Secured - indicates whether the current user has permission to view the setting in the Value field.
  • Value - represents a securable value, which is the number of dependent objects.
• Connection - indicates whether the object for deletion is a parent, or a field on a single or multiple object field.
  • Secured - indicates whether the current user has permission to view the setting in the Value field.
  • Value - represents a securable value, which is the type of relationship between the objects. For example, the value is Parent when the dependent object is a child, and Field: {field name} when the dependent object is a field on a single or multiple object field.
• HierarchicLevel - indicates the degree of dependency between object types. For example, you might select an object type for deletion that has a child object type. The fields and views associated with the child object type have a dependency with a hierarchical level of 1.

[
    {
        "ObjectType": {
            "Secured": false,
            "Value": "Object Type (Level 1)"
        },
        "Action": "Delete",
        "Count": {
            "Secured": false,
            "Value": 1
        },
        "Connection": {
            "Secured": false,
            "Value": "Parent"
        },
        "HierarchicLevel": 0
    },
    {
        "ObjectType": {
            "Secured": false,
            "Value": "Layout"
        },
        "Action": "Delete",
        "Count": {
            "Secured": false,
            "Value": 1
        },
        "Connection": {
            "Secured": false,
            "Value": "Child of: Object Type (Level 1)"
        },
        "HierarchicLevel": 0
    },
    {
        "ObjectType": {
            "Secured": false,
            "Value": "View"
        },
        "Action": "Delete",
        "Count": {
            "Secured": false,
            "Value": 1
        },
        "Connection": {
            "Secured": false,
            "Value": "Child of: Object Type (Level 1)"
        },
        "HierarchicLevel": 0
    }
]

• ID - the reference ID of the event handler assigned by Relativity.
• ArtifactID - the artifact ID of the object type.
• Execution - the type of event handler, such as Console, Post Save, and others. For more information, see the EventHandlerExecution enumeration in the Services API, and Develop object type event handlers.
• Application - an application that contains the event handler. This field contains the following:
  • Name - the user-friendly name for the application.
  • ArtifactID - the Artifact ID of the application.
  • Guids - an array of GUIDs used to identify the application.

• AssemblyName - the name of the .NET assembly containing the event handler code.
• ClassName - the name of the class that defines the event handler.
• CompanyName - the name of the company that implemented or provided the event handler.
• Description - general information about the event handler.

[
    {
        "ID": 20565,
        "ArtifactID": 1042543,
        "Execution": "PreSave",
        "Application": {
            "Name": "Default",
            "ArtifactID": 0,
            "Guids": [
                "3e86b18f-8b55-45c4-9a57-9e0cbd7baf46"
            ]
        },
        "AssemblyName": "myassembly.dll",
        "ClassName": "myassembly.MyPreSave",
        "CompanyName": "",
        "Description": ""
    }
]

• ID - the reference ID of the event handler assigned by Relativity.
• ArtifactID - the artifact ID of the object type.
• Execution - the type of event handler, such as Console, Post Save, and others. For more information, see the EventHandlerExecution enumeration in the Services API, and Develop object type event handlers.
• Application - an application that contains the event handler. This field contains the following:
  • Name - the user-friendly name for the application.
  • ArtifactID - the Artifact ID of the application.
  • Guids - an array of GUIDs used to identify the application.

• AssemblyName - the name of the .NET assembly containing the event handler code.
• ClassName - the name of the class that defines the event handler.
• CompanyName - the name of the company that implemented or provided the event handler.
• Description - general information about the event handler.

[
   {
      "ID":20564,
      "ArtifactID":0,
      "Execution":"PreSave",
      "Application":{
         "Name":"Default",
         "ArtifactID":0,
         "Guids":[
            "3e86b18f-8b55-45c4-9a57-9e0cbd7baf46"
         ]
      },
      "AssemblyName":"testEH.dll",
      "ClassName":"testEH.REHEPreSave",
      "CompanyName":"",
      "Description":""
   },
   {
      "ID":20566,
      "ArtifactID":0,
      "Execution":"PreSave",
      "Application":{
         "Name":"Default",
         "ArtifactID":0,
         "Guids":[
            "3e86b18f-8b55-45c4-9a57-9e0cbd7baf46"
         ]
      },
      "AssemblyName":"testEHg.dll",
      "ClassName":"testEHg.REHEPreSave",
      "CompanyName":"",
      "Description":""
   },
   {
      "ID":20565,
      "ArtifactID":0,
      "Execution":"PreSave",
      "Application":{
         "Name":"Default",
         "ArtifactID":0,
         "Guids":[
            "3e86b18f-8b55-45c4-9a57-9e0cbd7baf46"
         ]
      },
      "AssemblyName":"myassembly.dll",
      "ClassName":"myassembly.MyPreSave",
      "CompanyName":"",
      "Description":""
   }
]

• Choice behavior

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/choicebehaviorobjectrules

• Custom single object add link visibility

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/customsingleobjectaddlinkvisibilityobjectrules

• Default layout

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/defaultlayoutobjectrules

• Default layout on new

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/defaultlayoutonnewobjectrules

• Global button visibility

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/globalbuttonvisibilityobjectrules

• Mass action visibility

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/massactionvisibilityobjectrules

• New button override

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/newbuttonoverrideobjectrules

• Sub-list button visibility

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/sublistbuttonvisibilityobjectrules

• Override edit link URL

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/overrideeditlinkobjectrules

• Override view link URL

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/overrideeditlinkobjectrules

To create a sub-list visibility rule, send a POST request to a URL with the following format:

<host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/sublistbuttonvisibilityobjectrules

The body of the request must contain the following fields unless specifically identified as optional:

• objectRuleRequest - request to create or update a rule. It contains the following fields:
  • Name - the user-friendly name of the rule.
  • ObjectType - contains the Artifact ID of the object type.
  • Field - contains a Value specifying the Artifact ID of the field, which affects the button visibility.
  • Choice - contains a Value specifying the Artifact ID of the choice, which affects the button visibility.
  • SubListObject - contains a Value specifying the Artifact ID of the associative object list controlled by the rule.
  • ShowNew - a Boolean value indicating whether to display the New button on the associative object list. The default value is true.
  • ShowLink - a Boolean value indicating whether to display the Link button on the associative object list. The default value is true.
  • ShowUnlink - a Boolean value indicating whether to display the Unlink button on the associative object list. The default value is true.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The object rule is linked to the applications in this array. If the array is empty, then the object rule isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.

{
    "objectRuleRequest":{
         "Name": "Sample rule for sublist button",
         "ObjectType": {
            "ArtifactID": 1042378
        },
        "Field": {
            "Value": {
                "ArtifactID": 1042566
            }
        },
        "Choice": {
            "Value": {
                "ArtifactID": 1042568
            }
        },
        "SubListObject": {
            "Value": {
                "ArtifactID": 1042586
            }
        },
        "ShowNew": true,
        "ShowLink": false,
        "ShowUnlink": false,
        "RelativityApplications": []
    }
}

To create a choice rule, send a POST request to a URL with the following format:

<host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/choicebehaviorobjectrules

The body of the request must contain the following fields unless specifically identified as optional:

• objectRuleRequest - request to create or update a rule. It contains the following fields:
  • Name - the user-friendly name of the rule.
  • ObjectType - contains the Artifact ID of the object type.
  • AllowAdd - a Boolean value indicating whether the user can mass copy choices.
  • AllowDelete - a Boolean value indicating whether the user can mass delete choices.
  • AllowRename - a Boolean value indicating whether the user can rename a choice.
  • Field - contains a Value specifying the Artifact ID of the field, which affects the choice behavior.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The object rule is linked to the applications in this array. If the array is empty, then the object rule isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.

{
    "objectRuleRequest":{
        "Name": "Sample Rule One",
        "ObjectType": {
            "ArtifactID": 1042378
        },
        "AllowAdd": true,
        "AllowDelete": true,
        "AllowRename": true,
        "Field": {
            "Value": {
                "ArtifactID": 1042565
            }
        },
        "RelativityApplications": []
      }
}

To create a layout rule, send a POST request to a URL with the following format:

<host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/defaultlayoutobjectrules

The body of the request must contain the following fields unless specifically identified as optional:

• objectRuleRequest - request to create or update a rule. It contains the following fields:
  • Name - the user-friendly name of the rule.
  • ObjectType - contains the Artifact ID of the object type.
  • Field - contains a Value specifying the Artifact ID of the field, which controls the layout behavior.
  • Layout - contains a Value specifying the Artifact ID of the layout.
  • Choice - contains a Value specifying the Artifact ID of the choice, which controls the layout behavior.
  • AllowLayoutChange - a Boolean value indicating whether the user can select another layout. The default value is false.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The object rule is linked to the applications in this array. If the array is empty, then the object rule isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.

{
    "objectRuleRequest":{
        "Name": "Sample rule for layout",
        "ObjectType": {
            "ArtifactID": 1042378
        },
        "Field": {
            "Value": {
                "ArtifactID": 1042566
            }
        },
        "Layout": {
            "Value": {
                "ArtifactID": 1042594
            }
        },
        "Choice": {
            "Value": {
                "ArtifactID": 1042569
            }
        },
        "AllowLayoutChange": false,
        "RelativityApplications": []
    }
}

• Behavior - indicates the type of object rule, such as sub-list visibility, or choice behavior. See Create an object rule or the ObjectRuleBehavior enumeration on the Relativity.Services.Interfaces.ObjectRules.Models namespace in the Services API.
• Field - contains the following fields:
  • Secured - indicates whether the current user has permission to view the settings in the Value field.
  • Value - contains the following fields:
    • Name - the user-friendly name of the field.
    • ArtifactID - the Artifact ID of the field.
    • Guids - an array of GUIDs used to identify the field.
• Layout - contains the following fields:
  • Secured - indicates whether the current user has permission to view the settings in the Value field.
  • Value - contains the following fields:
    • Name - the user-friendly name of the layout.
    • ArtifactID - the Artifact ID of the layout.
    • Guids - an array of GUIDs used to identify the layout.
• Choice - contains the following fields:
  • Secured - indicates whether the current user has permission to view the settings in the Value field.
  • Value - contains the following fields:
    • Name - the user-friendly name of the choice.
    • ArtifactID - the Artifact ID of the choice.
    • Guids - an array of GUIDs used to identify the choice.
• SubListObject - contains the following fields:
  • Secured - indicates whether the current user has permission to view the settings in the Value field.
  • Value - contains the following fields:
    • Name - the user-friendly name of the associated object.
    • ArtifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
    • ArtifactID - the Artifact ID of the associated object.
    • Guids - an array of GUIDs used to identify the associated object.
    • ListType - the type of associative objects that the list contains.
      View list of ListType values

      The ListType field contains one of the following values:

      • ChildObject - indicates that the list contains associated child objects.
      • MultipleObjectField - indicates that the list contains associated multiple object field types.
      • SingleObjectField - indicates that the list contains associated single object field types.

        For more information, see the ListType Enumeration in the Relativity.Services.Interfaces.ObjectRules.Models namespace.

• AllowAdd - a Boolean value indicating whether the user can mass copy choices.
• AllowDelete - a Boolean value indicating whether the user can mass delete choices.
• AllowRename - a Boolean value indicating whether the user can rename choices.
• ShowDelete - a Boolean value indicating whether the Delete button is available for global or sub-list button visibility. For example, it controls whether the button displays for mass operations or on the detail view of an object.
• ShowAddLink - a Boolean value indicating whether the Add link button is available for custom single object add link visibility. For example, it controls whether the Add link button can be used to add RDO instances to existing custom single objects from a layout.
• AllowLayoutChange - a Boolean value indicating whether the user can select another layout. The default value is false.
• ShowNew - a Boolean value indicating whether to display the New button on the associative object list. The default value is true.
• ShowLink - a Boolean value indicating whether to display the Link button on the associative object list. The default value is true.
• ShowUnlink - a Boolean value indicating whether to display the Unlink button on the associative object list. The default value is true.
• ShowMassCopy - a Boolean value indicating whether to display the Copy option for mass operations on an object. The mass action visibility rule controls this behavior.
• ShowMassEdit - a Boolean value indicating whether to display the Edit option for mass operations on an object. The mass action visibility rule controls this behavior.
• ShowMassReplace - a Boolean value indicating whether to display the Replace option for mass operations on an object. The mass action visibility rule controls this behavior.
• ShowMassTally - a Boolean value indicating whether to display the Tally/Sum/Average option for mass operations on an object. The mass action visibility rule controls this behavior.
• RelativityApplications - contains the following fields:
  • HasSecuredItems - a Boolean value indicating whether the application contains items that the current user doesn't have permission to access.
  • ViewableItems - an array of identifier objects for items that are accessible to the current user. For example, an object in this array would contain the name, Artifact IDs, and GUIDs for an application. See DisplayableObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.
• ObjectType - represents the object type that the rule is assigned to. It contains the following fields:
  • Name - the user-friendly name for the object type.
  • ArtifactTypeID - an identifier used to specify an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
  • ArtifactID - the Artifact ID of the object type.
  • Guids - an array of GUIDs used to identify the object type.
• Meta - provides additional information available as extended metadata. It includes the following fields:
  • Unsupported - an array of properties that indicate functionality not available on the current instance of this object rule.
  • ReadOnly - an array of object type properties that can't be modified, such as the type of rule.
• Actions - an array of Action objects indicating operations that you have permissions to perform on this object rule. For example, you may not have permissions to modify an object rule. Each Action object contains the following fields that are available as extended metadata:
  • Name - name of an operation available through REST for the object rule, such as delete, update, and so on.
  • Href - the URL used to make an HTTP request for the operation.
  • Verb - the name of the HTTP method for the operation.
  • IsAvailable - a Boolean value indicating whether you have permissions to perform the operation on this object rule.
  • Reason - an explanation for the unavailability of an action.
• LastModifiedOn - the date and time when the object rule was most recently modified.
• LastModifiedBy - contains the Artifact ID and name of the user who recently updated the object rule. It also contains an array of GUIDs used to identify the user.
• CreatedOn - the date and time when the object type was added to Relativity.
• CreatedBy - contains the Artifact ID and name of the user who created the object type. It also contains an array of GUIDs used to identify the user.
• Name - the user-friendly name for the object rule.
• ArtifactID - the Artifact ID of the object rule.
• Guids - an array of GUIDs used to identify the object rule.

{
    "Behavior": "SubListButtonVisibility",
    "Field": {
        "Secured": false,
        "Value": {
            "Name": "Custom Single Choice Field",
            "ArtifactID": 1042566,
            "Guids": []
        }
    },
    "Choice": {
        "Secured": false,
        "Value": {
            "Name": "Green",
            "ArtifactID": 1042568,
            "Guids": []
        }
    },
    "SubListObject": {
        "Secured": false,
        "Value": {
            "Name": "Associated object example",
            "ArtifactTypeID": 1000051,
            "ArtifactID": 1042586,
            "Guids": [],
            "ListType": "ChildObject"    
        }
    },
    "AllowAdd": false,
    "AllowDelete": false,
    "AllowRename": false,
    "ShowDelete": false,
    "ShowAddLink": false,
    "AllowLayoutChange": false,
    "ShowNew": true,
    "ShowLink": false,
    "ShowUnlink": false,
    "ShowMassCopy": false,
    "ShowMassEdit": false,
    "ShowMassReplace": false,
    "ShowMassTally": false,
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": []
    },
    "ObjectType": {
        "Name": "Custom Object Type",
        "ArtifactTypeID": 1000048,
        "ArtifactID": 1042378,
        "Guids": []
    },
    "Actions": [],
    "LastModifiedOn": "2019-02-22T19:22:49.927",
    "LastModifiedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "CreatedOn": "2019-02-22T17:40:24.7",
    "CreatedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "Name": "Updated object rule",
    "ArtifactID": 1042590,
    "Guids": []
}

{
    "Behavior": "SubListButtonVisibility",
    "Field": {
        "Secured": false,
        "Value": {
            "Name": "Custom Single Choice Field",
            "ArtifactID": 1042566,
            "Guids": []
        }
    },
    "Layout": {
        "Secured": false,
        "Value": {
            "Name": "Custom Layout",
            "ArtifactID": 1042594,
            "Guids": []
        }
    },
    "Choice": {
        "Secured": false,
        "Value": {
            "Name": "Custom Choice",
            "ArtifactID": 1042569,
            "Guids": []
        }
    },
    "SubListObject": {
        "Secured": false,
        "Value": {
            "Name": "Associated object example",
            "ArtifactTypeID": 1000051,
            "ArtifactID": 1042586,
            "Guids": [],
            "ListType": "ChildObject"    
        }
    },
    "AllowAdd": false,
    "AllowDelete": false,
    "AllowRename": false,
    "ShowDelete": false,
    "ShowAddLink": false,
    "AllowLayoutChange": false,
    "ShowNew": false,
    "ShowLink": false,
    "ShowUnlink": false,
    "ShowMassCopy": false,
    "ShowMassEdit": false,
    "ShowMassReplace": false,
    "ShowMassTally": false,
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": []
    },
    "ObjectType": {
        "Name": "Custom Object Type",
        "ArtifactTypeID": 1000048,
        "ArtifactID": 1042378,
        "Guids": []
    },
    "Meta": {
        "Unsupported": [],
        "ReadOnly": [
            "RuleType"
        ]
    },
    "Actions": [
        {
            "Name": "Delete",
            "Href": "Relativity.ObjectRules/workspace/2342954/objectrules/1042595",
            "Verb": "DELETE",
            "IsAvailable": true,
            "Reason": []
        },
        {
            "Name": "Update",
            "Href": "Relativity.ObjectRules/workspace/2342954/DefaultLayoutobjectrules/1042595",
            "Verb": "PUT",
            "IsAvailable": true,
            "Reason": []
        }
    ],
    "LastModifiedOn": "2019-02-22T17:55:04.253",
    "LastModifiedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "CreatedOn": "2019-02-22T17:55:04.253",
    "CreatedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "Name": "Sample rule for layout",
    "ArtifactID": 1042595,
    "Guids": []
}

• Choice behavior

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/choicebehaviorobjectrules/{{ObjectRuleId}}

• Custom Single Object Add Link Visibility

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/customsingleobjectaddlinkvisibilityobjectrules/{{ObjectRuleId}}

• Default Layout

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/defaultLayoutobjectrules/{{ObjectRuleId}}

• Default Layout on New

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/defaultlayoutonnewobjectrules/{{ObjectRuleId}}

• Global Button Visibility

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/globalbuttonvisibilityobjectrules

• Mass Action Visibility

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/massactionvisibilityobjectrules/{{ObjectRuleId}}

• New Button Override

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/newbuttonoverrideobjectrules/{{ObjectRuleId}}

• Sub-List Button Visibility

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/sublistbuttonvisibilityobjectrules/{{ObjectRuleId}}

• Override edit link URL

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/overrideeditlinkobjectrules/{{ObjectRuleId}}

• Override view link URL

  <host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/overrideviewlinkobjectrules/{{ObjectRuleId}}

To update a sub-list visibility rule, send a PUT request to a URL with the following format:

<host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/sublistbuttonvisibilityobjectrules/{{ObjectRuleId}}

The body of the request must contain the following fields unless specifically identified as optional:

• objectRuleRequest - request to create or update a rule. It contains the following fields:
  • Name - the user-friendly name of the rule.
  • ObjectType - contains the Artifact ID of the object type.
  • Field - contains a Value specifying the Artifact ID of the field, which affects the button visibility.
  • Choice - contains a Value specifying the Artifact ID of the choice, which affects the button visibility.
  • SubListObject - contains a Value specifying the Artifact ID of the associative object list controlled by the rule.
  • ShowNew - a Boolean value indicating whether to display the New button on the associative object list. The default value is true.
  • ShowLink - a Boolean value indicating whether to display the Link button on the associative object list. The default value is true.
  • ShowUnlink - a Boolean value indicating whether to display the Unlink button on the associative object list. The default value is true.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The object rule is linked to the applications in this array. If the array is empty, then the object rule isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.

• LastModifiedOn - the date and time when the object rule was most recently modified. This field is only required if you want to restrict the update of an object rule to the date that it was last modified. The value must match the LastModifiedOn date for the object rule stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.

{
    "objectRuleRequest":{
         "Name": "Updated object rule",
         "ObjectType": {
            "ArtifactID": 1042378
        },
        "Field": {
            "Value": {
                "ArtifactID": 1042566
            }
        },
        "Choice": {
            "Value": {
                "ArtifactID": 1042568
            }
        },
        "SubListObject": {
            "Value": {
                "ArtifactID": 1042586
            }
        },
        "ShowNew": true,
        "ShowLink": false,
        "ShowUnlink": false,
        "RelativityApplications": []
    },
        "LastModifiedOn": "2019-02-22T19:33:57.89"
}

To update a choice rule, send a PUT request to a URL with the following format:

<host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/choicebehaviorobjectrules/{{ObjectRuleId}}

The body of the request must contain the following fields unless specifically identified as optional:

• objectRuleRequest - request to create or update a rule. It contains the following fields:
  • Name - the user-friendly name of the rule.
  • ObjectType - contains the Artifact ID of the object type.
  • AllowAdd - a Boolean value indicating whether the user can mass copy choices.
  • AllowDelete - a Boolean value indicating whether the user can mass delete choices.
  • AllowRename - a Boolean value indicating whether the user can rename a choice.
  • Field - contains a Value specifying the Artifact ID of the field, which affects the choice behavior.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The object rule is linked to the applications in this array. If the array is empty, then the object rule isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.

• LastModifiedOn - the date and time when the object rule was most recently modified. This field is only required if you want to restrict the update of an object rule to the date that it was last modified. The value must match the LastModifiedOn date for the object rule stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.

{
    "objectRuleRequest":{
        "Name": "Update choice behavior",
        "ObjectType": {
            "ArtifactID": 1042378
        },
        "AllowAdd": true,
        "AllowDelete": false,
        "AllowRename": true,
        "Field": {
            "Value": {
                "ArtifactID": 1042565
            }
        },
        "RelativityApplications": []
      },
        "LastModifiedOn": "2019-02-22T19:33:57.89"
}

To update a layout rule, send a PUT request to a URL with the following format:

<host>/relativity.rest/api/relativity.objectrules/workspace/{{WorkspaceArtifactId}}/defaultLayoutobjectrules/{{ObjectRuleId}}

The body of the request must contain the following fields unless specifically identified as optional:

• objectRuleRequest - request to create or update a rule. It contains the following fields:
  • Name - the user-friendly name of the rule.
  • ObjectType - contains the Artifact ID of the object type.
  • Field - contains a Value specifying the Artifact ID of the field, which controls the layout behavior.
  • Layout - contains a Value specifying the Artifact ID of the layout.
  • Choice - contains a Value specifying the Artifact ID of the choice, which controls the layout behavior.
  • AllowLayoutChange - a Boolean value indicating whether the user can select another layout. The default value is false.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The object rule is linked to the applications in this array. If the array is empty, then the object rule isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.

• LastModifiedOn - the date and time when the object rule was most recently modified. This field is only required if you want to restrict the update of an object rule to the date that it was last modified. The value must match the LastModifiedOn date for the object rule stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.

{
    "objectRuleRequest":{
        "Name": "Updated rule for default layout",
        "ObjectType": {
            "ArtifactID":1042378
        },
        "Field": {
            "Value": {
                "ArtifactID": 1042566
            }
        },
        "Layout": {
            "Value": {
                "ArtifactID": 1042594
            }
        },
        "Choice": {
            "Value": {
                "ArtifactID": 1042569
            }
        },
        "AllowLayoutChange": false,
        "RelativityApplications": []
    },
        "LastModifiedOn": "2019-02-22T19:33:57.89"
}

Use the following endpoints to retrieve associated objects for a specific object type:

• Retrieve with Artifact ID - send a GET request to a URL with the following general format:

  <host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availableassociatedobjects/{{ObjectTypeArtifactId}}

• Retrieve with Artifact ID or name - send a POST request to a URL with the following general format:

  <host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availableassociatedobjects

  The body of the request contains the following fields:

  • ObjectTypeID - represents identification information for an object. It contains the following fields:
    • ArtifactID - the Artifact ID of the object type. If you specify a name, this field is optional.
    • Name - the user-friendly name of the associated object. If you specify an Artifact ID, this field is optional.

  {
      "ObjectTypeID" : {
         "ArtifactID": 1036417,
         "Name": "Analytics Example"
      }
  }

The response for both the GET and POST request contains the following fields:

• Name - the user-friendly name of the associated object.
• ArtifactTypeID - an identifier used to specify an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
• ArtifactID - the Artifact ID of the object type.
• Guids - an array of GUIDs used to identify the object type.
• ListType - the type of associative objects that the list contains. This field contains one of the following values:
  • ChildObject - indicates that the list contains associated child objects.
  • MultipleObjectField - indicates that the list contains associated multiple object field types.
  • SingleObjectField - indicates that the list contains associated single object field types.

  For more information, see the ListType Enumeration in the Relativity.Services.Interfaces.ObjectRules.Models namespace.

If no associated objects are available for the object type, this endpoint returns an empty array.

[
    {
        "Name": "Category Example",
        "ArtifactTypeID": 1000017,
        "ArtifactID": 1036424,
        "Guids": [
            "f611b0e4-6d92-4ff6-a247-46e87685bfc9"
        ],
        ListType: "ChildObject"    
    }
]

Use the following endpoints to retrieve single choice fields for a specific object type:

• Retrieve with Artifact ID - send a GET request to a URL with the following general format:

  <host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availablesinglechoicefields/{{ObjectTypeArtifactId}}

• Retrieve with Artifact ID or name - send a POST request to a URL with the following general format:

  <host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availablesinglechoicefields

  The body of the request contains the following fields:

  • ObjectTypeID - represents identification information for an object. It contains the following fields:
    • ArtifactID - the Artifact ID of the object type. If you specify a name, this field is optional.
    • Name - the user-friendly name of the associated object. If you specify an Artifact ID, this field is optional.

  {
      "ObjectTypeID" : {
         "ArtifactID": 1042378,
         "Name": "Custom Object Type"
      }
  }

The response for both the GET and POST request contains the following fields:

• Name - the user-friendly name of the associated object.
• ArtifactID - the Artifact ID of the object type.
• Guids - an array of GUIDs used to identify the object type.

If no associated single choice fields are available for the object type, this endpoint returns an empty array.

[
    {
        "Name": "Custom Single Choice Field",
        "ArtifactID": 1042566,
        "Guids": []
    },
    {
        "Name": "Single Choice Field",
        "ArtifactID": 1042564,
        "Guids": []
    }
]

Use the following endpoints to retrieve single and multiple choice fields for a specific object type:

• Retrieve with Artifact ID - send a GET request to a URL with the following general format:

  <host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availablechoicefields/{{ObjectTypeArtifactId}}

• Retrieve with Artifact ID or name - send a POST request to a URL with the following general format:

  <host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availablechoicefields/

  The body of the request contains the following fields:

  • ObjectTypeID - represents identification information for an object. It contains the following fields:
    • ArtifactID - the Artifact ID of the object type. If you specify a name, this field is optional.
    • Name - the user-friendly name of the associated object. If you specify an Artifact ID, this field is optional.

  {
      "ObjectTypeID" : {
         "ArtifactID": 1042378,       
         "Name": "Custom Object Type"
      }
  }

The response for both the GET and POST request contains the following fields:

• Name - the user-friendly name of the associated object.
• ArtifactID - the Artifact ID of the object type.
• Guids - an array of GUIDs used to identify the object type.

If no choice fields are available for the object type, this endpoint returns an empty array.

[
    {
        "Name": "Custom Single Choice Field",
        "ArtifactID": 1042566,
        "Guids": []
    },
    {
        "Name": "Multiple Choice Field",
        "ArtifactID": 1042565,
        "Guids": []
    },
    {
        "Name": "Single Choice Field",
        "ArtifactID": 1042564,
        "Guids": []
    }
]

To retrieve a list of choices for an object type, send a GET request to a URL with the following general format:

<host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availablechoices/{{FieldId}}

The response contains the following fields:

• Name - the user-friendly name of the associated object.
• ArtifactID - the Artifact ID of the object type.
• Guids - an array of GUIDs used to identify the object type.

If no choice are available for the object type, this endpoint returns an empty array.

[
    {
        "Name": "Blue",
        "ArtifactID": 1042569,
        "Guids": []
    },
    {
        "Name": "Green",
        "ArtifactID": 1042568,
        "Guids": []
    },
    {
        "Name": "Orange",
        "ArtifactID": 1042570,
        "Guids": []
    }
]

Use the following endpoints to retrieve layouts for a specific object type:

• Retrieve with Artifact ID - send a GET request to a URL with the following general format:

  <host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availablelayouts/{{ObjectTypeArtifactId}}

• Retrieve with Artifact ID or name - send a POST request to a URL with the following general format:

  <host>/Relativity.rest/api/relativity.objectRules/workspace/{{WorkspaceArtifactId}}/objectrules/availablelayouts

  The body of the request contains the following fields:

  • ObjectTypeID - represents identification information for an object. It contains the following fields:
    • ArtifactID - the Artifact ID of the object type. If you specify a name, this field is optional.
    • Name - the user-friendly name of the associated object. If you specify an Artifact ID, this field is optional.

  {
      "ObjectTypeID" : {
          "ArtifactID": 1042378,
          "Name" : "Custom Object Type"
      }
  }

The response for both the GET and POST request contains the following fields:

• Name - the user-friendly name of the associated object.
• ArtifactID - the Artifact ID of the object type.
• Guids - an array of GUIDs used to identify the object type.

If no layouts are available for the object type, this endpoint returns an empty array.

[
    {
        "Name": "Custom Object Type Layout",
        "ArtifactID": 1042377,
        "Guids": []
    }
]

To create a mass operations that displays a custom page for a user, send a POST request to the following URL:

<host>/Relativity.REST/api/Relativity.MassOperations/workspace/{{workspaceId}}/custompagemassoperations

The body of the request must contain the following fields unless specifically identified as optional:

• MassOperationRequest - represents a request to create a mass operation. It contains the following fields:
  • Name - the user-friendly name of the mass operation.
  • ObjectType - contains information about the object type to associate with this mass operation. It contains the following fields, but only the Artifact ID of the object type is required:
    • ArtifactID - the Artifact ID of the object type.
    • ArtifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
    • Guids - an array of GUIDs used to identify the object type. This array can be empty.
    • Name - the user-friendly name of the object type.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The mass operation is linked to the applications in this array. If the array is empty, then the mass operation isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.
  • Url - the URL for the custom page that you want displayed as a pop-up window for the mass operation.
  • PopupHeight - the height of the pop-up window displayed for this mass operation in pixels. This value must be greater than 0.
  • PopupWidth - the width of the pop-up window displayed for this mass operation in pixels. This value must be greater than 0.

{
   "MassOperationRequest":{
      "Name":"Custom page mass operation",
      "ObjectType":{
         "ArtifactID":1042378,
         "ArtifactTypeID":1000048,
         "Guids":[],
         "Name":"Custom Object Type"
      },
      "RelativityApplications": [
           {
               "ArtifactID":1042630,
               "Guids":[]
           }
       ],
      "Url":"https://www.mydomain.corp/MySite/Content/MyCustomPage.htm",
      "PopupHeight":500,
      "PopupWidth":500
   }
}

To create a mass operation that executes an event handler, send a POST request to the following URL:

<host>/Relativity.REST/api/Relativity.MassOperations/workspace/{{workspaceId}}/eventhandlermassoperations

The body of the request must contain the following fields unless specifically identified as optional:

• MassOperationRequest - represents a request to create a mass operation. It contains the following fields:
  • Name - the user-friendly name of the mass operation.
  • ObjectType - contains information about the object type to associate with this mass operation. It contains the following fields, but only the Artifact ID of the object type is required:
    • ArtifactID - the Artifact ID of the object type.
    • ArtifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
    • Guids - an array of GUIDs used to identify the object type. This array can be empty.
    • Name - the user-friendly name of the object type.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The mass operation is linked to the applications in this array. If the array is empty, then the mass operation isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.
  • EventHandlerID - an identifier assigned by Relativity to the event handler. This identifier isn't the Artifact ID for the event handler. The endpoint for retrieving available event handlers for a mass operation returns a field that contains this ID. See Retrieve a parent object types.
  • Layout - represents identification information for a layout. It contains the following field:
    • Value - contains the Artifact ID and GUIDs used to identify a specific layout for the mass operation. The array containing GUIDs can be empty.

{
    "MassOperationRequest": {
        "Name": "Event handler mass operation",
        "ObjectType": {
            "ArtifactID": 1042378,
            "ArtifactTypeID" : 1000048,
            "Guids": [],
            "Name": "Custom Object Type"
        },
        "RelativityApplications": [
           {
               "ArtifactID":1042630,
               "Guids":[]
           }
         ],
        "EventHandlerID": "3717",
        "Layout": {
            "Value": {
                "ArtifactID": 1042377,
                "Guids": []
            }
        }
    }
}

The response contains the following fields:

• Type - indicates whether the mass operation uses a custom page or event handler when it executes. See Create an object type or the MassOperationType enumeration on the Relativity.Services.Interfaces.MassOperation.Models namespace in the Services API.
• Name - the user-friendly name of the mass operation.
• ObjectType - represents identification information for the object type associated with the mass operation. It contains the following fields, but only the Artifact ID of the object type is required:
  • ArtifactID - the Artifact ID of the object type.
  • Guids - an array of GUIDs used to identify the object type.
• RelativityApplications - contains the following fields:
  • HasSecuredItems - a Boolean value indicating whether the application contains items that the current user doesn't have permission to access.
  • ViewableItems - an array of identifier objects for items that are accessible to the current user. For example, an object in this array would contain the name, Artifact IDs, and GUIDs for an application. See DisplayableObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.
• Url - the URL for the custom page that displays as a pop-up window for the mass operation.
• PopupHeight - the height of the pop-up window displayed for this mass operation in pixels.
• PopupWidth - the width of the pop-up window displayed for this mass operation in pixels.
• EventHandlerID - an identifier assigned by Relativity to the event handler. This identifier isn't the Artifact ID for the event handler. The endpoint for retrieving available event handlers for a mass operation return a field that contains this ID. See Retrieve a parent object types.
• ClassName - the name of the class that defines the event handler.
• ApplicationName - the name of the Relativity application containing the event handler.
• Layout - represents identification information for a layout. It contains the following field:
  • Secured - indicates whether the current user has permission to view the settings in the Value field.
  • Value - contains the Name, Artifact ID, and GUIDs used to identify a specific layout for the mass operation.
• CreatedOn - the date and time when the mass operation was added to Relativity.
• CreatedBy - contains the Artifact ID and name of the user who created the mass operation. It also contains an array of GUIDs used to identify the user.
• LastModifiedBy - contains the Artifact ID and name of the user who recently updated the mass operation. It also contains an array of GUIDs used to identify the user.
• LastModifiedOn - the date and time when the mass operation was most recently modified.

• Meta - provides additional information available as extended metadata. It includes the following fields:

  • Unsupported - an array of properties that indicate functionality not available on the current instance of this object type.
  • ReadOnly - an array of object type properties that can't be modified.
• Actions - an array of Action objects indicating operations that you have permissions to perform on this object type. For example, you may not have permissions to modify an mass operation that is part of a locked application. Each Action object contains the following fields that are available as extended metadata:
  • Name - name of an operation available through REST for the object type, such as delete, update, and so on.
  • Href - the URL used to make an HTTP request for the operation.
  • Verb - the name of the HTTP method for the operation.
  • IsAvailable - a Boolean value indicating whether you have permissions to perform the operation on this object type.
  • Reason - an explanation for the unavailability of an action.
• ArtifactID - the Artifact ID of the mass operation.
• Guids - an array of GUIDs used to identify the mass operation.

{
    "Type": "EventHandlerMassOperation",
    "Name": "Event handler mass operation",
    "ObjectType": {
        "ArtifactID": 1042378,
        "Guids": []
    },
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": [
            {
                "Name": "MySampleApplication",
                "ArtifactID": 1042630,
                "Guids": [
                    "555556e4-0f70-4b3a-85cc-bb8572b600f1"
                ]
            }
         ]
    },
    "PopupHeight": 0,
    "PopupWidth": 0,
    "EventHandlerID": 3717,
    "ClassName": "Test.Relativity.EventHandlers.MassOperations.GenerateExcelTextHandler",
    "ApplicationName": "TEST",
    "Layout": {
        "Secured": false,
        "Value": {
            "Name": "Custom Object Type Layout",
            "ArtifactID": 1042377,
            "Guids": []
        }
    },
    "CreatedOn": "2019-03-06T19:53:06.413",
    "CreatedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "LastModifiedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "LastModifiedOn": "2019-03-06T19:53:06.413",
    "Actions": [],
    "ArtifactID": 1042616,
    "Guids": []
}

{
    "Type": "CustomPageMassOperation",
    "Name": "Custom page mass operation",
    "ObjectType": {
        "ArtifactID": 1042378,
        "Guids": []
    },
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": [
            {
                "Name": "MySampleApplication",
                "ArtifactID": 1042630,
                "Guids": [
                    "555556e4-0f70-4b3a-85cc-bb8572b600f1"
                ]
            }
        ]
    },
    "Url": "https://www.mydomain.corp/MySite/Content/MyCustomPage.htm",
    "PopupHeight": 500,
    "PopupWidth": 500,
    "EventHandlerID": 0,
    "CreatedOn": "2019-03-06T18:56:10.047",
    "CreatedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "LastModifiedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "LastModifiedOn": "2019-03-06T18:56:10.047",
    "Meta": {
        "Unsupported": [],
        "ReadOnly": []
    },
    "Actions": [
        {
            "Name": "Delete",
            "Href": "Relativity.MassOperations/workspace/2342954/massoperations/1042615",
            "Verb": "DELETE",
            "IsAvailable": true,
            "Reason": []
        },
        {
            "Name": "Update",
            "Href": "Relativity.MassOperations/workspace/2342954/custompagemassoperations/1042615",
            "Verb": "PUT",
            "IsAvailable": true,
            "Reason": []
        }
    ],
    "ArtifactID": 1042615,
    "Guids": []
}

{
    "Type": "EventHandlerMassOperation",
    "Name": "Event handler mass operation",
    "ObjectType": {
        "ArtifactID": 1042378,
        "Guids": []
    },
    "RelativityApplications": {
        "HasSecuredItems": false,
        "ViewableItems": [
            {
                "Name": "MySampleApplication",
                "ArtifactID": 1042630,
                "Guids": [
                    "555556e4-0f70-4b3a-85cc-bb8572b600f1"
                ]
            }
        ]
    },
    "PopupHeight": 0,
    "PopupWidth": 0,
    "EventHandlerID": 3717,
    "ClassName": "Test.Relativity.EventHandlers.MassOperations.GenerateExcelTextHandler",
    "ApplicationName": "TEST",
    "Layout": {
        "Secured": false,
        "Value": {
            "Name": "Custom Object Type Layout",
            "ArtifactID": 1042377,
            "Guids": []
        }
    },
    "CreatedOn": "2019-03-06T19:53:06.413",
    "CreatedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "LastModifiedBy": {
        "Name": "Doe, Jane",
        "ArtifactID": 1023652,
        "Guids": []
    },
    "LastModifiedOn": "2019-03-06T19:53:06.413",
    "Meta": {
        "Unsupported": [],
        "ReadOnly": []
    },
    "Actions": [
        {
            "Name": "Delete",
            "Href": "Relativity.MassOperations/workspace/2342954/massoperations/1042616",
            "Verb": "DELETE",
            "IsAvailable": true,
            "Reason": []
        },
        {
            "Name": "Update",
            "Href": "Relativity.MassOperations/workspace/2342954/eventhandlermassoperations/1042616",
            "Verb": "PUT",
            "IsAvailable": true,
            "Reason": []
        }
    ],
    "ArtifactID": 1042616,
    "Guids": []
}

To update a custom page mass operation, send a PUT request to the following URL:

<host>/Relativity.REST/api/Relativity.MassOperations/workspace/{{workspaceId}}/custompagemassoperations/{{massOperationId}}

The body of the request must contain the following fields unless specifically identified as optional:

• MassOperationRequest - represents a request to update a mass operation. It contains the following fields:
  • Name - the user-friendly name of the mass operation.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The mass operation is linked to the applications in this array. If the array is empty, then the mass operation isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.
  • PopupHeight - the height of the pop-up window displayed for this mass operation in pixels. This value must be greater than 0.
  • PopupWidth - the width of the pop-up window displayed for this mass operation in pixels. This value must be greater than 0.
  • LastModifiedOn - the date and time when the object rule was most recently modified. This field is only required if you want to restrict the update of a mass operation to the date that it was last modified. The value must match the LastModifiedOn date for the mass operation stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.

{
    "MassOperationRequest": {
        "Name": "Updated custom page mass operation",
        "RelativityApplications": [
           {
               "ArtifactID":1042630,
               "Guids":[]
           }
         ],
        "Url": "https://www.mydomain.corp/MySite/Content/MyCustomPage.htm",
        "PopupHeight": 500,
        "PopupWidth": 500,
        "LastModifiedOn": "2019-03-11T19:00:53.317"
    }
}

To update an event handler mass operation, send a PUT request to the following URL:

<host>/Relativity.REST/api/Relativity.MassOperations/workspace/{{workspaceId}}/eventhandlermassoperations/{{massOperationId}}

The body of the request must contain the following fields unless specifically identified as optional:

• MassOperationRequest - represents a request to update a mass operation. It contains the following fields:
  • Name - the user- friendly name of the mass operation.
  • RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The mass operation is linked to the applications in this array. If the array is empty, then the mass operation isn't linked to any application. See ObjectIdentifier class in the Relativity.Services.Interfaces.Shared.Models namespace of the Services API.
  • EventHandlerID - an identifier assigned by Relativity to the event handler. This identifier isn't the artifact ID for the event handler. The endpoint for retrieving available event handlers for a mass operation return a field that contains this ID. See Retrieve a parent object types.
  • Layout - represents identification information for a layout. It contains the following field:
    • Value - contains the Artifact ID and GUIDs used to identify a specific layout for the mass operation.
  • LastModifiedOn - the date and time when the object rule was most recently modified. This field is only required if you want to restrict the update of a mass operation to the date that it was last modified. The value must match the LastModifiedOn date for the mass operation stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.

{
   "MassOperationRequest":{
      "Name":"Updated event handler mass operation",
      "RelativityApplications":[

      ],
      "EventHandlerID":"3717",
      "Layout":{
         "Value":{
            "ArtifactID":1042377,
            "Guids":[

            ]
         }
      },
      "LastModifiedOn":"2019-03-14T19:30:52.35"
   }
}

• Name - the user-friendly name of the object type.
• ArtifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
• ArtifactID - the Artifact ID of the object type.
• Guids - an array of GUIDs used to identify the object type.

[
   {
      "Name":"Document",
      "ArtifactTypeID":10,
      "ArtifactID":1035231,
      "Guids":[

      ]
   },
   {
      "Name":"Transform Set",
      "ArtifactTypeID":1000004,
      "ArtifactID":1035285,
      "Guids":[

      ]
   },
   {
      "Name":"Transform",
      "ArtifactTypeID":1000005,
      "ArtifactID":1035296,
      "Guids":[

      ]
   },
   {
      "Name":"Search Terms Report",
      "ArtifactTypeID":1000006,
      "ArtifactID":1035313,
      "Guids":[

      ]
   }
]

The response contains the following fields:

• Application - an application that contains the event handler. This field contains the following:
  • Name - the user-friendly name for the application.
  • ArtifactID - the Artifact ID of the application.
  • Guids - an array of GUIDs used to identify the application.

• EventHandlerID - the reference ID of the event handler assigned by Relativity.
• AssemblyName - the name of the .NET assembly containing the event handler code.
• ClassName - the name of the class that defines the event handler.
• CompanyName - the name of the company that implemented or provided the event handler.
• Description - general information about the event handler.

[
   {
      "Application":{
         "Name":"Custom Test Application",
         "ArtifactID":0,
         "Guids":[
            "5a4d89fc-7ec9-4a37-99ca-2a4d94ba4f02"
         ]
      },
      "EventHandlerID":3717,
      "AssemblyName":"Test.Package.dll",
      "ClassName":"Test.Relativity.EventHandlers.MassOperations.GenerateExcelTextHandler",
      "CompanyName":"TEST",
      "Description":""
   },
   {
      "Application":{
         "Name":"Case Dynamics",
         "ArtifactID":0,
         "Guids":[
            "5975ec2c-ef13-4358-a062-aff4891b2343"
         ]
      },
      "EventHandlerID":16685,
      "AssemblyName":"kCura.CaseDynamics.EventHandlers.dll",
      "ClassName":"kCura.CaseDynamics.EventHandlers.PrintingProfile.PrintingProfile_MassDelete",
      "CompanyName":"Relativity ODA LLC",
      "Description":"Printing Profile Mass Delete Custom"
   },
   {
      "Application":{
         "Name":"Document Utilities",
         "ArtifactID":0,
         "Guids":[
            "6894df96-b204-4157-9318-4073d8a7476d"
         ]
      },
      "EventHandlerID":16276,
      "AssemblyName":"MoveDocumentsToFolder_EH.dll",
      "ClassName":"MoveDocumentsToFolder_EH.MassOperation",
      "CompanyName":"Relativity ODA LLC",
      "Description":"Mass operation to move documents to a folder path specified in a text field."
   }
]

The body of the request contains the following fields:

• ObjectType - represents identification information for an object. It contains the following fields, but only the Artifact ID of the object type is required:
  • ArtifactID - the Artifact ID of the object type.
  • ArtifactTypeID - an integer value used as an identifier for an object type supported by Relativity. For example, the Artifact Type ID for a Document object is 10.
  • Guids - an array of GUIDs used to identify the object type. This array can be empty.
  • Name - the user-friendly name of the object type.

Note: You can specify a value for only one of these fields: Name, ArtifactID, or ArtifactTypeID. The other fields are then optional.

{
   "ObjectType":{
      "ArtifactID":1042378,
      "ArtifactTypeID":1000048,
      "Guids":[
      ],
      "Name":"Custom Object Type"
   }
}

The response contains the following fields:

• ObjectTypeName - the object type associated with the layout.
• Name - the user-friendly name of the layout.
• ArtifactID - the Artifact ID of the layout.
• Guids - an array of GUIDs used to identify the layout.

[
   {
      "ObjectTypeName":"Custom Object Type",
      "Name":"Custom Object Type Layout",
      "ArtifactID":1042377,
      "Guids":[

      ]
   },
   {
      "ObjectTypeName":"Custom Object Type",
      "Name":"Custom Layout",
      "ArtifactID":1042594,
      "Guids":[

      ]
   },
   {
      "ObjectTypeName":"Custom Object Type Two",
      "Name":"Custom Object Type Two Layout",
      "ArtifactID":1042579,
      "Guids":[

      ]
   },
   {
      "ObjectTypeName":"Custom Page",
      "Name":"Custom Page Layout",
      "ArtifactID":1036937,
      "Guids":[

      ]
   },
   {
      "ObjectTypeName":"Data Grid Audit",
      "Name":"Data Grid Audit Layout",
      "ArtifactID":1038060,
      "Guids":[

      ]
   },
   {
      "ObjectTypeName":"Data Grid Audit Field Mapping",
      "Name":"Data Grid Audit Field Mapping Layout",
      "ArtifactID":1038061,
      "Guids":[

      ]
   }
]