Cloud Tables

Web API References for Cloud Data Storage Service

Explore the list of Web APIs functions available for managing tables, including detailed descriptions and usage examples.

To use services functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From game's dashboard header.

Finds and deletes a row by its unique identifier.

delete

Path parameters

tableIdstringRequired

rowIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

delete

/api/table/{tableId}/{rowId}

HTTPcURLJavaScriptPython

DELETE /api/table/{tableId}/{rowId} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "row": null
}

Deletes a row from the table.

put

Path parameters

tableIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

put

/api/table/{tableId}/delete

HTTPcURLJavaScriptPython

PUT /api/table/{tableId}/delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "affected": 1
}

Deletes multiple rows from the table.

post

Path parameters

tableIdstringRequired

Body

application/jsontext/jsonapplication/*+json

idsinteger · int32[]Required

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/{tableId}/delete

HTTPcURLJavaScriptPython

POST /api/table/{tableId}/delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "ids": [
    1
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "affected": 1
}

post

Path parameters

tableIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/{tableId}/find-one-and-delete

HTTPcURLJavaScriptPython

POST /api/table/{tableId}/find-one-and-delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "joins": [
    {
      "table_name": "text",
      "local_field": "text",
      "foreign_field": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": 1
}

Finds rows in a table based on the provided parameters.

put

Path parameters

tableIdstringRequired

Query parameters

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

put

/api/table/{tableId}

HTTPcURLJavaScriptPython

PUT /api/table/{tableId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "sorts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "joins": [
    {
      "table_name": "text",
      "local_field": "text",
      "foreign_field": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

[]

Updates multiple rows in the table.

put

Path parameters

tableIdstringRequired

Query parameters

rowIdinteger · int32Optional

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

put

/api/table/{tableId}/update

HTTPcURLJavaScriptPython

PUT /api/table/{tableId}/update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": 1
}

Inserts a new row into the table.

post

Path parameters

tableIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/{tableId}

HTTPcURLJavaScriptPython

POST /api/table/{tableId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": 1
}

Inserts multiple new rows into the table.

post

Path parameters

tableIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/{tableId}/insert

HTTPcURLJavaScriptPython

POST /api/table/{tableId}/insert HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "data": []
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": 1
}

Finds a row by its unique identifier.

get

Path parameters

tableIdstringRequired

rowIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/{tableId}/{rowId}

HTTPcURLJavaScriptPython

GET /api/table/{tableId}/{rowId} HTTP/1.1
Host: 
Accept: */*

200

OK

[
  {
    "id": 1
  }
]

Finds a row by its unique identifier and updates it.

put

Path parameters

tableIdstringRequired

rowIdinteger · int32Required

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

put

/api/table/{tableId}/{rowId}

HTTPcURLJavaScriptPython

PUT /api/table/{tableId}/{rowId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": 1
}

post

Path parameters

tableIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/{tableId}/find-one

HTTPcURLJavaScriptPython

POST /api/table/{tableId}/find-one HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 300

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "joins": [
    {
      "table_name": "text",
      "local_field": "text",
      "foreign_field": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": 1
}

post

Path parameters

tableIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/{tableId}/find-one-and-update

HTTPcURLJavaScriptPython

POST /api/table/{tableId}/find-one-and-update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 346

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "joins": [
    {
      "table_name": "text",
      "local_field": "text",
      "foreign_field": "text"
    }
  ],
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": 1
}