Create An Entity
To create an entity, we need to make the following HTTP request
Request
Create a record for entity-type
POST
/api/v1/{entity-type}
Path Parameters
entity-type*
String
The type of entity to create
Query Parameters
mode
String
Query parameter whose value can be async
if creating an entity should be asynchronously handled
callbackUrl
String
Query parameter whose value will be a web-hook url
. The webook will be called once the entity is created in the registry. This is applicable only for async mode
Headers
content-type*
String
Set to application/json
authorization
String
Set to Bearer {access-token}
if roles
in schema config is not anonymous else this can be empty
Request Body
...*
The entity's data
Sample Request Body for Teacher as Entity-Type
Important Fields in Response Body
result.{entity-type}.osid
string
The ID of the create entity in the registry, used for retrieval and modification of the entity
Usage
So to create a Teacher
entity named Pranav Agate who teaches Math at UP Public School, we would make the following API call:
cURL
HTTPie
{registry-url}
is usually http://localhost:{port}. The port can be found under the registry
section in the docker-compose.yml
file and is usually 8081
Last updated