Entity Gem

Get specific Entity Gems of an Entity

Get specific Entity Gems of specific entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}

Path parameters

entityId*string

entityGemsContractId*string

Query parameters

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataEntityGems (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}?entityId=dummy-entityid&userId=dummy-userid', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

200400401500

{
  "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"
  }
}

Add Entity Gems of an Entity

Add Entity Gems of specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

name*string

sourcestring

descstring

logostring

initialDefaultValuestring

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataEntityGems (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/?entityId=dummy-entityid&userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401500

{
  "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"
  }
}

Update Entity Gems of an Entity

Update Entity Gems Info of specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}/update

Path parameters

entityId*string

entityGemsContractId*string

Query parameters

Header parameters

Body

application/json

name*string

source*string

desc*string

logo*string

initialDefaultValue*string

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataEntityGems (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}/update?entityId=dummy-entityid&userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "source": "text",
      "desc": "text",
      "logo": "text",
      "initialDefaultValue": "text"
    }),
});
const data = await response.json();

Response

200400401500

{
  "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"
  }
}

Soft Delete Entity Gems of an Entity

Soft Delete Entity Gems info of specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}/delete

Path parameters

entityId*string

entityGemsContractId*string

Query parameters

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataEntityGems (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/gem-contracts/{entityGemsContractId}/delete?entityId=dummy-entityid&userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

200400401500

{
  "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"
  }
}

Increase Entity Gems of an user

Increase Entity Gems value of a particular user

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/gemsContracts/{entityGemsContractId}/increase

Path parameters

entityId*string

userId*string

entityGemsContractId*string

Query parameters

Header parameters

Body

application/json

value*string

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataUserGemsMapping (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/gemsContracts/{entityGemsContractId}/increase?entityId=dummy-entityid&userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": "text"
    }),
});
const data = await response.json();

Response

200400401500

{
  "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
  }
}

Decrease Entity Gems of an user

Decrease Entity Gems value of a particular user

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/gemsContracts/{entityGemsContractId}/decrease

Path parameters

entityId*string

userId*string

entityGemsContractId*string

Query parameters

Header parameters

Body

application/json

value*string

Response

200400401500

Successful response

Body

application/json

successboolean

Example: true

dataUserGemsMapping (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/gemsContracts/{entityGemsContractId}/decrease?entityId=dummy-entityid&userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": "text"
    }),
});
const data = await response.json();

Response

200400401500

{
  "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
  }
}