Update A Property Of An Entity
To update the property of an existing entity, we need to make the following HTTP request
Update a property which is already added to entity
PUT
/api/v1/{entity-type}/{id}/{entity-property}/{property-id}
Path Parameters
Name
Type
Description
entity-type*
String
Type of entity to update
id*
String
id of the entity to update
entity-property*
String
entity Property which to be updated in already existing entity
property-id*
String
entity property osid which is to be updated in already existing property in entity
Headers
Name
Type
Description
content-type*
String
Set to application/json
authorization
String
Set to Bearer {access-token}
if roles in Schema is not anonymous. Else token can be empty
{
"id": "sunbird-rc.registry.update",
"ver": "1.0",
"ets": 1669113253859,
"params": {
"resmsgid": "",
"msgid": "129c291e-f089-4052-811f-025330c9b239",
"err": "",
"status": "SUCCESSFUL",
"errmsg": ""
},
"responseCode": "OK"
}
Usage
cURL
curl --location \
--request 'POST' \
--header 'content-type: application/json' \
--header 'authorization: bearer {access-token}' \
--data-raw '{
"city": "Surat"
}' \
'{registry-url}/api/v1/{entity-type}/{id}/{entity-property}/{property-id}'
HTTPie
printf '{
"city": "Surat"
}' | http POST \
'/api/v1/{entity-type}/{id}/{entity-property}/{property-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?