Place — openapi

Represents a Roblox place.

Properties

Name	Type	Required	Description
path	string	false	The resource path of the place. Format: `universes/{universe_id}/places/{place_id}`
createTime	string	false	The timestamp at which the place was created.
updateTime	string	false	The timestamp at which the place was updated.
displayName	string	false	The name of the place.
description	string	false	The description of the place.
serverSize	integer	false	The maximum number of allowed users in a single server.
root	boolean	false	Whether this place is its parent universe's root place or not. Each universe has exactly one root place.
universeRuntimeCreation	boolean	false	Whether this place was created through in-experience creation. If true, the place was created by calling AssetService::CreatePlaceAsync() from a script.
templatePlace	string	true	The resource path of the template place used to initialize the place on creation. The newly created place will be a clone of this template. A list of the valid template places can be obtained from ListTemplatePlaces. Format: universes/{universe_id}/places/{place_id}

Complete Schema

{
  "required": [
    "templatePlace"
  ],
  "type": "object",
  "properties": {
    "path": {
      "example": "universes/123/places/123",
      "type": "string",
      "description": "The resource path of the place.\n\nFormat: `universes/{universe_id}/places/{place_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp at which the place was created.",
      "format": "date-time"
    },
    "updateTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp at which the place was updated.",
      "format": "date-time"
    },
    "displayName": {
      "example": "ROBLOX Battle [OPEN]",
      "type": "string",
      "description": "The name of the place."
    },
    "description": {
      "example": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
      "type": "string",
      "description": "The description of the place."
    },
    "serverSize": {
      "type": "integer",
      "description": "The maximum number of allowed users in a single server.",
      "format": "int32"
    },
    "root": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "Whether this place is its parent universe's root place or not.\nEach universe has exactly one root place."
    },
    "universeRuntimeCreation": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "Whether this place was created through in-experience creation.\nIf true, the place was created by calling AssetService::CreatePlaceAsync()\nfrom a script."
    },
    "templatePlace": {
      "writeOnly": true,
      "example": "universes/{universe_id}/places/{place_id}",
      "type": "string",
      "description": "The resource path of the template place used to initialize the place on\ncreation.\nThe newly created place will be a clone of this template.\nA list of the valid template places can be obtained from\nListTemplatePlaces. Format: universes/{universe_id}/places/{place_id}",
      "x-immutable": true
    }
  },
  "description": "Represents a Roblox place.",
  "x-aep-resource": {
    "patterns": [
      "universes/{universe_id}/places/{place_id}"
    ],
    "plural": "places",
    "singular": "place"
  },
  "x-resource": true,
  "x-oneOf": {
    "Description": [
      "description"
    ],
    "DisplayName": [
      "displayName"
    ],
    "ServerSize": [
      "serverSize"
    ]
  }
}