Skip to content

docs: correct DELETE response status code [DHIS2-17360] #1770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
karolinelien wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: correct DELETE response status code [DHIS2-17360] #1770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9cb190f
docs: correct DELETE response status code [DHIS2-17360]
karolinelien Jun 29, 2026
6c7fb34
docs: fix aggregate data exchange DELETE status code [DHIS2-17360]
karolinelien Jun 30, 2026
29aea7b
docs: fix translations validation error status code [DHIS2-17360]
karolinelien Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/developer/web-api/data-exchange.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ DELETE /api/aggregateDataExchanges/{id}
##### Response

```
204 No Content
200 OK
```

```json
Expand Down
20 changes: 18 additions & 2 deletions src/developer/web-api/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ translations for the specific object and not just for a single locale
(if not you will potentially overwrite existing locales for other
locales).

The status code will be `204 No Content` if the data value was successfully saved or updated, or `404 Not Found` if there was a validation error (e.g. more than one `SHORT_NAME` for the same `locale`).
The status code will be `204 No Content` if the translations were successfully saved or updated, or `409 Conflict` if there was a validation error (e.g. more than one `SHORT_NAME` for the same `locale`).


### Web API versions { #webapi_api_versions }
Expand Down Expand Up @@ -638,7 +638,23 @@ request to the endpoint + id:
curl -X DELETE -u user:password "http://server/api/constants/ID"
```

A successful delete should return HTTP status 204 (no content).
A successful delete returns HTTP status `200 OK` with a `WebMessage`
response body wrapping an `ObjectReport` for the deleted object, for
example:

```json
{
"httpStatus": "OK",
"httpStatusCode": 200,
"status": "OK",
"response": {
"responseType": "ObjectReport",
"uid": "abc123",
"klass": "org.hisp.dhis.constant.Constant",
"errorReports": []
}
}
```

### Adding and removing objects in collections { #webapi_adding_removing_objects_collections }

Expand Down