Create A Property Of An Entity
To add property to an existing entity, we need to make the following HTTP request
Create a property in already existing entity
POST
/api/v1/{entity-type}/{id}/{entity-property}
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 added in already existing entity
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
...*
Object
Property to be updated
{
"id": "sunbird-rc.registry.update",
"ver": "1.0",
"ets": 1669113170690,
"params": {
"resmsgid": "",
"msgid": "85057df5-d4d6-4e7b-8bb1-a774f689e9c8",
"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": "Ahmedabad"
}' \
'{registry-url}/api/v1/{entity-type}/{id}/{entity-property}'
HTTPie
printf '{
"city": "Ahmedabad"
}' | http POST \
'{registry-url}/api/v1/{entity-type}/{id}/{entity-property}' \
'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?