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

delete

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

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

200

{
  "row": null
}

Deletes a row from the table.

put

Path parameters

tableIdstringRequired

Body

Responses

200

put

/api/table/{tableId}/delete

PUT /api/table/{tableId}/delete HTTP/1.1
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]"
          }
        ]
      }
    ]
  }
}

200

{
  "affected": 1
}

Deletes multiple rows from the table.

post

Path parameters

tableIdstringRequired

Body

idsinteger · int32[]Required

Responses

200

post

/api/table/{tableId}/delete

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

{
  "ids": [
    1
  ]
}

200

{
  "affected": 1
}

post

Path parameters

tableIdstringRequired

Body

Responses

200

post

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

POST /api/table/{tableId}/find-one-and-delete HTTP/1.1
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"
    }
  ]
}

200

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

Responses

200

put

/api/table/{tableId}

PUT /api/table/{tableId} HTTP/1.1
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"
    }
  ]
}

200

[]

Updates multiple rows in the table.

put

Path parameters

tableIdstringRequired

Query parameters

rowIdinteger · int32Optional

Body

Responses

200

put

/api/table/{tableId}/update

PUT /api/table/{tableId}/update HTTP/1.1
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]"
          }
        ]
      }
    ]
  }
}

200

{
  "id": 1
}

Inserts a new row into the table.

post

Path parameters

tableIdstringRequired

Body

Responses

200

post

/api/table/{tableId}

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

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

200

{
  "id": 1
}

Inserts multiple new rows into the table.

post

Path parameters

tableIdstringRequired

Body

Responses

200

post

/api/table/{tableId}/insert

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

{
  "data": []
}

200

{
  "id": 1
}

Finds a row by its unique identifier.

get

Path parameters

tableIdstringRequired

rowIdinteger · int32Required

Responses

200

get

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

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

200

[
  {
    "id": 1
  }
]

Finds a row by its unique identifier and updates it.

put

Path parameters

tableIdstringRequired

rowIdinteger · int32Required

Body

Responses

200

put

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

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

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

200

{
  "id": 1
}

post

Path parameters

tableIdstringRequired

Body

Responses

200

post

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

POST /api/table/{tableId}/find-one HTTP/1.1
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"
    }
  ]
}

200

{
  "id": 1
}

post

Path parameters

tableIdstringRequired

Body

Responses

200

post

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

POST /api/table/{tableId}/find-one-and-update HTTP/1.1
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"
  }
}

200

{
  "id": 1
}

PreviousUsers NextLeaderboard

Last updated 8 months ago

hashtagFinds and deletes a row by its unique identifier.

hashtagDeletes a row from the table.

hashtagDeletes multiple rows from the table.

hashtagFinds rows in a table based on the provided parameters.

hashtagUpdates multiple rows in the table.

hashtagInserts a new row into the table.

hashtagInserts multiple new rows into the table.

hashtagFinds a row by its unique identifier.

hashtagFinds a row by its unique identifier and updates it.

Finds and deletes a row by its unique identifier.

Deletes a row from the table.

Deletes multiple rows from the table.

Finds rows in a table based on the provided parameters.

Updates multiple rows in the table.

Inserts a new row into the table.

Inserts multiple new rows into the table.

Finds a row by its unique identifier.

Finds a row by its unique identifier and updates it.