Update An Entity
To update an entity, we need to make the following HTTP request
Updating an Entity
PUT
/api/v1/{entity-type}/{id}
Path Parameters
Name
Type
Description
entity-type*
String
The type of entity to modify
id*
String
The ID of entity to modify
Headers
Name
Type
Description
authorization
String
Set to Bearer {access-token} if roles in schema is not anonymous. Else token can be empty
content-type*
String
Set to application/json
Request Body
Name
Type
Description
...*
String
The entity's data
{
"id": "sunbird-rc.registry.update",
"ver": "1.0",
"ets": 1634371946769,
"params": {
"resmsgid": "",
"msgid": "d51e6e6a-027d-4a42-84bb-2ce00e31d993",
"err": "",
"status": "SUCCESSFUL",
"errmsg": ""
},
"responseCode": "OK"
}
Usage
cURL
curl --location \
--request 'PUT' \
--header 'content-type: application/json' \
--header 'authorization: bearer {access-token}' \
--data-raw '{
"phoneNumber": "1234567891",
"school": "UP Public School",
"subject": "Math",
"name": "Pranav Agate",
}' \
'{registry-url}/api/v1/{entity-type}/{id}'
HTTPie
printf '{
"phoneNumber": "1234567891",
"school": "UP Public School",
"subject": "Math",
"name": "Pranav Agate",
}' | http put \
'{registry-url}/api/v1/{entity-type}/{id}' \
'content-type: application/json' \
'authorization: bearer {access-token}'
{registry-url}
is usually http://localhost:{port}. The port can be found under theregistry
section in thedocker-compose.yml
file and is usually8081
.
Last updated
Was this helpful?