relativity-documents

Relativity Documents - object management and processing

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

Tools

Tool	Description
relativity_documents_create_object	[Public] IObjectManager -
relativity_documents_create_processing_filter	[Public] IProcessingFilterManager -
relativity_documents_delete_object	[Public] IObjectManager -
relativity_documents_delete_processing_filter	[Public] IProcessingFilterManager -
relativity_documents_get_discovered_document_ids	[Public] IProcessingFilterManager -
relativity_documents_get_discovered_documents	[Public] IProcessingFilterManager -
relativity_documents_get_document_error_history	[Public] IProcessingDocumentManager -
relativity_documents_get_document_file_paths	[Public] IProcessingDocumentManager -
relativity_documents_get_export_block	[Public] IObjectManager -
relativity_documents_get_filter_result	[Public] IProcessingFilterManager -
relativity_documents_get_metadata	[Public] IProcessingDocumentManager -
relativity_documents_get_next_export_block	[Public] IObjectManager -
relativity_documents_get_object_dependencies	[Public] IObjectManager -
relativity_documents_get_processing_metadata	[Public] IProcessingDocumentManager -
relativity_documents_get_publish_job_errors	[Public] IProcessingDocumentManager -
relativity_documents_get_publishable_document_count	[Public] IProcessingDocumentManager -
relativity_documents_initialize_object_export	[Public] IObjectManager -
relativity_documents_list_processing_filters	[Public] IProcessingFilterManager -
relativity_documents_publish_documents	[Public] IProcessingDocumentManager -
relativity_documents_query_objects	[Public] IObjectManager -
relativity_documents_query_objects_slim	[Public] IObjectManager -
relativity_documents_read_object	[Public] IObjectManager -
relativity_documents_retry_document_errors	[Public] IProcessingDocumentManager -
relativity_documents_stream_long_text	[Public] IObjectManager -
relativity_documents_update_long_text	[Public] IObjectManager -
relativity_documents_update_object	[Public] IObjectManager -
relativity_documents_update_processing_filter	[Public] IProcessingFilterManager -

---

relativity_documents_create_object

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
operationOptions	object	No	—	Operation Options
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "operationOptions": {
      "type": "object",
      "description": "Operation Options",
      "properties": {
        "CallingContext": {
          "type": "object",
          "description": "Calling Context"
        }
      }
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "ParentObject": {
          "type": "object",
          "description": "Parent Object"
        },
        "ObjectType": {
          "type": "object",
          "description": "Object Type"
        },
        "FieldValues": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Field Values"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_create_processing_filter

[Public] IProcessingFilterManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "FilterName": {
          "type": "string",
          "description": "Filter Name"
        },
        "DataSourceIDs": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Data Source I Ds"
        },
        "Expression": {
          "type": "string",
          "description": "The expression value"
        },
        "IncludeFamily": {
          "type": "boolean",
          "description": "Include Family"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_delete_object

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "Object": {
          "type": "object",
          "description": "The object value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_delete_processing_filter

[Public] IProcessingFilterManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
filterID	integer	Yes	—	Filter ID
x-csrf-header	string	Yes	—	The x-csrf-header value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "filterID": {
      "type": "integer",
      "description": "Filter ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "filterID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_discovered_document_ids

[Public] IProcessingFilterManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "StartingPointOfResult": {
          "type": "integer",
          "description": "Starting Point Of Result"
        },
        "NumberOfResults": {
          "type": "integer",
          "description": "Number Of Results"
        },
        "Expression": {
          "type": "string",
          "description": "The expression value"
        },
        "AuditedSourceID": {
          "type": "integer",
          "description": "Audited Source ID"
        },
        "SortingOptions": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Sorting Options"
        },
        "ExcludeTotalCount": {
          "type": "boolean",
          "description": "Exclude Total Count"
        },
        "IncludeDuplicateHash": {
          "type": "boolean",
          "description": "Include Duplicate Hash"
        },
        "AdvancedOptionsFlag": {
          "type": "string",
          "description": "Advanced Options Flag",
          "enum": [
            "None",
            "EnableMDSKepler"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_discovered_documents

[Public] IProcessingFilterManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "StartingPointOfResult": {
          "type": "integer",
          "description": "Starting Point Of Result"
        },
        "NumberOfResults": {
          "type": "integer",
          "description": "Number Of Results"
        },
        "Expression": {
          "type": "string",
          "description": "The expression value"
        },
        "AuditedSourceID": {
          "type": "integer",
          "description": "Audited Source ID"
        },
        "SortingOptions": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Sorting Options"
        },
        "ExcludeTotalCount": {
          "type": "boolean",
          "description": "Exclude Total Count"
        },
        "IncludeDuplicateHash": {
          "type": "boolean",
          "description": "Include Duplicate Hash"
        },
        "AdvancedOptionsFlag": {
          "type": "string",
          "description": "Advanced Options Flag",
          "enum": [
            "None",
            "EnableMDSKepler"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_document_error_history

[Public] IProcessingDocumentManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
logicalID	string	Yes	—	Logical ID
x-csrf-header	string	Yes	—	The x-csrf-header value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "logicalID": {
      "type": "string",
      "description": "Logical ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "logicalID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_document_file_paths

[Public] IProcessingDocumentManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "LogicalIDs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Logical I Ds"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_export_block

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
runID	string	Yes	—	Run ID
resultsBlockSize	integer	Yes	—	Results Block Size
exportIndexID	integer	Yes	—	Export Index ID
x-csrf-header	string	Yes	—	The x-csrf-header value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "runID": {
      "type": "string",
      "description": "Run ID"
    },
    "resultsBlockSize": {
      "type": "integer",
      "description": "Results Block Size"
    },
    "exportIndexID": {
      "type": "integer",
      "description": "Export Index ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "runID",
    "resultsBlockSize",
    "exportIndexID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_filter_result

[Public] IProcessingFilterManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
filterID	integer	Yes	—	Filter ID
x-csrf-header	string	Yes	—	The x-csrf-header value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "filterID": {
      "type": "integer",
      "description": "Filter ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "filterID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_metadata

[Public] IProcessingDocumentManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "LogicalIDs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Logical I Ds"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_next_export_block

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
runID	string	Yes	—	Run ID
batchSize	integer	Yes	—	Batch Size
x-csrf-header	string	Yes	—	The x-csrf-header value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "runID": {
      "type": "string",
      "description": "Run ID"
    },
    "batchSize": {
      "type": "integer",
      "description": "Batch Size"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "runID",
    "batchSize",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_object_dependencies

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "Objects": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The objects value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_processing_metadata

[Public] IProcessingDocumentManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
logicalID	string	Yes	—	Logical ID
x-csrf-header	string	Yes	—	The x-csrf-header value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "logicalID": {
      "type": "string",
      "description": "Logical ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "logicalID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_publish_job_errors

[Public] IProcessingDocumentManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
documentsRequest	object	No	—	Documents Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "documentsRequest": {
      "type": "object",
      "description": "Documents Request",
      "properties": {
        "LogicalIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Logical Ids"
        },
        "Expression": {
          "type": "string",
          "description": "The expression value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_get_publishable_document_count

[Public] IProcessingDocumentManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
documentsRequest	object	No	—	Documents Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "documentsRequest": {
      "type": "object",
      "description": "Documents Request",
      "properties": {
        "LogicalIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Logical Ids"
        },
        "Expression": {
          "type": "string",
          "description": "The expression value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_initialize_object_export

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
start	integer	Yes	—	The start value
x-csrf-header	string	Yes	—	The x-csrf-header value
queryRequest	object	No	—	Query Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "start": {
      "type": "integer",
      "description": "The start value"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "queryRequest": {
      "type": "object",
      "description": "Query Request",
      "properties": {
        "ObjectType": {
          "type": "object",
          "description": "Object Type"
        },
        "Condition": {
          "type": "string",
          "description": "The condition value"
        },
        "Sorts": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The sorts value"
        },
        "RelationalField": {
          "type": "object",
          "description": "Relational Field"
        },
        "RowCondition": {
          "type": "string",
          "description": "Row Condition"
        },
        "SearchProviderCondition": {
          "type": "object",
          "description": "Search Provider Condition"
        },
        "SampleParameters": {
          "type": "object",
          "description": "Sample Parameters"
        },
        "IncludeIDWindow": {
          "type": "boolean",
          "description": "Include ID Window"
        },
        "RankSortOrder": {
          "type": "string",
          "description": "Rank Sort Order",
          "enum": [
            "Ascending",
            "Descending"
          ]
        },
        "QueryHint": {
          "type": "string",
          "description": "Query Hint"
        },
        "Fields": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The fields value"
        },
        "IsAdhocQuery": {
          "type": "boolean",
          "description": "Is Adhoc Query"
        },
        "ConvertNumberFieldValuesToString": {
          "type": "boolean",
          "description": "Convert Number Field Values To String"
        },
        "IncludeNameInQueryResult": {
          "type": "boolean",
          "description": "Include Name In Query Result"
        },
        "ExecutingSavedSearchID": {
          "type": "integer",
          "description": "Executing Saved Search ID"
        },
        "ExecutingViewID": {
          "type": "integer",
          "description": "Executing View ID"
        },
        "ActiveArtifactID": {
          "type": "integer",
          "description": "Active Artifact ID"
        },
        "MaxCharactersForLongTextValues": {
          "type": "integer",
          "description": "Max Characters For Long Text Values"
        },
        "LongTextBehavior": {
          "type": "string",
          "description": "Long Text Behavior",
          "enum": [
            "Default",
            "Tokenized",
            "DefaultWithErrors",
            "TokenizedWithErrors"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "start",
    "x-csrf-header"
  ]
}

---

relativity_documents_list_processing_filters

[Public] IProcessingFilterManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value

Show inputSchema

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

---

relativity_documents_publish_documents

[Public] IProcessingDocumentManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
documentsRequest	object	No	—	Documents Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "documentsRequest": {
      "type": "object",
      "description": "Documents Request",
      "properties": {
        "LogicalIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Logical Ids"
        },
        "Expression": {
          "type": "string",
          "description": "The expression value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_query_objects

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
start	integer	Yes	—	The start value
length	integer	Yes	—	The length value
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "start": {
      "type": "integer",
      "description": "The start value"
    },
    "length": {
      "type": "integer",
      "description": "The length value"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "ObjectType": {
          "type": "object",
          "description": "Object Type"
        },
        "Condition": {
          "type": "string",
          "description": "The condition value"
        },
        "Sorts": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The sorts value"
        },
        "RelationalField": {
          "type": "object",
          "description": "Relational Field"
        },
        "RowCondition": {
          "type": "string",
          "description": "Row Condition"
        },
        "SearchProviderCondition": {
          "type": "object",
          "description": "Search Provider Condition"
        },
        "SampleParameters": {
          "type": "object",
          "description": "Sample Parameters"
        },
        "IncludeIDWindow": {
          "type": "boolean",
          "description": "Include ID Window"
        },
        "RankSortOrder": {
          "type": "string",
          "description": "Rank Sort Order",
          "enum": [
            "Ascending",
            "Descending"
          ]
        },
        "QueryHint": {
          "type": "string",
          "description": "Query Hint"
        },
        "Fields": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The fields value"
        },
        "IsAdhocQuery": {
          "type": "boolean",
          "description": "Is Adhoc Query"
        },
        "ConvertNumberFieldValuesToString": {
          "type": "boolean",
          "description": "Convert Number Field Values To String"
        },
        "IncludeNameInQueryResult": {
          "type": "boolean",
          "description": "Include Name In Query Result"
        },
        "ExecutingSavedSearchID": {
          "type": "integer",
          "description": "Executing Saved Search ID"
        },
        "ExecutingViewID": {
          "type": "integer",
          "description": "Executing View ID"
        },
        "ActiveArtifactID": {
          "type": "integer",
          "description": "Active Artifact ID"
        },
        "MaxCharactersForLongTextValues": {
          "type": "integer",
          "description": "Max Characters For Long Text Values"
        },
        "LongTextBehavior": {
          "type": "string",
          "description": "Long Text Behavior",
          "enum": [
            "Default",
            "Tokenized",
            "DefaultWithErrors",
            "TokenizedWithErrors"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "start",
    "length",
    "x-csrf-header"
  ]
}

---

relativity_documents_query_objects_slim

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
start	integer	Yes	—	The start value
length	integer	Yes	—	The length value
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "start": {
      "type": "integer",
      "description": "The start value"
    },
    "length": {
      "type": "integer",
      "description": "The length value"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "ObjectType": {
          "type": "object",
          "description": "Object Type"
        },
        "Condition": {
          "type": "string",
          "description": "The condition value"
        },
        "Sorts": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The sorts value"
        },
        "RelationalField": {
          "type": "object",
          "description": "Relational Field"
        },
        "RowCondition": {
          "type": "string",
          "description": "Row Condition"
        },
        "SearchProviderCondition": {
          "type": "object",
          "description": "Search Provider Condition"
        },
        "SampleParameters": {
          "type": "object",
          "description": "Sample Parameters"
        },
        "IncludeIDWindow": {
          "type": "boolean",
          "description": "Include ID Window"
        },
        "RankSortOrder": {
          "type": "string",
          "description": "Rank Sort Order",
          "enum": [
            "Ascending",
            "Descending"
          ]
        },
        "QueryHint": {
          "type": "string",
          "description": "Query Hint"
        },
        "Fields": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The fields value"
        },
        "IsAdhocQuery": {
          "type": "boolean",
          "description": "Is Adhoc Query"
        },
        "ConvertNumberFieldValuesToString": {
          "type": "boolean",
          "description": "Convert Number Field Values To String"
        },
        "IncludeNameInQueryResult": {
          "type": "boolean",
          "description": "Include Name In Query Result"
        },
        "ExecutingSavedSearchID": {
          "type": "integer",
          "description": "Executing Saved Search ID"
        },
        "ExecutingViewID": {
          "type": "integer",
          "description": "Executing View ID"
        },
        "ActiveArtifactID": {
          "type": "integer",
          "description": "Active Artifact ID"
        },
        "MaxCharactersForLongTextValues": {
          "type": "integer",
          "description": "Max Characters For Long Text Values"
        },
        "LongTextBehavior": {
          "type": "string",
          "description": "Long Text Behavior",
          "enum": [
            "Default",
            "Tokenized",
            "DefaultWithErrors",
            "TokenizedWithErrors"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "start",
    "length",
    "x-csrf-header"
  ]
}

---

relativity_documents_read_object

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
readOptions	object	No	—	Read Options
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "readOptions": {
      "type": "object",
      "description": "Read Options",
      "properties": {
        "MaxCharactersForLongTextValues": {
          "type": "integer",
          "description": "Max Characters For Long Text Values"
        },
        "LongTextBehavior": {
          "type": "string",
          "description": "Long Text Behavior",
          "enum": [
            "Default",
            "Tokenized",
            "DefaultWithErrors",
            "TokenizedWithErrors"
          ]
        },
        "FieldTypesToReturnAsString": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "FixedLengthText",
              "WholeNumber",
              "Date",
              "YesNo",
              "LongText",
              "SingleChoice",
              "Decimal",
              "Currency",
              "MultipleChoice",
              "File",
              "SingleObject",
              "User",
              "MultipleObject",
              "Empty"
            ]
          },
          "description": "Field Types To Return As String"
        },
        "CallingContext": {
          "type": "object",
          "description": "Calling Context"
        }
      }
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "Object": {
          "type": "object",
          "description": "The object value"
        },
        "Fields": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The fields value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_retry_document_errors

[Public] IProcessingDocumentManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
documentsRequest	object	No	—	Documents Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "documentsRequest": {
      "type": "object",
      "description": "Documents Request",
      "properties": {
        "LogicalIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Logical Ids"
        },
        "Expression": {
          "type": "string",
          "description": "The expression value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_stream_long_text

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
exportObject	object	No	—	Export Object
longTextField	object	No	—	Long Text Field

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "exportObject": {
      "type": "object",
      "description": "Export Object",
      "properties": {
        "ArtifactID": {
          "type": "integer",
          "description": "Artifact ID"
        },
        "Guid": {
          "type": "string",
          "description": "The guid value"
        }
      }
    },
    "longTextField": {
      "type": "object",
      "description": "Long Text 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"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_update_long_text

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
keplerStream	object	No	—	Kepler Stream
updateLongTextFromStreamRequest	object	No	—	Update Long Text From Stream Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "keplerStream": {
      "type": "object",
      "description": "Kepler Stream",
      "properties": {
        "ContentType": {
          "type": "string",
          "description": "Content Type"
        },
        "ContentDisposition": {
          "type": "string",
          "description": "Content Disposition"
        },
        "CacheControl": {
          "type": "string",
          "description": "Cache Control"
        },
        "StatusCode": {
          "type": "string",
          "description": "Status Code",
          "enum": [
            "Continue",
            "SwitchingProtocols",
            "OK",
            "Created",
            "Accepted",
            "NonAuthoritativeInformation",
            "NoContent",
            "ResetContent",
            "PartialContent",
            "MultipleChoices",
            "Ambiguous",
            "MovedPermanently",
            "Moved",
            "Found",
            "Redirect",
            "SeeOther",
            "RedirectMethod",
            "NotModified",
            "UseProxy",
            "Unused",
            "TemporaryRedirect",
            "RedirectKeepVerb",
            "BadRequest",
            "Unauthorized",
            "PaymentRequired",
            "Forbidden",
            "NotFound",
            "MethodNotAllowed",
            "NotAcceptable",
            "ProxyAuthenticationRequired",
            "RequestTimeout",
            "Conflict",
            "Gone",
            "LengthRequired",
            "PreconditionFailed",
            "RequestEntityTooLarge",
            "RequestUriTooLong",
            "UnsupportedMediaType",
            "RequestedRangeNotSatisfiable",
            "ExpectationFailed",
            "UpgradeRequired",
            "InternalServerError",
            "NotImplemented",
            "BadGateway",
            "ServiceUnavailable",
            "GatewayTimeout",
            "HttpVersionNotSupported"
          ]
        },
        "Headers": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The headers value"
        }
      }
    },
    "updateLongTextFromStreamRequest": {
      "type": "object",
      "description": "Update Long Text From Stream Request",
      "properties": {
        "Object": {
          "type": "object",
          "description": "The object value"
        },
        "Field": {
          "type": "object",
          "description": "The field value"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_update_object

[Public] IObjectManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
x-csrf-header	string	Yes	—	The x-csrf-header value
operationOptions	object	No	—	Operation Options
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "operationOptions": {
      "type": "object",
      "description": "Operation Options",
      "properties": {
        "UpdateBehavior": {
          "type": "string",
          "description": "Update Behavior",
          "enum": [
            "Replace",
            "Merge",
            "Remove"
          ]
        },
        "CallingContext": {
          "type": "object",
          "description": "Calling Context"
        }
      }
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "Object": {
          "type": "object",
          "description": "The object value"
        },
        "FieldValues": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Field Values"
        },
        "ObjectVersionToken": {
          "type": "string",
          "description": "Object Version Token"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "x-csrf-header"
  ]
}

---

relativity_documents_update_processing_filter

[Public] IProcessingFilterManager -

Parameters:

Parameter	Type	Required	Default	Description
workspaceID	integer	Yes	—	Workspace ID
filterID	integer	Yes	—	Filter ID
x-csrf-header	string	Yes	—	The x-csrf-header value
request	object	No	—	The request value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workspaceID": {
      "type": "integer",
      "description": "Workspace ID"
    },
    "filterID": {
      "type": "integer",
      "description": "Filter ID"
    },
    "x-csrf-header": {
      "type": "string",
      "description": "The x-csrf-header value"
    },
    "request": {
      "type": "object",
      "description": "The request value",
      "properties": {
        "FilterName": {
          "type": "string",
          "description": "Filter Name"
        },
        "DataSourceIDs": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Data Source I Ds"
        },
        "Expression": {
          "type": "string",
          "description": "The expression value"
        },
        "IncludeFamily": {
          "type": "boolean",
          "description": "Include Family"
        }
      }
    }
  },
  "required": [
    "PCID",
    "workspaceID",
    "filterID",
    "x-csrf-header"
  ]
}