HomePricingLogin

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
delete
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
Responses
200
OK
put
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]"
          }
        ]
      }
    ]
  }
}
200

OK

{
  "affected": 1
}

Deletes multiple rows from the table.

post
Path parameters
tableIdstringRequired
Body
idsinteger · int32[]Required
Responses
200
OK
post
POST /api/table/{tableId}/delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "ids": [
    1
  ]
}
200

OK

{
  "affected": 1
}
post
Path parameters
tableIdstringRequired
Body
Responses
200
OK
post
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"
    }
  ]
}
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
Responses
200
OK
put
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"
    }
  ]
}
200

OK

[]

Updates multiple rows in the table.

put
Path parameters
tableIdstringRequired
Query parameters
rowIdinteger · int32Optional
Body
Responses
200
OK
put
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]"
          }
        ]
      }
    ]
  }
}
200

OK

{
  "id": 1
}

Inserts a new row into the table.

post
Path parameters
tableIdstringRequired
Body
Responses
200
OK
post
POST /api/table/{tableId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

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

OK

{
  "id": 1
}

Inserts multiple new rows into the table.

post
Path parameters
tableIdstringRequired
Body
Responses
200
OK
post
POST /api/table/{tableId}/insert HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "data": []
}
200

OK

{
  "id": 1
}

Finds a row by its unique identifier.

get
Path parameters
tableIdstringRequired
rowIdinteger · int32Required
Responses
200
OK
get
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
Responses
200
OK
put
PUT /api/table/{tableId}/{rowId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

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

OK

{
  "id": 1
}
post
Path parameters
tableIdstringRequired
Body
Responses
200
OK
post
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"
    }
  ]
}
200

OK

{
  "id": 1
}
post
Path parameters
tableIdstringRequired
Body
Responses
200
OK
post
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"
  }
}
200

OK

{
  "id": 1
}
PreviousUsersNextLeaderboard

Last updated