Entity Gem | Quest Protocol

Quest Protocol

Soft Delete Entity Gems of an Entity

post

Soft Delete Entity Gems info of specific entity.

Path parameters

entityIdstringrequired

entityGemsContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}/delete?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "name": "Gem Name",
    "desc": "Gem description",
    "source": "OFFCHAIN",
    "logo": "logo",
    "initialDefaultValue": 100,
    "isDeleted": false,
    "createdAt": "2023-06-27T12:45:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z"
  }
}

Successful response

Get specific Entity Gems of an Entity

get

Get specific Entity Gems of specific entity.

Path parameters

entityIdstringrequired

entityGemsContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "name": "Gem Name",
    "desc": "Gem description",
    "source": "OFFCHAIN",
    "logo": "logo",
    "initialDefaultValue": 100,
    "isDeleted": false,
    "createdAt": "2023-06-27T12:45:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z"
  }
}

Successful response

Add Entity Gems of an Entity

post

Add Entity Gems of specific entity.

Path parameters

entityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

namestringrequired

sourcestringoptional

descstringoptional

logostringoptional

initialDefaultValuestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "source": "text",
    "desc": "text",
    "logo": "text",
    "initialDefaultValue": "text"
  }'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "name": "Gem Name",
    "desc": "Gem description",
    "source": "OFFCHAIN",
    "logo": "logo",
    "initialDefaultValue": 100,
    "isDeleted": false,
    "createdAt": "2023-06-27T12:45:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z"
  }
}

Successful response

Update Entity Gems of an Entity

post

Update Entity Gems Info of specific entity.

Path parameters

entityIdstringrequired

entityGemsContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

namestringrequired

sourcestringrequired

descstringrequired

logostringrequired

initialDefaultValuestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}/update?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "source": "text",
    "desc": "text",
    "logo": "text",
    "initialDefaultValue": "text"
  }'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "name": "Gem Name",
    "desc": "Gem description",
    "source": "OFFCHAIN",
    "logo": "logo",
    "initialDefaultValue": 100,
    "isDeleted": false,
    "createdAt": "2023-06-27T12:45:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z"
  }
}

Successful response

Increase Entity Gems of an user

post

Increase Entity Gems value of a particular user

Path parameters

entityIdstringrequired

userIdstringrequired

entityGemsContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

valuestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/gemsContracts/{entityGemsContractId}/increase?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": "text"
  }'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "userId": "user1",
    "gemsContractId": {
      "entityId": "entity123",
      "name": "Gem Name",
      "desc": "Gem description",
      "source": "OFFCHAIN",
      "logo": "logo",
      "initialDefaultValue": 100,
      "isDeleted": false,
      "createdAt": "2023-06-27T12:45:00Z",
      "modifiedAt": "2023-06-27T12:45:00Z"
    },
    "value": 10
  }
}

Successful response

Decrease Entity Gems of an user

post

Decrease Entity Gems value of a particular user

Path parameters

entityIdstringrequired

userIdstringrequired

entityGemsContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

valuestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/gemsContracts/{entityGemsContractId}/decrease?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": "text"
  }'

200

400

401

500

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "userId": "user1",
    "gemsContractId": {
      "entityId": "entity123",
      "name": "Gem Name",
      "desc": "Gem description",
      "source": "OFFCHAIN",
      "logo": "logo",
      "initialDefaultValue": 100,
      "isDeleted": false,
      "createdAt": "2023-06-27T12:45:00Z",
      "modifiedAt": "2023-06-27T12:45:00Z"
    },
    "value": 10
  }
}

Successful response