Relativity
App · 25 actions
Work with RelativityOne e-discovery: find and code documents, run saved searches, manage matters, folders and productions, and start workflows when a workspace, document or production arrives or a production finishes.
Actions
| Action | What it does |
|---|---|
| Create folder | Create a folder in a workspace, at the top or inside another folder. |
| Create matter | Create a matter under a client, Active unless another status is picked, and return it. |
| Create production | Create a production set numbered page by page with a Bates prefix. |
| Delete matter | Delete a matter. |
| Delete production | Delete a production set. |
| Get document | Get one document's identifier and the fields asked for, such as its custodian, coding or extracted text. |
| Get matter | Get one matter with its number, client, status, keywords and notes. |
| Get production | Get one production with its status, Bates range, numbering and counts. |
| Get production status | Get where a production's job is: its status, how far imaging and producing have got, and any errors. |
| Get workspace | Get one workspace with its matter, status, keywords and notes, and how many documents it holds. |
| List clients | List the clients matters are filed under, newest first. |
| List folders | List a workspace's folders, newest first, each with its parent folder. |
| List group members | List the users in a group with their full name and email address. |
| List groups | List user groups, newest first. |
| List matters | List matters, newest first, by name or a condition. |
| List object types | List a workspace's object types, such as custodians or the types an installed application adds. |
| List productions | List a workspace's productions with their status, Bates range and counts, or only those with one status. |
| List saved searches | List a workspace's saved searches, newest first. |
| List users | List Relativity users with their full name and email address, newest first, by name or a condition. |
| List workspaces | List the workspaces the OAuth2 client's user can see, newest first, by name or a condition. |
| Query documents | Find a workspace's documents matching a condition, with the fields asked for, newest first or sorted by a field. |
| Query objects | Find the objects of one type in a workspace, such as custodians or Legal Hold projects, by a condition, with the fields asked for. |
| Run saved search | Get the documents a saved search returns now, with the fields asked for. |
| Stage and run production | Start a production: stage it and run it, only stage it, or run one already staged. |
| Update document fields | Set field values on a document, such as coding a yes/no field or filling in a text field. |
Create folder
Create a folder in a workspace, at the top or inside another folder.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Name
nametextRequired - The new folder's name.
- Inside folder
parent_folder_idtext - The folder to create it in. At the top of the workspace when left empty.
Outputs
folderobject- The new folder
Example output
{
"folder": {
"artifact_id": 1039180,
"name": "Hot documents",
"parent_id": 1003697
}
}Create matter
Create a matter under a client, Active unless another status is picked, and return it.
Inputs
- Name
nametextRequired - The matter's name.
- Client
client_idtextRequired - The client the matter is for. Pick one, or give its artifact ID.
- Status
status_idtext - The matter's status. Active when left empty.
- Matter number
numbertext - Your number for the matter, such as 2026-0042.
- Keywords
keywordstext - Keywords to find the matter by.
- Notes
notestext - Notes about the matter.
Outputs
matterobject- The new matter
Example output
{
"matter": {
"artifact_id": 1016411,
"client_id": 1006066,
"client_name": "Acme Corp",
"created_on": "2026-03-01T15:04:05.123",
"keywords": "",
"last_modified_on": "2026-03-01T15:04:05.123",
"name": "Smith v. Acme",
"notes": "",
"number": "2026-0042",
"status_id": 671,
"status_name": "Active"
}
}Create production
Create a production set numbered page by page with a Bates prefix. Add its documents (a data source) in Relativity before staging it.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Name
nametextRequired - The production's name, such as Volume 001.
- Bates prefix
bates_prefixtextRequired - The text before each Bates number, such as ACME.
- Bates suffix
bates_suffixtext - Text after each Bates number, if any.
- Start number
start_numbernumber - The first Bates number. Defaults to 1.At least 0.
- Number of digits
number_of_digitsnumber - How many digits each Bates number has, padded with zeros. Defaults to 7.From 1 to 20.
- Placeholder image format
placeholder_formattext - The image format of placeholders. Defaults to TIFF.One of:
Tiff(TIFF (default)),Jpeg. Default:Tiff. - Email when done
email_recipientstext - Email addresses Relativity tells when the production finishes, separated by semicolons.
- Keywords
keywordstext - Keywords to find the production by.
- Notes
notestext - Notes about the production.
Outputs
productionobject- The new production
Example output
{
"production": {
"bates_prefix": "ACME",
"date_produced": null,
"first_bates_value": null,
"keywords": "",
"last_bates_value": null,
"last_run_error": null,
"last_run_status": null,
"name": "Volume 001",
"notes": "",
"numbering_type": "PageLevel",
"production_id": 1048147,
"status": "New",
"total_document_count": 0,
"total_images_count": 0
}
}Delete matter
Delete a matter. Relativity refuses while a workspace still belongs to it.
Inputs
- Matter
matter_idtextRequired - The matter. Pick one, or give its artifact ID.
Outputs
deletedtrue/false- True once the matter is deleted
matter_idnumber- The deleted matter's artifact ID
Example output
{
"deleted": true,
"matter_id": 1016411
}Delete production
Delete a production set. Its documents stay in the workspace.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Production
production_idtextRequired - The production. Pick one, or give its artifact ID.
Outputs
deletedtrue/false- True once the production is deleted
production_idnumber- The deleted production's artifact ID
Example output
{
"deleted": true,
"production_id": 1048147
}Get document
Get one document's identifier and the fields asked for, such as its custodian, coding or extracted text.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Document ID
document_idtextRequired - The document's artifact ID, from 'Query documents', a saved search or a trigger.
- Fields to return
fieldslist - The fields to read for each record, by their names in Relativity, such as Custodian or Email Subject. Each record's name and artifact ID come back without naming them.
Outputs
documentobject- The document
Example output
{
"document": {
"artifact_id": 1038295,
"fields": {
"Custodian": "Jane Doe",
"Email Subject": "Q3 plan"
},
"name": "ACME0000001",
"parent_id": 1003663
}
}Get matter
Get one matter with its number, client, status, keywords and notes.
Inputs
- Matter
matter_idtextRequired - The matter. Pick one, or give its artifact ID.
Outputs
matterobject- The matter
Example output
{
"matter": {
"artifact_id": 1016411,
"client_id": 1006066,
"client_name": "Acme Corp",
"created_on": "2026-03-01T15:04:05.123",
"keywords": "",
"last_modified_on": "2026-03-01T15:04:05.123",
"name": "Smith v. Acme",
"notes": "",
"number": "2026-0042",
"status_id": 671,
"status_name": "Active"
}
}Get production
Get one production with its status, Bates range, numbering and counts.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Production
production_idtextRequired - The production. Pick one, or give its artifact ID.
Outputs
productionobject- The production
Example output
{
"production": {
"bates_prefix": "ACME",
"date_produced": "2026-03-02T19:23:40.233",
"first_bates_value": "ACME0000001",
"keywords": "",
"last_bates_value": "ACME0000021",
"last_run_error": null,
"last_run_status": "Completed",
"name": "Volume 001",
"notes": "",
"numbering_type": "PageLevel",
"production_id": 1048147,
"status": "Produced",
"total_document_count": 7,
"total_images_count": 21
}
}Get production status
Get where a production's job is: its status, how far imaging and producing have got, and any errors.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Production
production_idtextRequired - The production. Pick one, or give its artifact ID.
Outputs
branding_errorslist- Up to 10 branding errors
job_statustext- The job: NotRunning, Running, Errored or Complete
last_run_errortext- The last run's error, if any
last_run_statustext- What the last run reported
number_of_branding_errorsnumber- How many images failed branding
percentage_imagingnumber- How far imaging has got, in percent
percentage_producingnumber- How far producing has got, in percent
production_idnumber- The production's artifact ID
statustext- Its status, such as Producing or Produced
Example output
{
"branding_errors": [],
"job_status": "Running",
"last_run_error": null,
"last_run_status": null,
"number_of_branding_errors": 0,
"percentage_imaging": 100.0,
"percentage_producing": 42.5,
"production_id": 1048147,
"status": "Producing"
}Get workspace
Get one workspace with its matter, status, keywords and notes, and how many documents it holds.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
Outputs
workspaceobject- The workspace
Example output
{
"workspace": {
"artifact_id": 1017266,
"document_count": 73973,
"download_handler_url": "Relativity.Distributed",
"enable_data_grid": false,
"file_size_bytes": 1048576,
"keywords": "",
"matter_id": 1016411,
"name": "Smith v. Acme",
"notes": "",
"status_id": 675
}
}List clients
List the clients matters are filed under, newest first. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name contains
nametext - Only clients whose name contains this text.
- Fields to return
fieldslist - The fields to read for each record, by their names in Relativity, such as Custodian or Email Subject. Each record's name and artifact ID come back without naming them.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
clientslist- The clients found
countnumber- How many are on this page
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
total_countnumber- How many match in all
Example output
{
"clients": [
{
"artifact_id": 1006066,
"fields": {},
"name": "Acme Corp",
"parent_id": 1003663
}
],
"count": 1,
"next_page": 0,
"page": 1,
"total_count": 1
}List folders
List a workspace's folders, newest first, each with its parent folder. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Name contains
nametext - Only folders whose name contains this text.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
folderslist- The folders found
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
total_countnumber- How many match in all
Example output
{
"count": 1,
"folders": [
{
"artifact_id": 1039027,
"fields": {},
"name": "Custodian Jane Doe",
"parent_id": 1003663
}
],
"next_page": 0,
"page": 1,
"total_count": 1
}List group members
List the users in a group with their full name and email address. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Group
group_idtextRequired - The group. Pick one, or give its artifact ID.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
group_idnumber- The group's artifact ID
memberslist- The group's users
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
total_countnumber- How many match in all
Example output
{
"count": 1,
"group_id": 1015005,
"members": [
{
"artifact_id": 1015300,
"email": "jane@example.com",
"full_name": "Doe, Jane"
}
],
"next_page": 0,
"page": 1,
"total_count": 1
}List groups
List user groups, newest first. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name contains
nametext - Only groups whose name contains this text.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
groupslist- The groups found
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
total_countnumber- How many match in all
Example output
{
"count": 1,
"groups": [
{
"artifact_id": 1015005,
"fields": {},
"name": "Review Team",
"parent_id": 1003663
}
],
"next_page": 0,
"page": 1,
"total_count": 1
}List matters
List matters, newest first, by name or a condition. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name contains
nametext - Only matters whose name contains this text.
- Condition
conditiontext - Only records matching this Relativity condition, written as in Relativity's Object Manager: field names in single quotes, such as 'Custodian' == 'Jane Doe' AND 'Date Sent' >= 2024-01-01T00:00:00.00Z.
- Fields to return
fieldslist - The fields to read for each record, by their names in Relativity, such as Custodian or Email Subject. Each record's name and artifact ID come back without naming them.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
matterslist- The matters found
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
total_countnumber- How many match in all
Example output
{
"count": 1,
"matters": [
{
"artifact_id": 1016411,
"fields": {},
"name": "Smith v. Acme",
"parent_id": 1003663
}
],
"next_page": 0,
"page": 1,
"total_count": 1
}List object types
List a workspace's object types, such as custodians or the types an installed application adds. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Name contains
nametext - Only object types whose name contains this text.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page to ask for, or 0 when this was the last
object_typeslist- The object types found
pagenumber- The page returned, from 1
total_countnumber- How many match in all
Example output
{
"count": 1,
"next_page": 0,
"object_types": [
{
"artifact_id": 1039410,
"fields": {},
"name": "Custodian",
"parent_id": 1003663
}
],
"page": 1,
"total_count": 1
}List productions
List a workspace's productions with their status, Bates range and counts, or only those with one status.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Status
statustext - Only productions with this status, such as Produced or Staged.
Outputs
countnumber- How many productions were returned
productionslist- The productions
Example output
{
"count": 1,
"productions": [
{
"bates_prefix": "ACME",
"date_produced": "2026-03-02T19:23:40.233",
"first_bates_value": "ACME0000001",
"keywords": "",
"last_bates_value": "ACME0000021",
"last_run_error": null,
"last_run_status": "Completed",
"name": "Volume 001",
"notes": "",
"numbering_type": "PageLevel",
"production_id": 1048147,
"status": "Produced",
"total_document_count": 7,
"total_images_count": 21
}
]
}List saved searches
List a workspace's saved searches, newest first. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Name contains
nametext - Only saved searches whose name contains this text.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
saved_searcheslist- The saved searchs found
total_countnumber- How many match in all
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"saved_searches": [
{
"artifact_id": 1039005,
"fields": {},
"name": "Responsive, not privileged",
"parent_id": 1003663
}
],
"total_count": 1
}List users
List Relativity users with their full name and email address, newest first, by name or a condition. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name contains
nametext - Only users whose full name contains this text.
- Condition
conditiontext - Only records matching this Relativity condition, written as in Relativity's Object Manager: field names in single quotes, such as 'Custodian' == 'Jane Doe' AND 'Date Sent' >= 2024-01-01T00:00:00.00Z.
- Fields to return
fieldslist - The fields to read for each record, by their names in Relativity, such as Custodian or Email Subject. Each record's name and artifact ID come back without naming them.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
total_countnumber- How many match in all
userslist- The users found
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"total_count": 1,
"users": [
{
"artifact_id": 1015300,
"fields": {
"E-mail Address": "jane@example.com",
"Full Name": "Doe, Jane"
},
"name": "Doe, Jane",
"parent_id": 1003663
}
]
}List workspaces
List the workspaces the OAuth2 client's user can see, newest first, by name or a condition. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name contains
nametext - Only workspaces whose name contains this text.
- Condition
conditiontext - Only records matching this Relativity condition, written as in Relativity's Object Manager: field names in single quotes, such as 'Custodian' == 'Jane Doe' AND 'Date Sent' >= 2024-01-01T00:00:00.00Z.
- Fields to return
fieldslist - The fields to read for each record, by their names in Relativity, such as Custodian or Email Subject. Each record's name and artifact ID come back without naming them.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
total_countnumber- How many match in all
workspaceslist- The workspaces found
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"total_count": 1,
"workspaces": [
{
"artifact_id": 1017266,
"fields": {},
"name": "Smith v. Acme",
"parent_id": 1003663
}
]
}Query documents
Find a workspace's documents matching a condition, with the fields asked for, newest first or sorted by a field. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Condition
conditiontext - Only records matching this Relativity condition, written as in Relativity's Object Manager: field names in single quotes, such as 'Custodian' == 'Jane Doe' AND 'Date Sent' >= 2024-01-01T00:00:00.00Z.
- Fields to return
fieldslist - The fields to read for each record, by their names in Relativity, such as Custodian or Email Subject. Each record's name and artifact ID come back without naming them.
- Sort by field
sort_bytext - A field to sort by, by its name. Newest first when left empty.
- Sort direction
sort_directiontext - Which way to sort by that field. Defaults to oldest or lowest first.One of:
Descending(Newest or highest first),Ascending(Oldest or lowest first). Default:Ascending. - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
documentslist- The documents found
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
total_countnumber- How many match in all
Example output
{
"count": 1,
"documents": [
{
"artifact_id": 1038295,
"fields": {
"Custodian": "Jane Doe",
"Email Subject": "Q3 plan"
},
"name": "ACME0000001",
"parent_id": 1003663
}
],
"next_page": 0,
"page": 1,
"total_count": 1
}Query objects
Find the objects of one type in a workspace, such as custodians or Legal Hold projects, by a condition, with the fields asked for. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Object type
object_typetextRequired - The type of object. Pick one, or give its name.
- Condition
conditiontext - Only records matching this Relativity condition, written as in Relativity's Object Manager: field names in single quotes, such as 'Custodian' == 'Jane Doe' AND 'Date Sent' >= 2024-01-01T00:00:00.00Z.
- Fields to return
fieldslist - The fields to read for each record, by their names in Relativity, such as Custodian or Email Subject. Each record's name and artifact ID come back without naming them.
- Sort by field
sort_bytext - A field to sort by, by its name. Newest first when left empty.
- Sort direction
sort_directiontext - Which way to sort by that field. Defaults to oldest or lowest first.One of:
Descending(Newest or highest first),Ascending(Oldest or lowest first). Default:Ascending. - Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
next_pagenumber- The next page to ask for, or 0 when this was the last
object_typetext- The object type queried
objectslist- The objects found
pagenumber- The page returned, from 1
total_countnumber- How many match in all
Example output
{
"count": 1,
"next_page": 0,
"object_type": "Custodian",
"objects": [
{
"artifact_id": 1039500,
"fields": {
"Department": "Finance"
},
"name": "Jane Doe",
"parent_id": 1003663
}
],
"page": 1,
"total_count": 1
}Run saved search
Get the documents a saved search returns now, with the fields asked for. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Saved search
saved_search_idtextRequired - The saved search. Pick one, or give its artifact ID.
- Fields to return
fieldslist - The fields to read for each record, by their names in Relativity, such as Custodian or Email Subject. Each record's name and artifact ID come back without naming them.
- Page
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
- Page size
page_sizenumber - How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many are on this page
documentslist- The documents found
next_pagenumber- The next page to ask for, or 0 when this was the last
pagenumber- The page returned, from 1
saved_search_idnumber- The saved search's artifact ID
total_countnumber- How many match in all
Example output
{
"count": 1,
"documents": [
{
"artifact_id": 1038295,
"fields": {
"Custodian": "Jane Doe",
"Email Subject": "Q3 plan"
},
"name": "ACME0000001",
"parent_id": 1003663
}
],
"next_page": 0,
"page": 1,
"saved_search_id": 1039005,
"total_count": 1
}Stage and run production
Start a production: stage it and run it, only stage it, or run one already staged. Returns once Relativity has queued the job; use 'Get production status' or the 'Production produced' trigger to follow it.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Production
production_idtextRequired - The production. Pick one, or give its artifact ID.
- What to do
modetext - Stage then run, stage only, or run a staged production.One of:
stage_and_run(Stage, then run (default)),stage(Stage only),run(Run a production already staged). Default:stage_and_run. - Ignore warnings
suppress_warningstrue/false - When running a staged production, run it despite warnings.Only when What to do is Run a production already staged.
- Override conflicts
override_conflictstrue/false - When running a staged production, produce documents that conflict with another production anyway.Only when What to do is Run a production already staged.
Outputs
jobobject- The production job Relativity queued
modetext- What was started: stage_and_run, stage or run
Example output
{
"job": {
"errors": [],
"job_id": 52,
"messages": [],
"production_id": 1048147,
"warnings": [],
"was_job_created": true,
"workspace_id": 1017266
},
"mode": "stage_and_run"
}Update document fields
Set field values on a document, such as coding a yes/no field or filling in a text field. Relativity's event handlers still apply.
Inputs
- Workspace
workspace_idtextRequired - The workspace. Pick one, or give its artifact ID.
- Document ID
document_idtextRequired - The document's artifact ID, from 'Query documents', a saved search or a trigger.
- Field values
field_valuesobjectRequired - Each field to set, by its name in Relativity, with its new value: text, a number, true or false, a date such as 2026-03-01T00:00:00Z, or for a choice {"ArtifactID": 1039123}.
Outputs
document_idnumber- The document's artifact ID
fields_updatedlist- The fields set
updatedtrue/false- True once Relativity saved the values
Example output
{
"document_id": 1038295,
"fields_updated": [
"Responsive"
],
"updated": true
}