Search Terms Report Services (REST)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
   "request":{
      "FieldValues":[
         {
            "Field":{
               "Name":"Name"
            },
            "Value":"test STR created from REST API"
         },
         {
            "Field":{
               "Name":"Index"
            },
            "Value":{
               "ArtifactID":1041994
            }
         },
         {
            "Field":{
               "Name":"Searchable set"
            },
            "Value":{
               "ArtifactID":1038051
            }
         },
         {
            "Field":{
               "Name":"Include Relational Group"
            },
            "Value":null
         },
         {
            "Field":{
               "Name":"Type"
            },
            "Value":{
               "ArtifactID":1035328
            }
         },
         {
            "Field":{
               "Name":"Calculate Unique Hits"
            },
            "Value":false
         },
         {
            "Field":{
               "Name":"Email Notification Recipients"
            },
            "Value":null
         },
         {
            "Field":{
               "Name":"Notes"
            },
            "Value":null
         },
         {
            "Field":{
               "Name":"Show In Field Tree"
            },
            "Value":true
         },
         {
            "Field":{
               "Name":"Remove Hidden Characters In Terms"
            },
            "Value":true
         }
      ],
      "ObjectType":{
         "Guid":"481E9ACF-368B-4341-B6B5-A21153AD9950"
      }
   }
}

This call uses Object Manager to create a Search Terms Report Object. Enter values for these fields as indicated below (you can refer to the Relativity User Documentation on creating a Search Terms Report for a detailed description of each field).

• Name
• Index is the ArtifactID of the dtSearch Index to use for the STR.
• Searchable set is the ArtifactID of a saved search.
• Include Relational Group is the ArtifactID of a relational group to include.
• Type should be set to the ArtifactID that represents “Report only” or “Report and tag”. Lookup these values using Get Report Type IDs
• Calculate Unique Hits - if set to true, includes a Unique hits value for each term in the search terms results.
• Email Notification Recipients specifies recipients to send an email notification to when your search terms report finishes running. Enter the email address(es) of the recipient(s). Separate entries with a semicolon.
• Notes are used to enter notes specific to the search terms report.
• Show in Field Tree - if set to true, automatically adds the terms to the field tree
• Remove Hidden Characters in Terms, if set to true, automatically filters out hidden or non-displayable text control characters when creating or editing terms for the Search Terms Report.
• ObjectType - enter the Guid for the STR Object Type “481E9ACF-368B-4341-B6B5-A21153AD9950”

• TermsToAdd - an array of terms to add.
• RelativityHighlightColor - a semicolon delimited string where the first number corresponds to the background color and second number is the text color based on this enumeration.
View enumeration
• Default = 0,
• Black = 1,
• DarkRed = 2,
• DarkGreen = 3,
• DarkYellow = 4,
• DarkBlue = 5,
• DarkMagenta = 6,
• DarkCyan = 7,
• LightGray = 8,
• Gray = 9,
• Red = 10,
• Green = 11,
• Yellow = 12,
• Blue = 13,
• Magenta = 14,
• Cyan = 15,
• White = 16,
• LightGreen = 17,
• LightBlue = 18,
• LightYellow = 19,
• LightPurple = 20,
• LightRed = 21,
• LightOrange = 22,
• Purple = 23,
• Orange = 24,
• DarkPurple = 25,
• DarkOrange = 26

• TermsAffected - the number of terms successfully created or updated.
• TermsSkippedAsDuplicated - the number of terms that were not created or updated because the term would duplicate an existing one.
• TermsSkippedForLength - the number of terms that were not created or updated because the text length of the term exceeded the maximum character count of 450.
• TermsSkippedAsErrors - the number of terms that were not created or updated because errors occurred while executing operations on them.

The body of a request must contain an updateRequest object with the following fields:

• UpdatedTerms - an array of SearchTermsResultsTermUpdatedTerm objects containing the following fields:
  • ArtifactID - the ArtifactID of the term to update.
  • Newterm - the new name of the term.
• RelativityHighlightColor - a semicolon delimited string where the first number corresponds to the background color and second number is the text color based on this enumeration.
View enumeration
• Default = 0,
• Black = 1,
• DarkRed = 2,
• DarkGreen = 3,
• DarkYellow = 4,
• DarkBlue = 5,
• DarkMagenta = 6,
• DarkCyan = 7,
• LightGray = 8,
• Gray = 9,
• Red = 10,
• Green = 11,
• Yellow = 12,
• Blue = 13,
• Magenta = 14,
• Cyan = 15,
• White = 16,
• LightGreen = 17,
• LightBlue = 18,
• LightYellow = 19,
• LightPurple = 20,
• LightRed = 21,
• LightOrange = 22,
• Purple = 23,
• Orange = 24,
• DarkPurple = 25,
• DarkOrange = 26

• TermsCompleted - the number of terms with a Completed status.
• TermsPending - the number of terms with a Pending status.
• TermsError - the number of terms with an Error status.
• TermsNew - the number of terms added since last run.
• TermsTotal - the total number of terms.
• TotalDocumentsWithHits - the total number of unique documents containing at least one term.
• TotalDocumentsWithHitsIncludingGroup - the total number of unique documents or relational documents containing at least one term.
• DocumentsInSearchableSet - the total number of documents in selected searchable set.
• TimeElapsedInSeconds - the time elapsed in seconds for the current job.
• Status - the status of the search terms report.
• JobType - one of the following type of jobs:
  • Run All Terms - the job runs against all available search terms.
  • Run Pending Terms - the job runs against terms not yet processed.
  • Resolve Alerts - the job runs against all terms with an Error status.

The response contains the following fields:

• SearchTermsReportObjectTypeID - the Object Type ID of the Search Terms Report object.
• SearchTermsResultObjectTypeID - the Object Type ID of the Search Terms Report Result object.

The response contains the following fields:

• Report only - the Artifact ID of the report.
• Report and tag - the Artifact ID of the report and tag.