Skip to content

Commit

Permalink
#11 WIP add docs for case attachments and merge
Browse files Browse the repository at this point in the history
  • Loading branch information
nadouani committed Sep 21, 2021
1 parent 6d09712 commit 3454786
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/thehive/api/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav:
- 'custom-field'
- 'case-template'
- 'alert'
# - 'case'
- 'case'
- 'task'
- 'observable'
- 'search'
Expand Down
2 changes: 1 addition & 1 deletion docs/thehive/api/case/attachments.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ With:
- `401`: Authentication error
- `404`: if the *Case* is not found

### ResponseBody Example
### Response Body Example

!!! Example ""

Expand Down
64 changes: 56 additions & 8 deletions docs/thehive/api/case/merge.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,69 @@
# Merge

Merge two *Cases* in a single *Case*. This APIs permanently removes the source *Cases* and creates a *Case* by merging all the data from the sources.

## Query

```plain
POST /api/v0/case/{id1}/_merge/{id2}
```

```
with:

- `id1`: id of the first *Case*
- `id2`: id of the second *Case*

## Request Body Example
## Response

```json
### Status codes

```
- `204`: if the *Cases* are merged successfully
- `401`: Authentication error
- `404`: if at least one of the *Cases* is not found


## ResponseBody Example
### Response Body Example

```json

```
{
"_id": "~81928240",
"id": "~81928240",
"createdBy": "[email protected]",
"updatedBy": null,
"createdAt": 1632132365250,
"updatedAt": null,
"_type": "case",
"caseId": 87,
"title": "Case 1 / Case 2",
"description": "test\n\ntest",
"severity": 2,
"startDate": 1632124020000,
"endDate": null,
"impactStatus": null,
"resolutionStatus": null,
"tags": [],
"flag": false,
"tlp": 2,
"pap": 2,
"status": "Open",
"summary": null,
"owner": "[email protected]",
"customFields": {},
"stats": {},
"permissions": [
"manageShare",
"manageAnalyse",
"manageTask",
"manageCaseTemplate",
"manageCase",
"manageUser",
"manageProcedure",
"managePage",
"manageObservable",
"manageTag",
"manageConfig",
"manageAlert",
"accessTheHiveFS",
"manageAction"
]
}
```

0 comments on commit 3454786

Please sign in to comment.