Skip to main content
POST
Send an API result to a user

Authorizations

x-api-key
string
header
required

The Minerva API key used for this integration. Manage API keys in the Minerva dashboard under Administration > Developers.

Body

application/json
jobId
string
required

The unique ID of the job the result ran under. This is the same ID used to query the API result through the Search Status API, and it also appears in the Search Status API response body.

Maximum string length: 36
Example:

"job-id-of-api-result"

requestId
string
required

The unique ID of the request the result ran under. Each result in a Search Status API batch carries an id that uniquely identifies that result within the job.

Maximum string length: 36
Example:

"request-id-of-api-result"

investigationId
string

If an earlier call to /sendAPIResultToUser created an investigation, provide its investigationId to assign the result to it. Provide either investigationName or investigationId.

Maximum string length: 36
Example:

"existing-investigation-id"

investigationName
string

The plain text label of the investigation this result belongs under. If the label does not exist in the user's investigation list, Minerva creates it; otherwise the investigation matching the label receives the result. The investigation date matches the date the API result was generated. Use a label that is easy for the receiving investigator to identify, such as a date or specific batch metadata.

Maximum string length: 1024
Example:

"My Investigation Name"

userEmail
string

The email address of the user who should receive the API result in one of their investigation bins. If omitted, the result is assigned to the requesting user.

Maximum string length: 256
Example:

"user@myorganization.com"

Response

API result successfully cloned into user investigation.

investigationId
string

The unique identifier of the investigation that contains the API result.

Example:

"unique-id-of-the-investigation"

status
integer
Example:

200

message
string
Example:

"API result successfully cloned into user investigation."

code
string
Example:

"success"