datasources | MSquared Platform Documentation

Get organization datasources

GEThttp://admin.m2worlds.io/api/datasources/

Authorization

Query parameters

Header parameters

Response

Default Response

Body

itemsany of

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "type": "invites",
    "hidden": false,
    "isPublic": false,
    "datasourceId": "text",
    "permissionVerb": "r"
  }
]

Creates an organization datasource

POSThttp://admin.m2worlds.io/api/datasources/

Authorization

Body

name*string

typeany of

hiddenboolean

isPublicboolean

Response

Default Response

Body

datasourceId*string

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "datasourceId": "text"
}

Creates or updates a datasource - supports Nft and Registry Contract datasources only

PUThttp://admin.m2worlds.io/api/datasources/

Authorization

Query parameters

Body

PutDatasourceRequestSchema (any of)

The request body for PUT /datasources

Response

Default Response

Body

documentId*string

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "collectionName": "text",
      "tokenName": "text",
      "chainId": "1",
      "contractAddress": "text",
      "type": "nft"
    }),
});
const data = await response.json();

Response

{
  "documentId": "text"
}

Create or update an avatar

PUThttp://admin.m2worlds.io/api/datasources/avatars/

Authorization

Body

avatarobject

Info to locate an avatar

assets*array of object

namestring

Response

Default Response

Body

datasourceId*datasourceId (string)

The ID of a datasource

objectDefinitionId*objectDefinitionId (string)

The ID of an object definition

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/avatars/', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "assets": [
        {
          "datasourceId": "text",
          "objectDefinitionId": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "datasourceId": "text",
  "objectDefinitionId": "text"
}

Get user collections accross datasources

GEThttp://admin.m2worlds.io/api/datasources/collections/

Authorization

Query parameters

Header parameters

Response

Default Response

Body

data*all of

tagsarray of any of

originany of

uid*string

balance*number

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/collections/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "data": {},
    "tags": [
      "text"
    ],
    "origin": {
      "format": "internal"
    },
    "uid": "text",
    "balance": 0
  }
]

Get user collections tags accross datasources

GEThttp://admin.m2worlds.io/api/datasources/collections/tags/

Authorization

Header parameters

Response

Default Response

Body

itemsany of

A tag of an object definition

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/collections/tags/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  "text"
]

Get user collections properties across datasources

GEThttp://admin.m2worlds.io/api/datasources/collections/properties/

Authorization

Header parameters

Response

Default Response

Body

itemsstring

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/collections/properties/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  "text"
]

Updates an existing organization datasource

PATCHhttp://admin.m2worlds.io/api/datasources/{datasourceId}/

Authorization

Path parameters

datasourceId*string

The ID of a datasource

Body

namestring

typeany of

hiddenboolean

isPublicboolean

Response

Default Response

Body

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Deletes an external datasource

DELETEhttp://admin.m2worlds.io/api/datasources/{datasourceId}/

Authorization

Path parameters

datasourceId*string

The ID of a datasource

Response

Default Response

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Post Object Definition (organization datasources only)

POSThttp://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/

Authorization

Path parameters

datasourceId*string

The ID of a datasource

Header parameters

Body

data*all of

tags*array of any of

mmlObjectstring

filesany of

propertiesstring

Response

Default Response

Body

data*all of

id*string

The ID of an object definition

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "data": {},
      "tags": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "data": {},
  "id": "text"
}

Get all object definitions from an organization datasource

GEThttp://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/

Authorization

Path parameters

datasourceId*string

The ID of a datasource

Query parameters

Header parameters

Response

Default Response

Body

data*all of

tagsarray of any of

originany of

id*string

The ID of an object definition

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "data": {},
    "tags": [
      "text"
    ],
    "origin": {
      "format": "internal"
    },
    "id": "text"
  }
]

Get Object Definition (organization and external datasources)

GEThttp://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/{objectDefinitionId}/

Authorization

Path parameters

datasourceId*datasourceId (string)

The ID of a datasource

objectDefinitionId*objectDefinitionId (string)

The ID of an object definition

Response

Default Response

Body

data*all of

tagsarray of any of

originany of

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/{objectDefinitionId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "data": {},
  "tags": [
    "text"
  ],
  "origin": {
    "format": "internal"
  }
}

Patch Object Definition (organization datasources only)

PATCHhttp://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/{objectDefinitionId}/

Authorization

Path parameters

datasourceId*datasourceId (string)

The ID of a datasource

objectDefinitionId*objectDefinitionId (string)

The ID of an object definition

Header parameters

Body

dataall of

tagsarray of any of

Response

Default Response

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/{objectDefinitionId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete Object Definition (organization datasources only)

DELETEhttp://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/{objectDefinitionId}/

Authorization

Path parameters

datasourceId*datasourceId (string)

The ID of a datasource

objectDefinitionId*objectDefinitionId (string)

The ID of an object definition

Header parameters

Response

Default Response

Body

data*all of

tagsarray of any of

originany of

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/{objectDefinitionId}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "data": {},
  "tags": [
    "text"
  ],
  "origin": {
    "format": "internal"
  }
}

Bulk Post Object Definition (organization datasources only)

POSThttp://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/bulk/

Authorization

Path parameters

datasourceId*string

The ID of a datasource

Header parameters

Body

data*all of

tagsarray of any of

originany of

Response

Default Response

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/objectDefinitions/bulk/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "data": {}
      }
    ]),
});
const data = await response.json();

Webhook called by Alchemy when an entry is added to a registry contract datasource

POSThttp://admin.m2worlds.io/api/datasources/{datasourceId}/registryEntryAdded/

Authorization

Path parameters

datasourceId*string

The ID of a datasource

Body

nftContractAddress*string

Address of a smart contract

nftTokenId*string

nftChainId*string

serviceURI*string

contentHash*string

registryEntryUniqueId*string

registryEntryIndex*string

Response

Default Response

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/registryEntryAdded/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "nftContractAddress": "text",
      "nftTokenId": "text",
      "nftChainId": "text",
      "serviceURI": "text",
      "contentHash": "text",
      "registryEntryUniqueId": "text",
      "registryEntryIndex": "text"
    }),
});
const data = await response.json();

Webhook called by Alchemy when an entry is updated in a registry contract datasource

POSThttp://admin.m2worlds.io/api/datasources/{datasourceId}/registryEntryUpdated/

Authorization

Path parameters

datasourceId*string

The ID of a datasource

Body

serviceURI*string

contentHash*string

registryEntryUniqueId*string

Response

Default Response

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/registryEntryUpdated/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "serviceURI": "text",
      "contentHash": "text",
      "registryEntryUniqueId": "text"
    }),
});
const data = await response.json();

Deletes user balances in target organization datasource

PUThttp://admin.m2worlds.io/api/datasources/{datasourceId}/userBalances/delete/

Authorization

Path parameters

datasourceId*string

The ID of a datasource

Body

objectDefinitionId*string

The ID of an object definition

Response

Default Response

Body

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/{datasourceId}/userBalances/delete/', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "objectDefinitionId": "text"
    }),
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Patch external datasources for the target organization

PATCHhttp://admin.m2worlds.io/api/datasources/external/

Authorization

Header parameters

Body

datasourceId*string

The ID of a datasource

operation*any of

Response

Default Response

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/external/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "datasourceId": "text",
        "operation": 0
      }
    ]),
});
const data = await response.json();

Service health check

GEThttp://admin.m2worlds.io/api/datasources/healthz/

Response

Default Response

Body

statusMessage (string)

Provides information about the service status.

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/healthz/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

Blockchain networks supported by the M2 platform.

GEThttp://admin.m2worlds.io/api/datasources/networks/

Authorization

Response

Default Response

Body

itemsany of

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/networks/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  "1"
]

Post user balances transfer

POSThttp://admin.m2worlds.io/api/datasources/transfer/

Authorization

Header parameters

Body

userId*string

The ID of a user

datasourceId*string

The ID of a datasource

objectDefinitionId*string

The ID of an object definition

change*number

Response

Default Response

Body

userId*string

The ID of a user

datasourceId*string

The ID of a datasource

objectBalances*object

The object balances

Request

const response = await fetch('http://admin.m2worlds.io/api/datasources/transfer/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "userId": "text",
        "datasourceId": "text",
        "objectDefinitionId": "text",
        "change": 0
      }
    ]),
});
const data = await response.json();

Response

[
  {
    "userId": "text",
    "datasourceId": "text"
  }
]