1. API
  2. Records

Records: Update

Last updated Open markdown version

Description

Updates a single record.

See the Get Records API to learn more about records.

Request

HTTP Method: PUT

Path parameter Description
record_id The ID of the record to update.
Query parameter Description
resolve_artifacts Optional Set to the string "false" to have Artifacts (large text) fields in the response return a reference object containing the artifact ID instead of the full contents. Defaults to inlining the contents. See the Get Records API for the reference-object shape.
include_children Optional Set to the string "false" to omit child records from the response, or "true" for full field data. Defaults to including child records with their full field data.
Body parameter Description
add_child_records Optional An array of record IDs to be added to the record as child records. If a record already belongs to another parent, it will be moved to the new parent (the previous parent-child relationship is removed). Adding a child record that would create a circular dependency (e.g. A is a child of B which is a child of A) will fail with a validation error.
remove_child_records Optional An array of record IDs to remove from the record as child records.
add_case_ids Optional An array of case IDs to be linked to the record. At most 5 per request.
remove_case_ids Optional An array of case IDs to be unlinked from the record. At most 5 per request.
field_values Optional An array of { field_id, value } objects. Only works if the record's record type has editable: true; otherwise the request fails with 422 and body ["Record is not editable"].

Sample request

curl -X PUT \
  "https://<tenant-domain>/api/v1/records/<<record_id>>?resolve_artifacts=false&include_children=false" \
  -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_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 when the record was created.
updated_at ISO 8601 timestamp representing when the record was last updated.
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.
records The captured data for the given instance of the record type.
child_records An array of objects containing child record data. See the Get Records API for details.
child_records_truncated true when the child records list was capped. Only present when truncation occurred; otherwise absent from the response.
case_ids The case IDs linked to this record.
result The captured data in key-value format.

Sample response

{
  "id": 59,
  "created_at": "2023-06-14T15:09:02Z",
  "updated_at": "2023-06-14T15:10:32Z",
  "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"
    }
  ],
  "case_ids": [14, 19],
  "result": {
    "id": 59,
    "Record ID": 59,
    "updated_at": "2023-06-14T15:10:32Z",
    "case_ids": [14, 19],
    "Story name": "Create new IOC",
    "Timestamp": "2023-06-14 16:09:02",
    "Name": "Example"
  }
}
Was this helpful?