relativity-workspaces

Server path: /relativity-workspaces | Type: Application | PCID required: Yes

Tools

Tool	Description
`relativity_workspaces_create_instance_setting`	[Public] IInstanceSettingManager -
`relativity_workspaces_create_matter`	[Public] IMatterManager -
`relativity_workspaces_create_workspace`	[Public] IWorkspaceManager -
`relativity_workspaces_create_workspace_job`	Start workspace creation
`relativity_workspaces_delete_instance_setting`	[Public] IInstanceSettingManager -
`relativity_workspaces_delete_matter`	[Public] IMatterManager -
`relativity_workspaces_delete_workspace`	[Public] IWorkspaceManager -
`relativity_workspaces_delete_workspace_details`	Delete workspace
`relativity_workspaces_get_instance_setting`	[Public] IInstanceSettingManager -
`relativity_workspaces_get_matter`	[Public] IMatterManager -
`relativity_workspaces_get_workspace`	[Public] IWorkspaceManager -
`relativity_workspaces_get_workspace_details`	Read workspace
`relativity_workspaces_get_workspace_job`	Get workspace creation job progress
`relativity_workspaces_get_workspace_metadata_fields`	[Public] IWorkspaceManager -
`relativity_workspaces_get_workspace_summary`	[Public] IWorkspaceManager -
`relativity_workspaces_list_eligible_matter_statuses`	[Public] IMatterManager -
`relativity_workspaces_list_eligible_resource_pools`	[Public] IWorkspaceManager -
`relativity_workspaces_list_eligible_workspace_statuses`	[Public] IWorkspaceManager -
`relativity_workspaces_query_eligible_clients`	[Public] IWorkspaceManager -
`relativity_workspaces_query_eligible_matters`	[Public] IWorkspaceManager -
`relativity_workspaces_query_eligible_saved_searches`	[Public] IWorkspaceManager -
`relativity_workspaces_query_eligible_templates`	[Public] IWorkspaceManager -
`relativity_workspaces_query_workspaces_by_group`	[Public] IWorkspaceManager -
`relativity_workspaces_update_matter`	[Public] IMatterManager -
`relativity_workspaces_update_workspace`	[Public] IWorkspaceManager -
`relativity_workspaces_update_workspace_details`	Update workspace

relativity_workspaces_create_instance_setting

[Public] IInstanceSettingManager - Parameters:

Parameter	Type	Required	Default	Description
`ArtifactID`	integer	No	—	Artifact ID
`Description`	string	No	—	The description value
`Encrypted`	boolean	null	No	—	The encrypted value
`InitialValue`	string	No	—	Initial Value
`Keywords`	string	No	—	The keywords value
`Machine`	string	No	—	The machine value
`Name`	string	No	—	The name value
`Notes`	string	No	—	The notes value
`Section`	string	No	—	The section value
`Value`	string	No	—	The value value
`ValueType`	string	null	No	—	Value Type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ArtifactID": {
      "type": "integer",
      "description": "Artifact ID"
    },
    "Description": {
      "type": "string",
      "description": "The description value"
    },
    "Encrypted": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "The encrypted value"
    },
    "InitialValue": {
      "type": "string",
      "description": "Initial Value"
    },
    "Keywords": {
      "type": "string",
      "description": "The keywords value"
    },
    "Machine": {
      "type": "string",
      "description": "The machine value"
    },
    "Name": {
      "type": "string",
      "description": "The name value"
    },
    "Notes": {
      "type": "string",
      "description": "The notes value"
    },
    "Section": {
      "type": "string",
      "description": "The section value"
    },
    "Value": {
      "type": "string",
      "description": "The value value"
    },
    "ValueType": {
      "type": [
        "string",
        "null"
      ],
      "description": "Value Type",
      "enum": [
        "Text",
        "Integer32",
        "Integer64",
        "NonNegativeInteger32",
        "NonNegativeInteger64",
        "PositiveInteger32",
        "PositiveInteger64",
        "TrueFalse"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

relativity_workspaces_create_matter

[Public] IMatterManager - Parameters:

Parameter	Type	Required	Default	Description
`Client`	object	No	—	The client value
`Keywords`	string	No	—	The keywords value
`Name`	string	No	—	The name value
`Notes`	string	No	—	The notes value
`Number`	string	No	—	The number value
`Status`	object	No	—	The status value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "Client": {
      "type": "object",
      "description": "The client value",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "Keywords": {
      "type": "string",
      "description": "The keywords value"
    },
    "Name": {
      "type": "string",
      "description": "The name value"
    },
    "Notes": {
      "type": "string",
      "description": "The notes value"
    },
    "Number": {
      "type": "string",
      "description": "The number value"
    },
    "Status": {
      "type": "object",
      "description": "The status value",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

relativity_workspaces_create_workspace

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`AzureCredentials`	object	No	—	Azure Credentials
`AzureFileSystemCredentials`	object	No	—	Azure File System Credentials
`DataGridFileRepository`	object	No	—	Data Grid File Repository
`DefaultCacheLocation`	object	No	—	Default Cache Location
`DefaultFileRepository`	object	No	—	Default File Repository
`DownloadHandlerUrl`	string	No	—	Download Handler Url
`EnableDataGrid`	boolean	No	—	Enable Data Grid
`Keywords`	string	No	—	The keywords value
`Matter`	object	No	—	The matter value
`Name`	string	No	—	The name value
`Notes`	string	No	—	The notes value
`ProductionRestrictions`	object	No	—	Production Restrictions
`ResourcePool`	object	No	—	Resource Pool
`SqlFullTextLanguage`	integer	No	—	Sql Full Text Language
`SqlServer`	object	No	—	Sql Server
`Status`	object	No	—	The status value
`Template`	object	No	—	The template value
`WorkspaceAdminGroup`	object	No	—	Workspace Admin Group

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "AzureCredentials": {
      "type": "object",
      "description": "Azure Credentials",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "AzureFileSystemCredentials": {
      "type": "object",
      "description": "Azure File System Credentials",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "DataGridFileRepository": {
      "type": "object",
      "description": "Data Grid File Repository",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "DefaultCacheLocation": {
      "type": "object",
      "description": "Default Cache Location",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "DefaultFileRepository": {
      "type": "object",
      "description": "Default File Repository",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "DownloadHandlerUrl": {
      "type": "string",
      "description": "Download Handler Url"
    },
    "EnableDataGrid": {
      "type": "boolean",
      "description": "Enable Data Grid"
    },
    "Keywords": {
      "type": "string",
      "description": "The keywords value"
    },
    "Matter": {
      "type": "object",
      "description": "The matter value",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "Name": {
      "type": "string",
      "description": "The name value"
    },
    "Notes": {
      "type": "string",
      "description": "The notes value"
    },
    "ProductionRestrictions": {
      "type": "object",
      "description": "Production Restrictions",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "ResourcePool": {
      "type": "object",
      "description": "Resource Pool",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "SqlFullTextLanguage": {
      "type": "integer",
      "description": "Sql Full Text Language"
    },
    "SqlServer": {
      "type": "object",
      "description": "Sql Server",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "Status": {
      "type": "object",
      "description": "The status value",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "Guids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The guids value"
        }
      }
    },
    "Template": {
      "type": "object",
      "description": "The template value",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "WorkspaceAdminGroup": {
      "type": "object",
      "description": "Workspace Admin Group",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    }
  },
  "required": [
    "PCID"
  ]
}

relativity_workspaces_create_workspace_job

Start workspace creation Parameters:

Parameter	Type	Required	Default	Description
`DownloadHandlerUrl`	string	null	No	—	Download Handler Url
`Keywords`	string	null	No	—	The keywords value
`MatterArtifactId`	integer	No	—	Matter Artifact Id
`Name`	string	Yes	—	The name value
`Notes`	string	null	No	—	The notes value
`SqlFullTextLanguage`	integer	No	—	Sql Full Text Language
`StatusArtifactId`	integer	No	—	Status Artifact Id
`TemplateArtifactId`	integer	No	—	Template Artifact Id
`UseCase`	string	Yes	—	Use Case
`WorkspaceAdminGroupArtifactId`	integer	null	No	—	Workspace Admin Group Artifact Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "DownloadHandlerUrl": {
      "type": [
        "string",
        "null"
      ],
      "description": "Download Handler Url"
    },
    "Keywords": {
      "type": [
        "string",
        "null"
      ],
      "description": "The keywords value"
    },
    "MatterArtifactId": {
      "type": "integer",
      "description": "Matter Artifact Id"
    },
    "Name": {
      "type": "string",
      "description": "The name value"
    },
    "Notes": {
      "type": [
        "string",
        "null"
      ],
      "description": "The notes value"
    },
    "SqlFullTextLanguage": {
      "type": "integer",
      "description": "Sql Full Text Language"
    },
    "StatusArtifactId": {
      "type": "integer",
      "description": "Status Artifact Id"
    },
    "TemplateArtifactId": {
      "type": "integer",
      "description": "Template Artifact Id"
    },
    "UseCase": {
      "type": "string",
      "description": "Use Case"
    },
    "WorkspaceAdminGroupArtifactId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Workspace Admin Group Artifact Id"
    }
  },
  "required": [
    "PCID",
    "Name",
    "UseCase"
  ]
}

relativity_workspaces_delete_instance_setting

[Public] IInstanceSettingManager - Parameters:

Parameter	Type	Required	Default	Description
`instanceSettingID`	integer	Yes	—	Instance Setting ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "instanceSettingID": {
      "type": "integer",
      "description": "Instance Setting ID"
    }
  },
  "required": [
    "PCID",
    "instanceSettingID"
  ]
}

relativity_workspaces_delete_matter

[Public] IMatterManager - Parameters:

Parameter	Type	Required	Default	Description
`matterID`	integer	Yes	—	Matter ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "matterID": {
      "type": "integer",
      "description": "Matter ID"
    }
  },
  "required": [
    "PCID",
    "matterID"
  ]
}

relativity_workspaces_delete_workspace

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`workspaceID`	integer	Yes	—	Workspace ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    }
  },
  "required": [
    "PCID",
    "workspaceID"
  ]
}

relativity_workspaces_delete_workspace_details

Delete workspace Parameters:

Parameter	Type	Required	Default	Description
`workspaceId`	integer	Yes	—	Workspace Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceId": {
      "type": "integer",
      "description": "Workspace Id"
    }
  },
  "required": [
    "PCID",
    "workspaceId"
  ]
}

relativity_workspaces_get_instance_setting

[Public] IInstanceSettingManager - Parameters:

Parameter	Type	Required	Default	Description
`instanceSettingID`	integer	Yes	—	Instance Setting ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "instanceSettingID": {
      "type": "integer",
      "description": "Instance Setting ID"
    }
  },
  "required": [
    "PCID",
    "instanceSettingID"
  ]
}

relativity_workspaces_get_matter

[Public] IMatterManager - Parameters:

Parameter	Type	Required	Default	Description
`matterID`	integer	Yes	—	Matter ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "matterID": {
      "type": "integer",
      "description": "Matter ID"
    }
  },
  "required": [
    "PCID",
    "matterID"
  ]
}

relativity_workspaces_get_workspace

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`workspaceID`	integer	Yes	—	Workspace ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    }
  },
  "required": [
    "PCID",
    "workspaceID"
  ]
}

relativity_workspaces_get_workspace_details

Read workspace Parameters:

Parameter	Type	Required	Default	Description
`workspaceId`	integer	Yes	—	Workspace Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceId": {
      "type": "integer",
      "description": "Workspace Id"
    }
  },
  "required": [
    "PCID",
    "workspaceId"
  ]
}

relativity_workspaces_get_workspace_job

Get workspace creation job progress Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	Job Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "Job Id"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

relativity_workspaces_get_workspace_metadata_fields

[Public] IWorkspaceManager -

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

relativity_workspaces_get_workspace_summary

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`workspaceID`	integer	Yes	—	Workspace ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    }
  },
  "required": [
    "PCID",
    "workspaceID"
  ]
}

relativity_workspaces_list_eligible_matter_statuses

[Public] IMatterManager -

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

relativity_workspaces_list_eligible_resource_pools

[Public] IWorkspaceManager -

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

relativity_workspaces_list_eligible_workspace_statuses

[Public] IWorkspaceManager -

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

relativity_workspaces_query_eligible_clients

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`start`	integer	Yes	—	The start value
`length`	integer	Yes	—	The length value
`ActiveArtifactID`	integer	null	No	—	Active Artifact ID
`Condition`	string	No	—	The condition value
`ConvertNumberFieldValuesToString`	boolean	null	No	—	Convert Number Field Values To String
`ExecutingSavedSearchID`	integer	null	No	—	Executing Saved Search ID
`ExecutingViewID`	integer	null	No	—	Executing View ID
`Fields`	object[]	No	—	The fields value
`IncludeIDWindow`	boolean	null	No	—	Include ID Window
`IncludeNameInQueryResult`	boolean	null	No	—	Include Name In Query Result
`IsAdhocQuery`	boolean	null	No	—	Is Adhoc Query
`LongTextBehavior`	string	No	—	Long Text Behavior
`MaxCharactersForLongTextValues`	integer	null	No	—	Max Characters For Long Text Values
`ObjectType`	object	No	—	Object Type
`QueryHint`	string	No	—	Query Hint
`RankSortOrder`	string	null	No	—	Rank Sort Order
`RelationalField`	object	No	—	Relational Field
`RowCondition`	string	No	—	Row Condition
`SampleParameters`	object	No	—	Sample Parameters
`SearchProviderCondition`	object	No	—	Search Provider Condition
`Sorts`	object[]	No	—	The sorts value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "start": {
      "type": "integer",
      "description": "The start value"
    },
    "length": {
      "type": "integer",
      "description": "The length value"
    },
    "ActiveArtifactID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Active Artifact ID"
    },
    "Condition": {
      "type": "string",
      "description": "The condition value"
    },
    "ConvertNumberFieldValuesToString": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Convert Number Field Values To String"
    },
    "ExecutingSavedSearchID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing Saved Search ID"
    },
    "ExecutingViewID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing View ID"
    },
    "Fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ArtifactID": {
            "type": "integer",
            "description": "Artifact ID"
          },
          "ViewFieldID": {
            "type": "integer",
            "description": "View Field ID"
          },
          "Guids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The guids value"
          },
          "Name": {
            "type": "string",
            "description": "The name value"
          }
        }
      },
      "description": "The fields value"
    },
    "IncludeIDWindow": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include ID Window"
    },
    "IncludeNameInQueryResult": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include Name In Query Result"
    },
    "IsAdhocQuery": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Is Adhoc Query"
    },
    "LongTextBehavior": {
      "type": "string",
      "description": "Long Text Behavior",
      "enum": [
        "Default",
        "Tokenized",
        "DefaultWithErrors",
        "TokenizedWithErrors"
      ]
    },
    "MaxCharactersForLongTextValues": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Max Characters For Long Text Values"
    },
    "ObjectType": {
      "type": "object",
      "description": "Object Type",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        },
        "Guid": {
          "type": "string",
          "description": "The guid value"
        },
        "ArtifactTypeID": {
          "type": "integer",
          "description": "Artifact Type ID"
        }
      }
    },
    "QueryHint": {
      "type": "string",
      "description": "Query Hint"
    },
    "RankSortOrder": {
      "type": [
        "string",
        "null"
      ],
      "description": "Rank Sort Order",
      "enum": [
        "Ascending",
        "Descending"
      ]
    },
    "RelationalField": {
      "type": "object",
      "description": "Relational Field",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "ViewFieldID": {
          "type": "integer",
          "description": "View Field ID"
        },
        "Guids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The guids value"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "RowCondition": {
      "type": "string",
      "description": "Row Condition"
    },
    "SampleParameters": {
      "type": "object",
      "description": "Sample Parameters",
      "properties": {
        "ExistingToken": {
          "type": "string",
          "description": "Existing Token"
        },
        "MarginOfError": {
          "type": "number",
          "description": "Margin Of Error"
        },
        "ConfidenceLevel": {
          "type": "number",
          "description": "Confidence Level"
        },
        "FixedSampleSize": {
          "type": "integer",
          "description": "Fixed Sample Size"
        },
        "SamplingPercentage": {
          "type": "number",
          "description": "Sampling Percentage"
        }
      }
    },
    "SearchProviderCondition": {
      "type": "object",
      "description": "Search Provider Condition",
      "properties": {
        "SearchIndex": {
          "type": "object",
          "description": "Search Index"
        },
        "Input": {
          "type": "string",
          "description": "The input value"
        }
      }
    },
    "Sorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "FieldIdentifier": {
            "type": "object",
            "description": "Field Identifier"
          },
          "Order": {
            "type": "integer",
            "description": "The order value"
          },
          "Direction": {
            "type": "string",
            "enum": [
              "Ascending",
              "Descending"
            ],
            "description": "The direction value"
          }
        }
      },
      "description": "The sorts value"
    }
  },
  "required": [
    "PCID",
    "start",
    "length"
  ]
}

relativity_workspaces_query_eligible_matters

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`start`	integer	Yes	—	The start value
`length`	integer	Yes	—	The length value
`ActiveArtifactID`	integer	null	No	—	Active Artifact ID
`Condition`	string	No	—	The condition value
`ConvertNumberFieldValuesToString`	boolean	null	No	—	Convert Number Field Values To String
`ExecutingSavedSearchID`	integer	null	No	—	Executing Saved Search ID
`ExecutingViewID`	integer	null	No	—	Executing View ID
`Fields`	object[]	No	—	The fields value
`IncludeIDWindow`	boolean	null	No	—	Include ID Window
`IncludeNameInQueryResult`	boolean	null	No	—	Include Name In Query Result
`IsAdhocQuery`	boolean	null	No	—	Is Adhoc Query
`LongTextBehavior`	string	No	—	Long Text Behavior
`MaxCharactersForLongTextValues`	integer	null	No	—	Max Characters For Long Text Values
`ObjectType`	object	No	—	Object Type
`QueryHint`	string	No	—	Query Hint
`RankSortOrder`	string	null	No	—	Rank Sort Order
`RelationalField`	object	No	—	Relational Field
`RowCondition`	string	No	—	Row Condition
`SampleParameters`	object	No	—	Sample Parameters
`SearchProviderCondition`	object	No	—	Search Provider Condition
`Sorts`	object[]	No	—	The sorts value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "start": {
      "type": "integer",
      "description": "The start value"
    },
    "length": {
      "type": "integer",
      "description": "The length value"
    },
    "ActiveArtifactID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Active Artifact ID"
    },
    "Condition": {
      "type": "string",
      "description": "The condition value"
    },
    "ConvertNumberFieldValuesToString": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Convert Number Field Values To String"
    },
    "ExecutingSavedSearchID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing Saved Search ID"
    },
    "ExecutingViewID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing View ID"
    },
    "Fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ArtifactID": {
            "type": "integer",
            "description": "Artifact ID"
          },
          "ViewFieldID": {
            "type": "integer",
            "description": "View Field ID"
          },
          "Guids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The guids value"
          },
          "Name": {
            "type": "string",
            "description": "The name value"
          }
        }
      },
      "description": "The fields value"
    },
    "IncludeIDWindow": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include ID Window"
    },
    "IncludeNameInQueryResult": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include Name In Query Result"
    },
    "IsAdhocQuery": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Is Adhoc Query"
    },
    "LongTextBehavior": {
      "type": "string",
      "description": "Long Text Behavior",
      "enum": [
        "Default",
        "Tokenized",
        "DefaultWithErrors",
        "TokenizedWithErrors"
      ]
    },
    "MaxCharactersForLongTextValues": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Max Characters For Long Text Values"
    },
    "ObjectType": {
      "type": "object",
      "description": "Object Type",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        },
        "Guid": {
          "type": "string",
          "description": "The guid value"
        },
        "ArtifactTypeID": {
          "type": "integer",
          "description": "Artifact Type ID"
        }
      }
    },
    "QueryHint": {
      "type": "string",
      "description": "Query Hint"
    },
    "RankSortOrder": {
      "type": [
        "string",
        "null"
      ],
      "description": "Rank Sort Order",
      "enum": [
        "Ascending",
        "Descending"
      ]
    },
    "RelationalField": {
      "type": "object",
      "description": "Relational Field",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "ViewFieldID": {
          "type": "integer",
          "description": "View Field ID"
        },
        "Guids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The guids value"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "RowCondition": {
      "type": "string",
      "description": "Row Condition"
    },
    "SampleParameters": {
      "type": "object",
      "description": "Sample Parameters",
      "properties": {
        "ExistingToken": {
          "type": "string",
          "description": "Existing Token"
        },
        "MarginOfError": {
          "type": "number",
          "description": "Margin Of Error"
        },
        "ConfidenceLevel": {
          "type": "number",
          "description": "Confidence Level"
        },
        "FixedSampleSize": {
          "type": "integer",
          "description": "Fixed Sample Size"
        },
        "SamplingPercentage": {
          "type": "number",
          "description": "Sampling Percentage"
        }
      }
    },
    "SearchProviderCondition": {
      "type": "object",
      "description": "Search Provider Condition",
      "properties": {
        "SearchIndex": {
          "type": "object",
          "description": "Search Index"
        },
        "Input": {
          "type": "string",
          "description": "The input value"
        }
      }
    },
    "Sorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "FieldIdentifier": {
            "type": "object",
            "description": "Field Identifier"
          },
          "Order": {
            "type": "integer",
            "description": "The order value"
          },
          "Direction": {
            "type": "string",
            "enum": [
              "Ascending",
              "Descending"
            ],
            "description": "The direction value"
          }
        }
      },
      "description": "The sorts value"
    }
  },
  "required": [
    "PCID",
    "start",
    "length"
  ]
}

relativity_workspaces_query_eligible_saved_searches

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`start`	integer	Yes	—	The start value
`length`	integer	Yes	—	The length value
`workspaceID`	integer	Yes	—	Workspace ID
`ActiveArtifactID`	integer	null	No	—	Active Artifact ID
`Condition`	string	No	—	The condition value
`ConvertNumberFieldValuesToString`	boolean	null	No	—	Convert Number Field Values To String
`ExecutingSavedSearchID`	integer	null	No	—	Executing Saved Search ID
`ExecutingViewID`	integer	null	No	—	Executing View ID
`Fields`	object[]	No	—	The fields value
`IncludeIDWindow`	boolean	null	No	—	Include ID Window
`IncludeNameInQueryResult`	boolean	null	No	—	Include Name In Query Result
`IsAdhocQuery`	boolean	null	No	—	Is Adhoc Query
`LongTextBehavior`	string	No	—	Long Text Behavior
`MaxCharactersForLongTextValues`	integer	null	No	—	Max Characters For Long Text Values
`ObjectType`	object	No	—	Object Type
`QueryHint`	string	No	—	Query Hint
`RankSortOrder`	string	null	No	—	Rank Sort Order
`RelationalField`	object	No	—	Relational Field
`RowCondition`	string	No	—	Row Condition
`SampleParameters`	object	No	—	Sample Parameters
`SearchProviderCondition`	object	No	—	Search Provider Condition
`Sorts`	object[]	No	—	The sorts value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "start": {
      "type": "integer",
      "description": "The start value"
    },
    "length": {
      "type": "integer",
      "description": "The length value"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "ActiveArtifactID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Active Artifact ID"
    },
    "Condition": {
      "type": "string",
      "description": "The condition value"
    },
    "ConvertNumberFieldValuesToString": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Convert Number Field Values To String"
    },
    "ExecutingSavedSearchID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing Saved Search ID"
    },
    "ExecutingViewID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing View ID"
    },
    "Fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ArtifactID": {
            "type": "integer",
            "description": "Artifact ID"
          },
          "ViewFieldID": {
            "type": "integer",
            "description": "View Field ID"
          },
          "Guids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The guids value"
          },
          "Name": {
            "type": "string",
            "description": "The name value"
          }
        }
      },
      "description": "The fields value"
    },
    "IncludeIDWindow": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include ID Window"
    },
    "IncludeNameInQueryResult": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include Name In Query Result"
    },
    "IsAdhocQuery": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Is Adhoc Query"
    },
    "LongTextBehavior": {
      "type": "string",
      "description": "Long Text Behavior",
      "enum": [
        "Default",
        "Tokenized",
        "DefaultWithErrors",
        "TokenizedWithErrors"
      ]
    },
    "MaxCharactersForLongTextValues": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Max Characters For Long Text Values"
    },
    "ObjectType": {
      "type": "object",
      "description": "Object Type",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        },
        "Guid": {
          "type": "string",
          "description": "The guid value"
        },
        "ArtifactTypeID": {
          "type": "integer",
          "description": "Artifact Type ID"
        }
      }
    },
    "QueryHint": {
      "type": "string",
      "description": "Query Hint"
    },
    "RankSortOrder": {
      "type": [
        "string",
        "null"
      ],
      "description": "Rank Sort Order",
      "enum": [
        "Ascending",
        "Descending"
      ]
    },
    "RelationalField": {
      "type": "object",
      "description": "Relational Field",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "ViewFieldID": {
          "type": "integer",
          "description": "View Field ID"
        },
        "Guids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The guids value"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "RowCondition": {
      "type": "string",
      "description": "Row Condition"
    },
    "SampleParameters": {
      "type": "object",
      "description": "Sample Parameters",
      "properties": {
        "ExistingToken": {
          "type": "string",
          "description": "Existing Token"
        },
        "MarginOfError": {
          "type": "number",
          "description": "Margin Of Error"
        },
        "ConfidenceLevel": {
          "type": "number",
          "description": "Confidence Level"
        },
        "FixedSampleSize": {
          "type": "integer",
          "description": "Fixed Sample Size"
        },
        "SamplingPercentage": {
          "type": "number",
          "description": "Sampling Percentage"
        }
      }
    },
    "SearchProviderCondition": {
      "type": "object",
      "description": "Search Provider Condition",
      "properties": {
        "SearchIndex": {
          "type": "object",
          "description": "Search Index"
        },
        "Input": {
          "type": "string",
          "description": "The input value"
        }
      }
    },
    "Sorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "FieldIdentifier": {
            "type": "object",
            "description": "Field Identifier"
          },
          "Order": {
            "type": "integer",
            "description": "The order value"
          },
          "Direction": {
            "type": "string",
            "enum": [
              "Ascending",
              "Descending"
            ],
            "description": "The direction value"
          }
        }
      },
      "description": "The sorts value"
    }
  },
  "required": [
    "PCID",
    "start",
    "length",
    "workspaceID"
  ]
}

relativity_workspaces_query_eligible_templates

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`start`	integer	Yes	—	The start value
`length`	integer	Yes	—	The length value
`ActiveArtifactID`	integer	null	No	—	Active Artifact ID
`Condition`	string	No	—	The condition value
`ConvertNumberFieldValuesToString`	boolean	null	No	—	Convert Number Field Values To String
`ExecutingSavedSearchID`	integer	null	No	—	Executing Saved Search ID
`ExecutingViewID`	integer	null	No	—	Executing View ID
`Fields`	object[]	No	—	The fields value
`IncludeIDWindow`	boolean	null	No	—	Include ID Window
`IncludeNameInQueryResult`	boolean	null	No	—	Include Name In Query Result
`IsAdhocQuery`	boolean	null	No	—	Is Adhoc Query
`LongTextBehavior`	string	No	—	Long Text Behavior
`MaxCharactersForLongTextValues`	integer	null	No	—	Max Characters For Long Text Values
`ObjectType`	object	No	—	Object Type
`QueryHint`	string	No	—	Query Hint
`RankSortOrder`	string	null	No	—	Rank Sort Order
`RelationalField`	object	No	—	Relational Field
`RowCondition`	string	No	—	Row Condition
`SampleParameters`	object	No	—	Sample Parameters
`SearchProviderCondition`	object	No	—	Search Provider Condition
`Sorts`	object[]	No	—	The sorts value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "start": {
      "type": "integer",
      "description": "The start value"
    },
    "length": {
      "type": "integer",
      "description": "The length value"
    },
    "ActiveArtifactID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Active Artifact ID"
    },
    "Condition": {
      "type": "string",
      "description": "The condition value"
    },
    "ConvertNumberFieldValuesToString": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Convert Number Field Values To String"
    },
    "ExecutingSavedSearchID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing Saved Search ID"
    },
    "ExecutingViewID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing View ID"
    },
    "Fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ArtifactID": {
            "type": "integer",
            "description": "Artifact ID"
          },
          "ViewFieldID": {
            "type": "integer",
            "description": "View Field ID"
          },
          "Guids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The guids value"
          },
          "Name": {
            "type": "string",
            "description": "The name value"
          }
        }
      },
      "description": "The fields value"
    },
    "IncludeIDWindow": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include ID Window"
    },
    "IncludeNameInQueryResult": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include Name In Query Result"
    },
    "IsAdhocQuery": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Is Adhoc Query"
    },
    "LongTextBehavior": {
      "type": "string",
      "description": "Long Text Behavior",
      "enum": [
        "Default",
        "Tokenized",
        "DefaultWithErrors",
        "TokenizedWithErrors"
      ]
    },
    "MaxCharactersForLongTextValues": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Max Characters For Long Text Values"
    },
    "ObjectType": {
      "type": "object",
      "description": "Object Type",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        },
        "Guid": {
          "type": "string",
          "description": "The guid value"
        },
        "ArtifactTypeID": {
          "type": "integer",
          "description": "Artifact Type ID"
        }
      }
    },
    "QueryHint": {
      "type": "string",
      "description": "Query Hint"
    },
    "RankSortOrder": {
      "type": [
        "string",
        "null"
      ],
      "description": "Rank Sort Order",
      "enum": [
        "Ascending",
        "Descending"
      ]
    },
    "RelationalField": {
      "type": "object",
      "description": "Relational Field",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "ViewFieldID": {
          "type": "integer",
          "description": "View Field ID"
        },
        "Guids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The guids value"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "RowCondition": {
      "type": "string",
      "description": "Row Condition"
    },
    "SampleParameters": {
      "type": "object",
      "description": "Sample Parameters",
      "properties": {
        "ExistingToken": {
          "type": "string",
          "description": "Existing Token"
        },
        "MarginOfError": {
          "type": "number",
          "description": "Margin Of Error"
        },
        "ConfidenceLevel": {
          "type": "number",
          "description": "Confidence Level"
        },
        "FixedSampleSize": {
          "type": "integer",
          "description": "Fixed Sample Size"
        },
        "SamplingPercentage": {
          "type": "number",
          "description": "Sampling Percentage"
        }
      }
    },
    "SearchProviderCondition": {
      "type": "object",
      "description": "Search Provider Condition",
      "properties": {
        "SearchIndex": {
          "type": "object",
          "description": "Search Index"
        },
        "Input": {
          "type": "string",
          "description": "The input value"
        }
      }
    },
    "Sorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "FieldIdentifier": {
            "type": "object",
            "description": "Field Identifier"
          },
          "Order": {
            "type": "integer",
            "description": "The order value"
          },
          "Direction": {
            "type": "string",
            "enum": [
              "Ascending",
              "Descending"
            ],
            "description": "The direction value"
          }
        }
      },
      "description": "The sorts value"
    }
  },
  "required": [
    "PCID",
    "start",
    "length"
  ]
}

relativity_workspaces_query_workspaces_by_group

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`start`	integer	Yes	—	The start value
`length`	integer	Yes	—	The length value
`groupID`	integer	Yes	—	Group ID
`ActiveArtifactID`	integer	null	No	—	Active Artifact ID
`Condition`	string	No	—	The condition value
`ConvertNumberFieldValuesToString`	boolean	null	No	—	Convert Number Field Values To String
`ExecutingSavedSearchID`	integer	null	No	—	Executing Saved Search ID
`ExecutingViewID`	integer	null	No	—	Executing View ID
`Fields`	object[]	No	—	The fields value
`IncludeIDWindow`	boolean	null	No	—	Include ID Window
`IncludeNameInQueryResult`	boolean	null	No	—	Include Name In Query Result
`IsAdhocQuery`	boolean	null	No	—	Is Adhoc Query
`LongTextBehavior`	string	No	—	Long Text Behavior
`MaxCharactersForLongTextValues`	integer	null	No	—	Max Characters For Long Text Values
`ObjectType`	object	No	—	Object Type
`QueryHint`	string	No	—	Query Hint
`RankSortOrder`	string	null	No	—	Rank Sort Order
`RelationalField`	object	No	—	Relational Field
`RowCondition`	string	No	—	Row Condition
`SampleParameters`	object	No	—	Sample Parameters
`SearchProviderCondition`	object	No	—	Search Provider Condition
`Sorts`	object[]	No	—	The sorts value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "start": {
      "type": "integer",
      "description": "The start value"
    },
    "length": {
      "type": "integer",
      "description": "The length value"
    },
    "groupID": {
      "type": "integer",
      "description": "Group ID"
    },
    "ActiveArtifactID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Active Artifact ID"
    },
    "Condition": {
      "type": "string",
      "description": "The condition value"
    },
    "ConvertNumberFieldValuesToString": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Convert Number Field Values To String"
    },
    "ExecutingSavedSearchID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing Saved Search ID"
    },
    "ExecutingViewID": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Executing View ID"
    },
    "Fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ArtifactID": {
            "type": "integer",
            "description": "Artifact ID"
          },
          "ViewFieldID": {
            "type": "integer",
            "description": "View Field ID"
          },
          "Guids": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The guids value"
          },
          "Name": {
            "type": "string",
            "description": "The name value"
          }
        }
      },
      "description": "The fields value"
    },
    "IncludeIDWindow": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include ID Window"
    },
    "IncludeNameInQueryResult": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Include Name In Query Result"
    },
    "IsAdhocQuery": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Is Adhoc Query"
    },
    "LongTextBehavior": {
      "type": "string",
      "description": "Long Text Behavior",
      "enum": [
        "Default",
        "Tokenized",
        "DefaultWithErrors",
        "TokenizedWithErrors"
      ]
    },
    "MaxCharactersForLongTextValues": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Max Characters For Long Text Values"
    },
    "ObjectType": {
      "type": "object",
      "description": "Object Type",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        },
        "Guid": {
          "type": "string",
          "description": "The guid value"
        },
        "ArtifactTypeID": {
          "type": "integer",
          "description": "Artifact Type ID"
        }
      }
    },
    "QueryHint": {
      "type": "string",
      "description": "Query Hint"
    },
    "RankSortOrder": {
      "type": [
        "string",
        "null"
      ],
      "description": "Rank Sort Order",
      "enum": [
        "Ascending",
        "Descending"
      ]
    },
    "RelationalField": {
      "type": "object",
      "description": "Relational Field",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "ViewFieldID": {
          "type": "integer",
          "description": "View Field ID"
        },
        "Guids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The guids value"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "RowCondition": {
      "type": "string",
      "description": "Row Condition"
    },
    "SampleParameters": {
      "type": "object",
      "description": "Sample Parameters",
      "properties": {
        "ExistingToken": {
          "type": "string",
          "description": "Existing Token"
        },
        "MarginOfError": {
          "type": "number",
          "description": "Margin Of Error"
        },
        "ConfidenceLevel": {
          "type": "number",
          "description": "Confidence Level"
        },
        "FixedSampleSize": {
          "type": "integer",
          "description": "Fixed Sample Size"
        },
        "SamplingPercentage": {
          "type": "number",
          "description": "Sampling Percentage"
        }
      }
    },
    "SearchProviderCondition": {
      "type": "object",
      "description": "Search Provider Condition",
      "properties": {
        "SearchIndex": {
          "type": "object",
          "description": "Search Index"
        },
        "Input": {
          "type": "string",
          "description": "The input value"
        }
      }
    },
    "Sorts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "FieldIdentifier": {
            "type": "object",
            "description": "Field Identifier"
          },
          "Order": {
            "type": "integer",
            "description": "The order value"
          },
          "Direction": {
            "type": "string",
            "enum": [
              "Ascending",
              "Descending"
            ],
            "description": "The direction value"
          }
        }
      },
      "description": "The sorts value"
    }
  },
  "required": [
    "PCID",
    "start",
    "length",
    "groupID"
  ]
}

relativity_workspaces_update_matter

[Public] IMatterManager - Parameters:

Parameter	Type	Required	Default	Description
`matterID`	integer	Yes	—	Matter ID
`Client`	object	No	—	The client value
`Keywords`	string	No	—	The keywords value
`Name`	string	No	—	The name value
`Notes`	string	No	—	The notes value
`Number`	string	No	—	The number value
`Status`	object	No	—	The status value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "matterID": {
      "type": "integer",
      "description": "Matter ID"
    },
    "Client": {
      "type": "object",
      "description": "The client value",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "Keywords": {
      "type": "string",
      "description": "The keywords value"
    },
    "Name": {
      "type": "string",
      "description": "The name value"
    },
    "Notes": {
      "type": "string",
      "description": "The notes value"
    },
    "Number": {
      "type": "string",
      "description": "The number value"
    },
    "Status": {
      "type": "object",
      "description": "The status value",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "matterID"
  ]
}

relativity_workspaces_update_workspace

[Public] IWorkspaceManager - Parameters:

Parameter	Type	Required	Default	Description
`workspaceID`	integer	Yes	—	Workspace ID
`AzureCredentials`	object	No	—	Azure Credentials
`AzureFileSystemCredentials`	object	No	—	Azure File System Credentials
`DataGridFileRepository`	object	No	—	Data Grid File Repository
`DefaultCacheLocation`	object	No	—	Default Cache Location
`DefaultFileRepository`	object	No	—	Default File Repository
`DownloadHandlerUrl`	string	No	—	Download Handler Url
`EnableDataGrid`	boolean	No	—	Enable Data Grid
`Keywords`	string	No	—	The keywords value
`Matter`	object	No	—	The matter value
`Name`	string	No	—	The name value
`Notes`	string	No	—	The notes value
`ProductionRestrictions`	object	No	—	Production Restrictions
`ResourcePool`	object	No	—	Resource Pool
`SqlFullTextLanguage`	integer	No	—	Sql Full Text Language
`SqlServer`	object	No	—	Sql Server
`Status`	object	No	—	The status value
`Template`	object	No	—	The template value
`WorkspaceAdminGroup`	object	No	—	Workspace Admin Group

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "AzureCredentials": {
      "type": "object",
      "description": "Azure Credentials",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "AzureFileSystemCredentials": {
      "type": "object",
      "description": "Azure File System Credentials",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "DataGridFileRepository": {
      "type": "object",
      "description": "Data Grid File Repository",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "DefaultCacheLocation": {
      "type": "object",
      "description": "Default Cache Location",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "DefaultFileRepository": {
      "type": "object",
      "description": "Default File Repository",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "DownloadHandlerUrl": {
      "type": "string",
      "description": "Download Handler Url"
    },
    "EnableDataGrid": {
      "type": "boolean",
      "description": "Enable Data Grid"
    },
    "Keywords": {
      "type": "string",
      "description": "The keywords value"
    },
    "Matter": {
      "type": "object",
      "description": "The matter value",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "Name": {
      "type": "string",
      "description": "The name value"
    },
    "Notes": {
      "type": "string",
      "description": "The notes value"
    },
    "ProductionRestrictions": {
      "type": "object",
      "description": "Production Restrictions",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "ResourcePool": {
      "type": "object",
      "description": "Resource Pool",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "SqlFullTextLanguage": {
      "type": "integer",
      "description": "Sql Full Text Language"
    },
    "SqlServer": {
      "type": "object",
      "description": "Sql Server",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "Status": {
      "type": "object",
      "description": "The status value",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "Guids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The guids value"
        }
      }
    },
    "Template": {
      "type": "object",
      "description": "The template value",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    },
    "WorkspaceAdminGroup": {
      "type": "object",
      "description": "Workspace Admin Group",
      "properties": {
        "Secured": {
          "type": "boolean",
          "description": "The secured value"
        },
        "Value": {
          "type": "object",
          "description": "The value value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID"
  ]
}

relativity_workspaces_update_workspace_details

Update workspace Parameters:

Parameter	Type	Required	Default	Description
`workspaceId`	integer	Yes	—	Workspace Id
`LastModifiedOn`	string	null	No	—	Last Modified On
`WorkspaceRequest`	object	Yes	—	Workspace Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceId": {
      "type": "integer",
      "description": "Workspace Id"
    },
    "LastModifiedOn": {
      "type": [
        "string",
        "null"
      ],
      "description": "Last Modified On"
    },
    "WorkspaceRequest": {
      "type": "object",
      "description": "Workspace Request",
      "properties": {
        "DownloadHandlerUrl": {
          "type": "string",
          "description": "Download Handler Url"
        },
        "EnableDataGrid": {
          "type": "boolean",
          "description": "Enable Data Grid"
        },
        "Matter": {
          "type": "object",
          "description": "The matter value"
        },
        "Name": {
          "type": "string",
          "description": "The name value"
        },
        "ProductionRestrictions": {
          "type": "object",
          "description": "Production Restrictions"
        },
        "ResourcePool": {
          "type": "object",
          "description": "Resource Pool"
        },
        "DefaultFileRepository": {
          "type": "object",
          "description": "Default File Repository"
        },
        "DataGridFileRepository": {
          "type": "object",
          "description": "Data Grid File Repository"
        },
        "DefaultCacheLocation": {
          "type": "object",
          "description": "Default Cache Location"
        },
        "SqlServer": {
          "type": "object",
          "description": "Sql Server"
        },
        "AzureCredentials": {
          "type": "object",
          "description": "Azure Credentials"
        },
        "AzureFileSystemCredentials": {
          "type": "object",
          "description": "Azure File System Credentials"
        },
        "SqlFullTextLanguage": {
          "type": "integer",
          "description": "Sql Full Text Language"
        },
        "Status": {
          "type": "object",
          "description": "The status value"
        },
        "Template": {
          "type": "object",
          "description": "The template value"
        },
        "WorkspaceAdminGroup": {
          "type": "object",
          "description": "Workspace Admin Group"
        },
        "UseCase": {
          "type": "string",
          "description": "Use Case"
        },
        "Keywords": {
          "type": "string",
          "description": "The keywords value"
        },
        "Notes": {
          "type": "string",
          "description": "The notes value"
        },
        "UserId": {
          "type": "integer",
          "description": "User Id"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceId",
    "WorkspaceRequest"
  ]
}

Platform API

Embedded MCP Servers

Application MCP Servers

Triggers API

Tools

relativity_workspaces_create_instance_setting

relativity_workspaces_create_matter

relativity_workspaces_create_workspace

relativity_workspaces_create_workspace_job

relativity_workspaces_delete_instance_setting

relativity_workspaces_delete_matter

relativity_workspaces_delete_workspace

relativity_workspaces_delete_workspace_details

relativity_workspaces_get_instance_setting

relativity_workspaces_get_matter

relativity_workspaces_get_workspace

relativity_workspaces_get_workspace_details

relativity_workspaces_get_workspace_job

relativity_workspaces_get_workspace_metadata_fields

relativity_workspaces_get_workspace_summary

relativity_workspaces_list_eligible_matter_statuses

relativity_workspaces_list_eligible_resource_pools

relativity_workspaces_list_eligible_workspace_statuses

relativity_workspaces_query_eligible_clients

relativity_workspaces_query_eligible_matters

relativity_workspaces_query_eligible_saved_searches

relativity_workspaces_query_eligible_templates

relativity_workspaces_query_workspaces_by_group

relativity_workspaces_update_matter

relativity_workspaces_update_workspace

relativity_workspaces_update_workspace_details

​Tools

​relativity_workspaces_create_instance_setting

​relativity_workspaces_create_matter

​relativity_workspaces_create_workspace

​relativity_workspaces_create_workspace_job

​relativity_workspaces_delete_instance_setting

​relativity_workspaces_delete_matter

​relativity_workspaces_delete_workspace

​relativity_workspaces_delete_workspace_details

​relativity_workspaces_get_instance_setting

​relativity_workspaces_get_matter

​relativity_workspaces_get_workspace

​relativity_workspaces_get_workspace_details

​relativity_workspaces_get_workspace_job

​relativity_workspaces_get_workspace_metadata_fields

​relativity_workspaces_get_workspace_summary

​relativity_workspaces_list_eligible_matter_statuses

​relativity_workspaces_list_eligible_resource_pools

​relativity_workspaces_list_eligible_workspace_statuses

​relativity_workspaces_query_eligible_clients

​relativity_workspaces_query_eligible_matters

​relativity_workspaces_query_eligible_saved_searches

​relativity_workspaces_query_eligible_templates

​relativity_workspaces_query_workspaces_by_group

​relativity_workspaces_update_matter

​relativity_workspaces_update_workspace

​relativity_workspaces_update_workspace_details

Tools

relativity_workspaces_create_instance_setting

relativity_workspaces_create_matter

relativity_workspaces_create_workspace

relativity_workspaces_create_workspace_job

relativity_workspaces_delete_instance_setting

relativity_workspaces_delete_matter

relativity_workspaces_delete_workspace

relativity_workspaces_delete_workspace_details

relativity_workspaces_get_instance_setting

relativity_workspaces_get_matter

relativity_workspaces_get_workspace

relativity_workspaces_get_workspace_details

relativity_workspaces_get_workspace_job

relativity_workspaces_get_workspace_metadata_fields

relativity_workspaces_get_workspace_summary

relativity_workspaces_list_eligible_matter_statuses

relativity_workspaces_list_eligible_resource_pools

relativity_workspaces_list_eligible_workspace_statuses

relativity_workspaces_query_eligible_clients

relativity_workspaces_query_eligible_matters

relativity_workspaces_query_eligible_saved_searches

relativity_workspaces_query_eligible_templates

relativity_workspaces_query_workspaces_by_group

relativity_workspaces_update_matter

relativity_workspaces_update_workspace

relativity_workspaces_update_workspace_details