Description
Retrieve a single record.
Request
HTTP Method: GET
Parameter | Description |
---|---|
record_id | The ID of the record to retrieve. |
curl -X GET \
https://<<META.tenant.domain>>/api/v1/records/<<record_id>> \
-H 'content-type: application/json' \
-H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
Response
A successful request will return a JSON object representing the specified record.
Field description
Parameter | Description |
---|---|
id | The record ID. |
created_at | ISO 8601 Timestamp representing creation date and time of the record. |
story | The story the record was created from. |
story_run_guid | The story run guid the record 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_records | An array of objects containing the record IDs for which this record is the parent. |
parent_record | The ID of this record's parent record. |
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_records": [
{
"id": 9
}
],
"parent_record": {
"id": 66
}
}