Adds missing Update Timeline & Timeline template API docs #3692
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,385 @@ | ||||||
| [[timeline-template-api-update]] | ||||||
| === Update Timeline or Timeline template | ||||||
|
|
||||||
| Updates an existing Timeline or Timeline template. | ||||||
|
|
||||||
| Use the `timeline` object's <<timeline-object-typeField, `timelineType`>> field | ||||||
| to specify whether you're updating a Timeline or a Timeline template: | ||||||
|
|
||||||
| * `"timelineType": "default"` updates an existing Timeline | ||||||
| * `"timelineType": "template"` updates an existing Timeline template | ||||||
|
|
||||||
| ==== Request URL | ||||||
|
|
||||||
| `PATCH <kibana host>:<port>/api/timeline` | ||||||
|
|
||||||
| ==== Request body | ||||||
|
|
||||||
| A JSON object defining the Timeline or Timeline template query and time filter. | ||||||
|
|
||||||
| NOTE: For detailed information about the Timeline object schema and its | ||||||
| corresponding UI components, refer to <<timeline-object-schema>>. | ||||||
|
|
||||||
| [width="100%",options="header"] | ||||||
| |============================================== | ||||||
| |Name |Type |Description |Required | ||||||
|
|
||||||
| |`timeline` |<<timeline-object-schema, timeline>> a|The timeline object, which | ||||||
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| defines the search criteria and time range. | ||||||
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| If you're updating a Timeline template, provide these fields so you can | ||||||
| easily <<timeline-api-import, import template>> updates: | ||||||
|
|
||||||
| * `templateTimelineId`: Use the unique identifier (UUID) of the Timeline template that you're updating. | ||||||
| * `templateTimelineVersion`: Specify a new version number for the template. It must be greater than the existing version number. | ||||||
|
|
||||||
| |Yes | ||||||
| |`timelineId` |String |The `savedObjectId` of the Timeline that you're updating. | ||||||
| |Yes | ||||||
| |`version` |String |The version of the Timeline that you're updating. | ||||||
| |Yes | ||||||
| |============================================== | ||||||
|
|
||||||
| ===== Example requests | ||||||
|
|
||||||
| *Example 1* | ||||||
|
|
||||||
| Updates an existing Timeline. | ||||||
|
|
||||||
| [source,console] | ||||||
| -------------------------------------------------- | ||||||
| PATCH api/timeline | ||||||
| { | ||||||
| "timeline": { | ||||||
| "columns": [ | ||||||
| { | ||||||
| "columnHeaderType": "not-filtered", | ||||||
| "id": "@timestamp" | ||||||
| }, | ||||||
| { | ||||||
| "columnHeaderType": "not-filtered", | ||||||
| "id": "message" | ||||||
| }, | ||||||
| { | ||||||
| "columnHeaderType": "not-filtered", | ||||||
| "id": "event.category" | ||||||
| }, | ||||||
| { | ||||||
| "columnHeaderType": "not-filtered", | ||||||
| "id": "event.action" | ||||||
| }, | ||||||
| { | ||||||
| "columnHeaderType": "not-filtered", | ||||||
| "id": "host.name" | ||||||
| }, | ||||||
| { | ||||||
| "columnHeaderType": "not-filtered", | ||||||
| "id": "source.ip" | ||||||
| }, | ||||||
| { | ||||||
| "columnHeaderType": "not-filtered", | ||||||
| "id": "destination.ip" | ||||||
| }, | ||||||
| { | ||||||
| "columnHeaderType": "not-filtered", | ||||||
| "id": "user.name" | ||||||
| } | ||||||
| ], | ||||||
| "dataProviders": [], | ||||||
| "description": "", | ||||||
| "eventType": "all", | ||||||
| "filters": [], | ||||||
| "kqlMode": "filter", | ||||||
| "kqlQuery": { | ||||||
| "filterQuery": null | ||||||
| }, | ||||||
| "title": "abd", | ||||||
| "dateRange": { | ||||||
| "start": 1587370079200, | ||||||
| "end": 1587456479201 | ||||||
| }, | ||||||
| "savedQueryId": null, | ||||||
| "sort": { | ||||||
| "columnId": "@timestamp", | ||||||
| "sortDirection": "desc" | ||||||
| }, | ||||||
| "created": 1587468588922, | ||||||
| "createdBy": "casetester", | ||||||
| "updated": 1587468588922, | ||||||
| "updatedBy": "casetester", | ||||||
| "timelineType": "default" | ||||||
| }, | ||||||
| "timelineId": "4bc294e0-3516-11ee-9f62-49614d8a84fd", <1> | ||||||
| "version": "WzE5MTUsMV0=" <2> | ||||||
| } | ||||||
| -------------------------------------------------- | ||||||
|
|
||||||
| <1> `timelineId` must match the existing Timeline's `savedObjectId`. | ||||||
| <2> `version` must match the existing Timeline version. | ||||||
|
||||||
| <2> `version` must match the existing Timeline version. | |
| <2> `version` must match the version of the Timeline that you're updating. |
Contributor
There was a problem hiding this comment.
For example, you want to update the title of an existing timeline
{
"timeline": {
....
"title": "abd",
....
},
"timelineId": "4bc294e0-3516-11ee-9f62-49614d8a84fd",
"version": "WzE5MTUsMV0="
}
In your request, just leave timelineId and version as it is and update the title to the new value.
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.