HOhome-office
entities

Request an update to the schema definition of a entity

Request updates to the definition of an existing data set (as a partial update).

A request can only be raised for one property of the entity's schema definition 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).

patch/v1/entities/{name}

Request

  • Base URL
    https://virtserver.swaggerhub.com/Viable-Data/Reference-Data-Service-API/0.0.1
  • Auth
    OAuth 2
    Authorization codehttps://sso-dev.notprod.homeoffice.gov.uk/auth/realms/cop-dev/protocol/openid-connect/auth
    Token URLhttps://sso-dev.notprod.homeoffice.gov.uk/auth/realms/cop-dev/protocol/openid-connect/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

The name of the entity.

Query parameters

fieldstring required
Example:name

The field that the change is being requested for.

propertystring required
Example:dataType

The property that the change is being requested for.

newValuestring required
Example:CHARACTER VARYING(50)

The new value being requested.

Response

Accepted

statusstring
codeinteger
typestring
detailstring

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.