Save Data | Elements Manual

Elements Manual

Creates a save data document.

Gets a single save data document.

post

/save_data

Authorizations

Body

slotanyrequired

The slot of the property. Must be unique for user or profile.

userIdany

The id of the user which owns the save data. If specified, the user will own this save data and the profileId must be null or be owned by the user specified.

profileIdany

The id of the profile which owns the save data. If specified, the profile will own this save data and the userId must be null or be owned by the user specified.

contentsanyrequired

The contents of the save data.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/save_data' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "slot": null,
    "userId": null,
    "profileId": null,
    "contents": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Search Save Data Documents

Gets all save data documents available to the user.

get

/save_data

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

userIdany · default:

profileIdany · default:

searchany · default:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/save_data' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a save data document.

Gets a single save data document.

put

/save_data/{saveDataDocumentId}

Authorizations

Path parameters

saveDataDocumentIdanyrequired

Body

forceany

versionany

contentsanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/save_data/{saveDataDocumentId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "force": null,
    "version": null,
    "contents": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Deletes a save data document

delete

/save_data/{saveDataDocumentId}

Authorizations

Path parameters

saveDataDocumentIdanyrequired

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/save_data/{saveDataDocumentId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Get save data document.

Gets a single save data document based on Profile ID and slot. This is a convenience method whichallows the client to fetch a save data based on slot an profile id.

get

/save_data/profile/{profileId}//{slot}

Authorizations

Path parameters

profileIdanyrequired

slotanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/save_data/profile/{profileId}/{slot}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Get save data document.

Gets a single save data document

get

/save_data/{id}

Authorizations

Path parameters

idanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/save_data/{id}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Get save data document.

Gets a single save data document based on UserID and slot. This is a convenience method whichallows the client to fetch a save data based on slot an user id.

get

/save_data/user/{userId}//{slot}

Authorizations

Path parameters

userIdanyrequired

slotanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/save_data/user/{userId}/{slot}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}