Object Rule Manager (.NET)

The Object Rule Manager API contains the following methods and classes.

Methods

The Object Rule Manager API exposes the following methods on the IObjectRuleManager interface in the Relativity.DataVisualization.{versionNumber}.ObjectRules namespace:

• Create method for each object rule type - adds a new object rule to the specified object type.

  Note: Each type of object rule has its own create method, and request class. For a complete list of create methods, see Create an object rule.

• DeleteAsync() method - removes an object rule from an object type in the specified workspace. Its parameters include the Artifact IDs of the workspace and the object rule. This method returns a Task. See Delete an object rule.
• GetAvailableAssociatedObjectsAsync() method - retrieves a list of associated objects that can be used with an object rule on a specific object type. See Retrieve choices, choice fields, layouts, or associated objects.
• GetAvailableChoiceFieldsAsync() method - retrieves a list of choice fields that can be associated with an object rule on a specific object type. See Retrieve choices, choice fields, layouts, or associated objects.
• GetAvailableChoicesAsync() method - retrieves a list of choices that can be associated with an object rule on a specific object type. See Retrieve choices, choice fields, layouts, or associated objects.
• GetAvailableLayoutsAsync() method - retrieves a list of layouts that can be associated with an object rule on a specific object type. See Retrieve choices, choice fields, layouts, or associated objects.
• GetAvailableSingleChoiceFieldsAsync() method - retrieves a list of single choices fields that can be associated with an object rule on a specific object type. See Retrieve choices, choice fields, layouts, or associated objects.
• MassDeleteAsync() method - removes multiple object rules across different object types. See Delete multiple object rules.
• ReadAsync() method - retrieves information about an object rule, including its name, the object type associated with the rule, and other properties.
• Update method for each object rule type - modifies the properties of an object rule, such as its name, associated object type, and others.

  Note: Each type of object rule has its own update method, and request class. For a complete list of update methods, see Update an object rule.

Classes

The Object Rule Manager API includes the following classes and enumeration available in the Relativity.DataVisualization.{versionNumber}.ObjectRules.Models namespace:

• Request class for each object rule type - represents the data used to create or update an object type. Each create and update method takes an object of this type.
• ObjectRuleResponse class - represents the results of a read operation. Its properties include name, the object type associated with the rule, and others.

• Choice behavior

  Task<int> CreateChoiceBehaviorAsync(int workspaceID, ChoiceBehaviorRuleRequest objectRuleRequest)
  

• Custom single object add link visibility

  Task<int> CreateCustomSingleObjectAddLinkVisibilityAsync(int workspaceID, CustomSingleObjectAddLinkVisibilityRuleRequest objectRuleRequest)
  

• Default layout

  Task<int> CreateDefaultLayoutAsync(int workspaceID, DefaultLayoutRuleRequest objectRuleRequest)
  

• Default layout on new

  Task<int> CreateDefaultLayoutOnNewAsync(int workspaceID, DefaultLayoutOnNewRuleRequest objectRuleRequest)
  

• Global button visibility

  Task<int> CreateGlobalButtonVisibilityAsync(int workspaceID, GlobalButtonVisibilityRuleRequest objectRuleRequest)
  

• Mass action visibility

  Task<int> CreateMassActionVisibilityAsync(int workspaceID, MassActionVisibilityRuleRequest objectRuleRequest)
  

• New button override

  Task<int> CreateNewButtonOverrideAsync(int workspaceID, NewButtonOverrideRuleRequest objectRuleRequest);

• Sub-list button visibility

  Task<int> CreateSubListButtonVisibilityAsync(int workspaceID, SubListButtonVisibilityRuleRequest objectRuleRequest)
  

• Override edit link URL

  Task<int> CreateOverrideEditLinkAsync(int workspaceID, OverrideEditLinkRuleRequest objectRuleRequest)
  

• Override view link URL

  Task<int> CreateOverrideViewLinkAsync(int workspaceID, OverrideViewLinkRuleRequest objectRuleRequest)
  

The following code sample illustrates how to instantiate a SubListButtonVisibilityRuleRequest object with properties specified for the new object rule. To create the rule, call the CreateSubListButtonVisibilityAsync() method by passing the Artifact ID of workspace where you want to add the rule, and the SubListButtonVisibilityRuleRequest instance.

public static async Task CreateSublistButtonVisibilityRule_Async(")"{
   int workspaceId = 1018486;
    int parentArtifactId = 101456834;
    int fieldId = 1035231;
    int choiceId = 1938203;
    int sublistObjectId = 1832739;
    int applicationId = 1035699;
                     
    SubListButtonVisibilityRuleRequest request = new SubListButtonVisibilityRuleRequest{
      "Name =""Test Object Rule Request",
      "ShowNew = false",
      "ShowDelete = false",
      "ShowLink = false",
      "ShowUnlink = true",
      "ObjectType = new DisplayableObjectTypeIdentifier"{
         "ArtifactID = parentArtifactId"
      },
      "Field = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = fieldId"
         }
      },
      "Choice = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = choiceId"
         }
      },
      "SubListObject = new Securable<DisplayableObjectTypeIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = sublistObjectId"
         }
      },
      "RelativityApplications = new List<ObjectIdentifier>"{
         "new ObjectIdentifier"{
            "ArtifactID = applicationId"
         }
      }
   };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>()){
      "try"{
         "int newRuleArtifactId = await objectRuleManager.CreateSubListButtonVisibilityAsync(workspaceId",
         "request);
            string info = string.Format(""Created object rule with Artifact ID {0}",
         "newRuleArtifactId);
            Console.Write(info);"
      }"catch (Exception ex)"{
         "Console.WriteLine(string.Format(""An error occurred: {0}",
         "ex.Message));"
      }
   }
}

The following code sample illustrates how to instantiate a ChoiceBehaviorRuleRequest object with properties specified for the new object rule. To create the rule, call the CreateChoiceBehaviorAsync() method by passing the Artifact ID of workspace where you want to add the rule, and the ChoiceBehaviorRuleRequest instance.

public static async Task CreateChoiceBehavior_Async(")"{
   int workspaceId = 1018486;
    int parentArtifactId = 1456834;
    int fieldId = 1035231;
    int applicationId = 1035699;
                     
    ChoiceBehaviorRuleRequest request = new ChoiceBehaviorRuleRequest{
      "Name =""Test Choice Behavior Rule",
      "ObjectType = new DisplayableObjectTypeIdentifier"{
         "ArtifactID = parentArtifactId"
      },
      "Field = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = fieldId"
         }
      },
      "ShowAdd = true",
      "ShowDelete = false",
      "ShowRename = false",
      "RelativityApplications = new List<Securable<ObjectIdentifier>>"{
         "new ObjectIdentifier"{
            "ArtifactID = applicationId"
         }
      }
   };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>()){
      "try"{
         "int newRuleArtifactId = await objectRuleManager.CreateChoiceBehaviorAsync(workspaceId",
         "request);
            string info = string.Format(""Created object rule with Artifact ID {0}",
         "newRuleArtifactId);
            Console.Write(info);"
      }"catch (Exception ex)"{
         "Console.WriteLine(string.Format(""An error occurred: {0}",
         "ex.Message));"
      }
   }
}

The following code sample illustrates how to instantiate a DefaultLayoutRuleRequest object with properties specified for the new object rule. To create the rule, call the CreateDefaultLayoutAsync() method by passing the Artifact ID of workspace where you want to add the rule, and the DefaultLayoutRuleRequest instance.

public static async Task CreateDefaultLayout_Async(")"{
   int workspaceId = 1018486;
    int parentArtifactId = 1456834;
    int fieldId = 1035231;
    int choiceId = 1938203;
    int layoutId = 1837293;
    int applicationId = 1035699;
                     
    DefaultLayoutRuleRequest request = new DefaultLayoutRuleRequest{
      "Name =""Test Object Rule Request",
      "ObjectType = new DisplayableObjectTypeIdentifier"{
         "ArtifactID = parentArtifactId"
      },
      "AllowLayoutChange = true",
      "Field = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = fieldId"
         }
      },
      "Choice = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = choiceId"
         }
      },
      "Layout = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = layoutId"
         }
      },
      "RelativityApplications = new List<ObjectIdentifier>"{
         "new ObjectIdentifier"{
            "ArtifactID = applicationId"
         }
      }
   };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>()){
      "try"{
         "int newRuleArtifactId = await objectRuleManager.CreateDefaultLayoutAsync(workspaceId",
         "request);
            string info = string.Format(""Created object rule with Artifact ID {0}",
         "newRuleArtifactId);
            Console.Write(info);"
      }"catch (Exception ex)"{
         "Console.WriteLine(string.Format(""An error occurred: {0}",
         "ex.Message));"
      }
   }
}

You can find general information about available object rules in Adding an object rule.

• Choice behavior

  Task UpdateChoiceBehaviorAsync(
      int workspaceID,
      int objectRuleID,
      ChoiceBehaviorRuleRequest objectRuleRequest
  )
  

  Task UpdateChoiceBehaviorAsync(
      int workspaceID,
      int objectRuleID,
      ChoiceBehaviorRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )
  

• Custom single object add link visibility

  Task UpdateCustomSingleObjectAddLinkVisibilityAsync(
      int workspaceID,
      int objectRuleID,
      CustomSingleObjectAddLinkVisibilityRuleRequest objectRuleRequest
  )
  

  Task UpdateCustomSingleObjectAddLinkVisibilityAsync(
      int workspaceID,
      int objectRuleID,
      CustomSingleObjectAddLinkVisibilityRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )

• Default layout

  Task UpdateDefaultLayoutAsync(
      int workspaceID,
      int objectRuleID,
      DefaultLayoutRuleRequest objectRuleRequest
  )
  

  Task UpdateDefaultLayoutAsync(
      int workspaceID,
      int objectRuleID,
      DefaultLayoutRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )

• Default layout on new

  Task UpdateDefaultLayoutOnNewAsync(
      int workspaceID,
      int objectRuleID,
      DefaultLayoutOnNewRuleRequest objectRuleRequest
  )
  

  Task UpdateDefaultLayoutOnNewAsync(
      int workspaceID,
      int objectRuleID,
      DefaultLayoutOnNewRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )

• Global button visibility

  Task UpdateGlobalButtonVisibilityAsync(
      int workspaceID,
      int objectRuleID,
      GlobalButtonVisibilityRuleRequest objectRuleRequest
  )
  

  Task UpdateGlobalButtonVisibilityAsync(
      int workspaceID,
      int objectRuleID,
      GlobalButtonVisibilityRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )
  

• Mass action visibility

  Task UpdateMassActionVisibilityAsync(
      int workspaceID,
      int objectRuleID,
      MassActionVisibilityRuleRequest objectRuleRequest
  )
  

  Task UpdateMassActionVisibilityAsync(
      int workspaceID,
      int objectRuleID,
      MassActionVisibilityRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )

• New button override

  Task UpdateNewButtonOverrideAsync(
      int workspaceID,
      int objectRuleID,
      NewButtonOverrideRuleRequest objectRuleRequest
  )
  

  Task UpdateNewButtonOverrideAsync(
      int workspaceID,
      int objectRuleID,
      NewButtonOverrideRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )

• Sub-list button visibility

  Task UpdateSubListButtonVisibilityAsync(
      int workspaceID,
      int objectRuleID,
      SubListButtonVisibilityRuleRequest objectRuleRequest
  )
  

  Task UpdateSubListButtonVisibilityAsync(
      int workspaceID,
      int objectRuleID,
      SubListButtonVisibilityRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )

• Override edit link URL

  Task UpdateOverrideEditLinkAsync(
      int workspaceID,
      int objectRuleID,
      OverrideEditLinkRuleRequest objectRuleRequest
  )
  

  Task UpdateOverrideEditLinkAsync(
      int workspaceID,
      int objectRuleID,
      OverrideEditLinkRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )

• Override view link URL

  Task UpdateOverrideViewLinkAsync(
      int workspaceID,
      int objectRuleID,
      OverrideViewLinkRuleRequest objectRuleRequest
  )
  

  Task UpdateOverrideViewLinkAsync(
      int workspaceID,
      int objectRuleID,
      OverrideViewLinkRuleRequest objectRuleRequest,
      DateTime lastModifiedOn
  )

The following code sample illustrates how to instantiate a SubListButtonVisibilityRuleRequest object with properties used for updating the object rule. To update the rule, call the UpdateSubListButtonVisibilityAsync() method by passing Artifact IDs of the workspace and object rule, and the SubListButtonVisibilityRuleRequest instance.

public static async Task UpdateSubListButtonVisibility_Async(")"{
   int workspaceId = 1018486;
    int parentArtifactId = 1456834;
    int fieldId = 1035231;
    int choiceId = 1938203;
    int layoutId = 1837293;
    int applicationId = 1035699;
    int objectRuleId = 1383730;
                 
    SubListButtonVisibilityRuleRequest request = new SubListButtonVisibilityRuleRequest{
      "Name =""Test Object Rule Request",
      "ObjectType = new DisplayableObjectTypeIdentifier"{
         "ArtifactID = parentArtifactId"
      },
      "AllowLayoutChange = true",
      "Field = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = fieldId"
         }
      },
      "Choice = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = choiceId"
         }
      },
      "Layout = new Securable<ObjectIdentifier>"{
         "Secured = false",
         "Value = new DisplayableObjectTypeIdentifier"{
            "ArtifactID = layoutId"
         }
      },
      "RelativityApplications = new List<ObjectIdentifier>"{
         "new ObjectIdentifier"{
            "ArtifactID = applicationId"
         }
      }
   };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>()){
      "try"{
         "await objectRuleManager.UpdateSubListButtonVisibilityAsync(workspaceId",
         "objectRuleId",
         "request);"
      }"catch (Exception ex)"{
         "Console.WriteLine(string.Format(""An error occurred: {0}",
         "ex.Message));"
      }
   }
}

The following code sample illustrates how to instantiate a ChoiceBehaviorRuleRequest object with properties used for updating the object rule. To update the rule, call the UpdateChoiceBehaviorAsync() method by passing Artifact IDs of the workspace and object rule, and the ChoiceBehaviorRuleRequest instance.

public static async Task UpdateChoiceBehavior_Async()
{
    int workspaceId = 1018486;
    int parentArtifactId = 1456834;
    int fieldId = 1035231;
    int applicationId = 1035699;                    
    int objectRuleId = 1383730;
 
    ChoiceBehaviorRuleRequest request = new ChoiceBehaviorRuleRequest
    {
        Name = "Test Choice Behavior Rule Update",
        ObjectType = new DisplayableObjectTypeIdentifier { ArtifactID = parentArtifactId },
        Field = new Securable<ObjectIdentifier> {
            Secured = false,
            Value = new DisplayableObjectTypeIdentifier { ArtifactID = fieldId }
        },
        ShowAdd = false,
        ShowDelete = true,
        ShowRename = true,
        RelativityApplications = new List<Securable<ObjectIdentifier>>
        {
            new ObjectIdentifier {ArtifactID = applicationId}
        }
    };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            await objectRuleManager.UpdateChoiceBehaviorAsync(workspaceId, objectRuleId, request);
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

The following code sample illustrates how to instantiate a DefaultLayoutRuleRequest object with properties used for updating the object rule. To update the rule, call the UpdateDefaultLayoutAsync method by passing Artifact IDs of the workspace and object rule, and the DefaultLayoutRuleRequest instance.

public static async Task UpdateLayoutBehavior_Async()
{
    int workspaceId = 1018486;
    int parentArtifactId = 1456834;
    int fieldId = 1035231;
    int choiceId = 1938203;
    int layoutId = 1837293;
    int applicationId = 1035699;
    int objectRuleId = 1383730;
                     
    DefaultLayoutRuleRequest request = new DefaultLayoutRuleRequest
    {
        Name = "Test Object Rule Request",
        ObjectType = new DisplayableObjectTypeIdentifier { ArtifactID = parentArtifactId },
        AllowLayoutChange = true,
        Field = new Securable<ObjectIdentifier>
        {
            Secured = false,
            Value = new DisplayableObjectTypeIdentifier { ArtifactID = fieldId }
        },
        Choice = new Securable<ObjectIdentifier>
        {
            Secured = false,
            Value = new DisplayableObjectTypeIdentifier { ArtifactID = choiceId }
        },
        Layout = new Securable<ObjectIdentifier>
        {
            Secured = false,
            Value = new DisplayableObjectTypeIdentifier { ArtifactID = layoutId }
        },
        RelativityApplications = new List<ObjectIdentifier>
        {
            new ObjectIdentifier { ArtifactID = applicationId }
        }               
    };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            await objectRuleManager.UpdateDefaultLayoutAsync(workspaceId, objectRuleId, request);
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

Retrieve with Artifact ID

If you have the Artifact ID of the object type, use the following method to retrieve associated objects for it:

Task<List<SubListObjectIdentifier>> GetAvailableAssociatedObjectsAsync(int workspaceID, int objectTypeID)

The following code sample illustrates how to use this method:

public static async Task GetAvailableAssociatedObjects_Async()
{
    int workspaceId = 1018486;
    int objectTypeId = 1039509;
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            List<SubListObjectIdentifier> response = await objectRuleManager.GetAvailableAssociatedObjectsAsync(workspaceId, objectTypeId);
            foreach (SubListObjectIdentifier subListIdentifier in response)
            {
                string info = string.Format("Read {0} '{1}' with Artifact ID '{2}'",
                    subListIdentifier.ListType, subListIdentifier.Name, subListIdentifier.ArtifactID);
                Console.Write(info);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

Retrieve with Artifact ID or name

If you have the name, GUID, artifact ID, or artifact type ID of the object type, use the following method to retrieve choice fields for it:

Task<List<SubListObjectIdentifier>> GetAvailableAssociatedObjectsAsync(int workspaceID, DisplayableObjectTypeIdentifier objectTypeID)

The following code sample illustrates how to use this method:

public static async Task GetAvailableAssociatedObjects_Async()
{
    int workspaceId = 1018486;
    int objectTypeArtifactId = 1039509;
 
    DisplayableObjectTypeIdentifier DisplayableObjectTypeIdentifier = new DisplayableObjectTypeIdentifier { ArtifactID = objectTypeArtifactId };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            List<SubListObjectIdentifier> response = await objectRuleManager.GetAvailableAssociatedObjectsAsync(workspaceId, DisplayableObjectTypeIdentifier);
            foreach (SubListObjectIdentifier subListIdentifier in response)
            {
                string info = string.Format("Read {0} '{1}' with Artifact ID '{2}'",
                    subListIdentifier.ListType, subListIdentifier.Name, subListIdentifier.ArtifactID);
                Console.Write(info);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

Retrieve with Artifact ID

If you have the Artifact ID of the object type, use the following method to retrieve single choice fields for it:

Task<List<DisplayableObjectIdentifier>> GetAvailableSingleChoiceFieldsAsync(int workspaceID, int objectTypeID)

The following code sample illustrates how to use this method:

public static async Task GetAvailableSingleChoiceFields_Async(")"{
   int workspaceId = 1018486;
    int objectTypeId = 1039509;
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>()){
      "try"{
         "List<DisplayableObjectIdentifier> response = await objectRuleManager.GetAvailableSingleChoiceFieldsAsync(workspaceId",
         "objectTypeId);
            foreach (DisplayableObjectIdentifier singleChoiceField in response)"{
            "string info = string.Format(""Read single choice field {0} with Artifact ID {1}",
            "singleChoiceField.Name",
            "singleChoiceField.ArtifactID);
                Console.Write(info);"
         }
      }"catch (Exception ex)"{
         "Console.WriteLine(string.Format(""An error occurred: {0}",
         "ex.Message));"
      }
   }

Retrieve with Artifact ID or name

If you have the name, GUID, artifact ID, or artifact type ID of the object type, use the following method to retrieve single choice field methods for it:

CopyTask<List<DisplayableObjectIdentifier>> GetAvailableSingleChoiceFieldsAsync(int workspaceID, DisplayableObjectTypeIdentifier objectTypeID)

The following code sample illustrates how to use this method:

{
    int workspaceId = 1018486;
    int objectTypeArtifactId = 1039509;
     
    DisplayableObjectTypeIdentifier objectTypeId = new DisplayableObjectTypeIdentifier { ArtifactID = objectTypeArtifactId };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            List<DisplayableObjectIdentifier> response = await objectRuleManager.GetAvailableSingleChoiceFieldsAsync(workspaceId, objectTypeId);
            foreach (DisplayableObjectIdentifier singleChoiceField in response)
            {
                string info = string.Format("Read single choice field {0} with Artifact ID {1}", singleChoiceField.Name, singleChoiceField.ArtifactID);
                Console.Write(info);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

Retrieve with Artifact ID

If you have the Artifact ID of the object type, use the following method to retrieve choice fields for it:

Task<List<DisplayableObjectIdentifier>> GetAvailableChoiceFieldsAsync(int workspaceID, int objectTypeID)

The following code sample illustrates how to use this method:

public static async Task GetAvailableChoiceFields_Async()
{
    int workspaceId = 1018486;
    int objectTypeId = 1039509;
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            List<DisplayableObjectIdentifier> response = await objectRuleManager.GetAvailableChoiceFieldsAsync(workspaceId, objectTypeId);
            foreach (DisplayableObjectIdentifier choiceField in response)
            {
                string info = string.Format("Read choice field {0} with Artifact ID {1}", choiceField.Name, choiceField.ArtifactID);
                Console.Write(info);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

Retrieve with Artifact ID or name

If you have the name, GUID, artifact ID, or artifact type ID of the object type, use the following method to retrieve choice fields for it:

Task<List<DisplayableObjectIdentifier>> GetAvailableChoiceFieldsAsync(int workspaceID, DisplayableObjectTypeIdentifier objectTypeID)

The following code sample illustrates how to use this method:

public static async Task GetAvailableChoiceFields_Async()
{
    int workspaceId = 1018486;
    int objectTypeArtifactId = 1039509;
     
    DisplayableObjectTypeIdentifier objectTypeId = new DisplayableObjectTypeIdentifier { ArtifactID = objectTypeArtifactId };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            List<DisplayableObjectIdentifier> response = await objectRuleManager.GetAvailableChoiceFieldsAsync(workspaceId, objectTypeId);
            foreach (DisplayableObjectIdentifier choiceField in response)
            {
                string info = string.Format("Read choice field {0} with Artifact ID {1}", choiceField.Name, choiceField.ArtifactID);
                Console.Write(info);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

To retrieve a list of choices for an object type, use the following method:

Task<List<DisplayableObjectIdentifier>> GetAvailableChoicesAsync(int workspaceID, int fieldID)

The following code sample illustrates how to use this method:

public static async Task GetAvailableChoices_Async()
{
    int workspaceId = 1018486;
    int fieldId = 1039509;
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            List<DisplayableObjectIdentifier> response = await objectRuleManager.GetAvailableChoicesAsync(workspaceId, fieldId);
            foreach (DisplayableObjectIdentifier choice in response)
            {
                string info = string.Format("Read choice {0} with Artifact ID {1}", choice.Name, choice.ArtifactID);
                Console.Write(info);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

Retrieve with Artifact ID

If you have the Artifact ID of the object type, use the following method to retrieve layouts for it:

Task<List<DisplayableObjectIdentifier>> GetAvailableLayoutsAsync(int workspaceID, int objectTypeID)

The following code sample illustrates how to use this method:

public static async Task GetAvailableLayouts_Async()
{
    int workspaceId = 1018486;
    int objectTypeId = 1039509;
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            List<DisplayableObjectIdentifier> response = await objectRuleManager.GetAvailableLayoutsAsync(workspaceId, objectTypeId);
            foreach (DisplayableObjectIdentifier layout in response)
            {
                string info = string.Format("Read layout {0} with Artifact ID {1}", layout.Name, layout.ArtifactID);
                Console.Write(info);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}

Retrieve with Artifact ID or name

If you have the name, GUID, artifact ID, or artifact type ID of the object type, use the following method to retrieve layouts for it:

Task<List<DisplayableObjectIdentifier>> GetAvailableLayoutsAsync(int workspaceID, DisplayableObjectTypeIdentifier objectTypeID)

The following code sample illustrates how to use this method:

public static async Task GetAvailableLayouts_Async()
{
    int workspaceId = 1018486;
    int objectTypeArtifactId = 1039509;
     
    DisplayableObjectTypeIdentifier objectTypeId = new DisplayableObjectTypeIdentifier { ArtifactID = objectTypeArtifactId };
 
    using (Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager objectRuleManager = serviceFactory.CreateProxy<Relativity.DataVisualization.{versionNumber}.ObjectRules.IObjectRuleManager>())
    {
        try
        {
            List<DisplayableObjectIdentifier> response = await objectRuleManager.GetAvailableLayoutsAsync(workspaceId, objectTypeId);
            foreach (DisplayableObjectIdentifier layout in response)
            {
                string info = string.Format("Read layout {0} with Artifact ID {1}", layout.Name, layout.ArtifactID);
                Console.Write(info);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(string.Format("An error occurred: {0}", ex.Message));
        }
    }
}