---
title: "POST /relativity-audit/v1/workspaces/{workspaceID}/audits/ui/query"
method: POST
path: "/relativity-audit/v1/workspaces/{workspaceID}/audits/ui/query"
tags: ["Audit Module v1"]
---

# POST /relativity-audit/v1/workspaces/{workspaceID}/audits/ui/query

`POST /relativity-audit/v1/workspaces/{workspaceID}/audits/ui/query`

## Request

- Base URL: `https://platform.relativity.com/Relativity.REST/api`
- URL: `https://platform.relativity.com/Relativity.REST/api/relativity-audit/v1/workspaces/{workspaceID}/audits/ui/query`
- Auth: none declared. Required headers: `x-csrf-header`
- TypeScript: <https://skmtc.dev/relativity/apis/relativity-audit-services-interfaces-v1/docs/relativity-audit/v1/workspaces/:workspaceID/audits/ui/query/post.ts> (a function with typed inputs; its response is checked against the schema)

[Public] IAuditObjectManagerUIService -

## Path parameters

- `workspaceID` integer, required

## Headers

- `x-csrf-header` string, required

## Request body

- QueryAsyncRequestBody
  - `request` QueryRequest
    - `ObjectType` ObjectTypeRef
      - `ArtifactID` integer
      - `Name` string
      - `Guid` string, nullable
      - `ArtifactTypeID` integer
    - `Condition` string
    - `Sorts` Sort[]
      - `FieldIdentifier` FieldRef
        - `ViewFieldID` integer
        - `ArtifactID` integer
        - `Guid` string, nullable
        - `Name` string
      - `Order` integer
      - `Direction` 'Ascending' | 'Descending'
    - `RelationalField` FieldRef
      - `ViewFieldID` integer
      - `ArtifactID` integer
      - `Guid` string, nullable
      - `Name` string
    - `RowCondition` string
    - `SearchProviderCondition` SearchProviderCondition
      - `SearchIndex` SearchIndexRef
        - `ArtifactID` integer
        - `Name` string
      - `Input` string
    - `SampleParameters` SampleParameters
      - `ExistingToken` string, nullable
      - `MarginOfError` number
      - `ConfidenceLevel` number
      - `FixedSampleSize` integer
      - `SamplingPercentage` number
    - `IncludeIDWindow` boolean, nullable
    - `RankSortOrder` 'Ascending' | 'Descending', nullable
    - `QueryHint` string
    - `Fields` FieldRef[]
      - `ViewFieldID` integer
      - `ArtifactID` integer
      - `Guid` string, nullable
      - `Name` string
    - `IsAdhocQuery` boolean, nullable
    - `ConvertNumberFieldValuesToStr` boolean, nullable
    - `IncludeNameInQueryResult` boolean, nullable
    - `ExecutingSavedSearchID` integer, nullable
    - `ExecutingViewID` integer, nullable
    - `ActiveArtifactID` integer, nullable
    - `MaxCharactersForLongTextValues` integer, nullable
    - `LongTextBehavior` 'Default' | 'Tokenized' | 'DefaultWithErrors' | 'TokenizedWithErrors'
  - `start` integer
  - `length` integer

## Response `200`

Successful Operation

- QueryResult
  - `TotalCount` integer
  - `Objects` RelativityObject[]
    - `ParentObject` RelativityObjectRef
      - `ArtifactID` integer
      - `Guid` string, nullable
    - `Name` string
    - `FieldValues` FieldValuePair[]
      - `Value` Object
      - `Field` Field
        - `FieldCategory` 'Generic' | 'FullText' | 'Identifier' | 'Reflected' | 'Comments' | 'Relational' | 'ProductionMarker' | 'AutoCreate' | 'FileSize' | 'FolderName' | 'FileInfo' | 'ParentArtifact' | 'MarkupSetMarker' | 'GenericSystem' | 'MultiReflected' | 'Batch'
        - `FieldType` 'FixedLengthText' | 'WholeNumber' | 'Date' | 'YesNo' | 'LongText' | 'SingleChoice' | 'Decimal' | 'Currency' | 'MultipleChoice' | 'File' | 'SingleObject' | 'User' | 'MultipleObject' | 'Empty'
        - `ViewFieldID` integer
        - `ArtifactID` integer
        - `Guids` string[]
        - `Name` string
    - `ArtifactID` integer
    - `Guids` string[]
    - `Item` FieldValuePair
      - `Value` Object
      - `Field` Field
        - `FieldCategory` 'Generic' | 'FullText' | 'Identifier' | 'Reflected' | 'Comments' | 'Relational' | 'ProductionMarker' | 'AutoCreate' | 'FileSize' | 'FolderName' | 'FileInfo' | 'ParentArtifact' | 'MarkupSetMarker' | 'GenericSystem' | 'MultiReflected' | 'Batch'
        - `FieldType` 'FixedLengthText' | 'WholeNumber' | 'Date' | 'YesNo' | 'LongText' | 'SingleChoice' | 'Decimal' | 'Currency' | 'MultipleChoice' | 'File' | 'SingleObject' | 'User' | 'MultipleObject' | 'Empty'
        - `ViewFieldID` integer
        - `ArtifactID` integer
        - `Guids` string[]
        - `Name` string
  - `IDWindow` integer[]
  - `CurrentStartIndex` integer
  - `ResultCount` integer
  - `ObjectType` ObjectType
    - `ArtifactID` integer
    - `Name` string
    - `Guids` string[]
    - `ArtifactTypeID` integer
  - `SampleDetails` SampleDetails
    - `SampleSize` integer, nullable
    - `UniverseSize` integer, nullable
    - `Token` string
  - `RankWindow` number[]
  - `RelationalField` Field
    - `FieldCategory` 'Generic' | 'FullText' | 'Identifier' | 'Reflected' | 'Comments' | 'Relational' | 'ProductionMarker' | 'AutoCreate' | 'FileSize' | 'FolderName' | 'FileInfo' | 'ParentArtifact' | 'MarkupSetMarker' | 'GenericSystem' | 'MultiReflected' | 'Batch'
    - `FieldType` 'FixedLengthText' | 'WholeNumber' | 'Date' | 'YesNo' | 'LongText' | 'SingleChoice' | 'Decimal' | 'Currency' | 'MultipleChoice' | 'File' | 'SingleObject' | 'User' | 'MultipleObject' | 'Empty'
    - `ViewFieldID` integer
    - `ArtifactID` integer
    - `Guids` string[]
    - `Name` string

---

[API](https://skmtc.dev/relativity/apis/relativity-audit-services-interfaces-v1.md) - [All operations](https://skmtc.dev/relativity/apis/relativity-audit-services-interfaces-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/relativity/apis/relativity-audit-services-interfaces-v1/revisions/20c660b3f99a?raw)