Get

Description

Retrieve a single record result set.

Request

HTTP Method: GET

Parameter Description
record_id The ID of the record result set to retrieve. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/records/<<record_id>> \
  -H 'content-type: application/json' \
  -H 'x-user-token: <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object representing the specified record result set.

Field description

Parameter Description
id The record result set ID.
created_at ISO 8601 Timestamp representing creation date and time of the record result set.
story The story the record result set was created from.
story_run_guid The story run guid the record result set was created from.
record_type The the type of record the result set was created for.
records The captured data for the given instance of the record type.
child_record_result_sets An array of objects containing the record result set IDs for which this record result is the parent.
parent_record_result_set The ID of this record result set's parent record result set.

Sample response

{
  "id": 59,
  "created_at": "2023-06-14T15:09:02Z",
  "story": {
    "id": 8,
    "name": "Create new IOC"
  },
  "story_run_guid": "82c8e2c8-ab56-49c9-bdb9-1ea5b7fd5b2e",
  "record_type": {
    "id": 1,
    "name": "Alert"
  },
  "records": [
    {
      "name": "Story name",
      "value": "Create new IOC"
    },
    {
      "name": "Timestamp",
      "value": "2023-06-14 16:09:02"
    },
    {
      "name": "Name",
      "value": "Example"
    }
  ],
  "child_record_result_sets": [
    {
      "id": 9
    }
  ],
  "parent_record_result_set": {
    "id": 66
  }
}
Was this helpful?