entities
Adds a new item to the entity
Request the addition of an item to an existing data set.
A request can only be raised for one item at a time.
In a future version of the API, the response will include a link to the resulting request resource (but this isn't implemented yet).
post/v1/entities/{name}
Request
- Base URLhttps://virtserver.swaggerhub.com/Viable-Data/Reference-Data-Service-API/0.0.1
- AuthOAuth 2Authorization codehttps://sso-dev.notprod.homeoffice.gov.uk/auth/realms/cop-dev/protocol/openid-connect/authToken URLhttps://sso-dev.notprod.homeoffice.gov.uk/auth/realms/cop-dev/protocol/openid-connect/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
namestring required
The name of the entity that the item is to be added to.
Request body
Item required
Example request
{
"id": 78,
"iso31661alpha2": "FJ",
"iso31661alpha3": "FJI",
"name": "Fiji",
"continent": "OC",
"dial": 679,
"iso31661numeric": 242,
"validfrom": "10/03/2019",
"validto": null
}Response
Accepted
Example response
{
"status": "success",
"code": 202,
"type": "accepted",
"detail": "The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place."
}Changes
No recorded changes to this operation across all 1 revision of this API.