Update

Description

Updates a single record.

Request

HTTP Method: PUT

Parameter Description
add_child_records Optional An array of record IDs to be added to the record as child records
remove_child_records Optional An array of record IDs to remove from the record as child records
add_team_case_ids Optional An array of case IDs to be linked to the record
remove_team_case_ids Optional An array of case IDs to be unlinked from the record
field_values Optional An array of objects. Each object should contain a field_id of the field you wish to update and a value for the updated value.
Field values Description
field_id The ID of the field you wish to update.
value The value to update the field with.
Path Parameter Description
record_id The ID of the record to update.

Sample request

curl -X PUT \
  https://<<META.tenant.domain>>/api/v1/records/<<record_id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
    "add_child_records": ["1"],
    "field_values": [{"field_id":"285","value":"true"}],
    "add_team_case_ids": ["14","19"]
  }'

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 the 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 type of record the record 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.
case_ids The case IDs linked to this record.

A successful request will return a JSON object describing the updated 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": [
    {
      "field_id": "36",
      "name": "Story name",
      "value": "Create new IOC"
    },
    {
      "field_id": "37",
      "name": "Timestamp",
      "value": "2023-06-14 16:09:02"
    },
    {
      "field_id": "38",
      "name": "Name",
      "value": "Example"
    }
  ],
  "child_records": [
    {
      "id": 9,
      "records": [
        {
          "field_id": "39",
          "name": "Story name",
          "value": "Create new IOC"
        },
        {
          "field_id": "40",
          "name": "Timestamp",
          "value": "2023-06-14 16:09:02"
        },
        {
          "field_id": "41",
          "name": "Name",
          "value": "Example"
        }
      ]
    }
  ],
  "case_ids": [14, 19]
}
Was this helpful?