Entity Tag
This endpoint retrieves all the tags of an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
GET /api/entities/{entityId}/tags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"success": true,
"data": {
"tagId": "tag-121",
"tagName": "super-tag",
"description": "This is our tag",
"tagUsers": [
"user-11",
"user-33"
],
"isPrivate": false
}
}
This endpoint allows to add a tag for an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
tag-101
This is our new tag
POST /api/entities/{entityId}/tags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"tagName": "tag-101",
"description": "This is our new tag"
}
{
"success": true,
"data": {
"tagId": "tag-100",
"entityId": "entity-101",
"tagName": "tag-101",
"description": "This is our new tag"
}
}
This endpoint allows to update a tag for an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
tag-101
This is our new tag
POST /api/entities/{entityId}/tags/{tagId}/update HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"tagName": "tag-101",
"description": "This is our new tag"
}
{
"success": true,
"data": {
"tagId": "tag123",
"entityId": "entity123",
"tagName": "Tag Name",
"description": "Tag description",
"tagUsers": [
"user123",
"user456"
],
"isPrivate": true,
"isEnabled": true,
"createdAt": "2023-06-27T12:45:00Z"
}
}
This endpoint allows to delete a tag for an entity.
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The secret key for authentication
test-secret
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/tags/{tagId}/delete HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
{
"success": true,
"data": {
"tagId": "tag123",
"entityId": "entity123",
"tagName": "Tag Name",
"description": "Tag description",
"tagUsers": [
"user123",
"user456"
],
"isPrivate": true,
"isEnabled": false,
"createdAt": "2023-06-27T12:45:00Z"
}
}
This endpoint retrieves all the entity tags for a user.
The API key for authentication
test
The secret key for authentication
test-secret
The Id of the user performing the request.
dummy-userid
The token for user authentication.
dummy-token
GET /api/entities/{entityId}/users/{forUserId}/tags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Accept: */*
{
"success": true,
"data": [
{
"tagId": "tag-121",
"tagName": "super-tag",
"description": "This is our tag",
"isPrivate": false
}
]
}
This endpoint allows to add an entity tag for a user.
The API key for authentication
test
The secret key for authentication
test-secret
The Id of the user performing the request.
dummy-userid
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/users/{forUserId}/tags/{tagId}/add HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
{
"success": true,
"data": {
"tagId": "tag123",
"entityId": "entity123",
"tagName": "Tag Name",
"description": "Tag description",
"tagUsers": [
"user123",
"user456"
],
"isPrivate": true,
"isEnabled": true,
"createdAt": "2023-06-27T12:45:00Z"
}
}
This endpoint allows to remove an entity tag for a user.
The API key for authentication
test
The secret key for authentication
test-secret
The Id of the user performing the request.
dummy-userid
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/users/{forUserId}/tags/{tagId}/remove HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
userid: dummy-userid
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
{
"success": true,
"data": {
"tagId": "tag123",
"entityId": "entity123",
"tagName": "Tag Name",
"description": "Tag description",
"tagUsers": [
"user123",
"user456"
],
"isPrivate": true,
"isEnabled": true,
"createdAt": "2023-06-27T12:45:00Z"
}
}
Last updated