Instance

Represents a data model instance.

Attribute

pathstring

The resource path of the instance.

Format: universes/{universe_id}/places/{place_id}/instances/{instance_id}.

hasChildrenboolean
Nur Ausgabe

whether the instance has any children instance.

engineInstanceobject

the property details of the instance.

Basis-URL
https://apis.roblox.com
Die Instance-Ressource
{

  "path": "universes/123/places/123/instances/0123456789abcdef0123456789abcdef",

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

Get Instance
Beta

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}

Gets an instance and its property data.

The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned Operation will be completed with an error result that has an error code of 422.

Bereiche
universe.place.instance:read
AnfragePfadparameter
universe_idstring
Erforderlich

The universe ID.

place_idstring
Erforderlich

The place ID.

instance_idstring
Erforderlich

The instance ID.

Rückmeldung

Diese Methode ist asynchron und gibt eine Operation zurück, die den aktuellen Status der Operation darstellt. Sie enthält einen Endpunktpfad, den du abfragen kannst, um die tatsächliche Antwort und die entsprechenden Metadaten zu erhalten. Weitere Informationen findest du in der Dokumentation.

Die folgenden Abschnitte beschreiben die Antwort- und Metadatenobjekte, die bereitgestellt werden, wenn eine Operation abgeschlossen ist.

RückmeldungInstanceMetadaten

Keine

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}' \

  -H 'x-api-key: {your-api-key}'

Instance

Update Instance
Beta

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}

Updates an instance's property data.

When updating a Script instance's source property, the maximum supported property size is 200,000 bytes after UTF-8 encoding.

Bereiche
universe.place.instance:write
AnfragePfadparameter
universe_idstring
Erforderlich

The universe ID.

place_idstring
Erforderlich

The place ID.

instance_idstring
Erforderlich

The instance ID.

Anfrageparameter
updateMaskstring

The list of fields to update. Dieser String ist als FieldMask formatiert.

Text anfordernInstance
Rückmeldung

Diese Methode ist asynchron und gibt eine Operation zurück, die den aktuellen Status der Operation darstellt. Sie enthält einen Endpunktpfad, den du abfragen kannst, um die tatsächliche Antwort und die entsprechenden Metadaten zu erhalten. Weitere Informationen findest du in der Dokumentation.

Die folgenden Abschnitte beschreiben die Antwort- und Metadatenobjekte, die bereitgestellt werden, wenn eine Operation abgeschlossen ist.

RückmeldungInstanceMetadaten

Keine

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}?updateMask={string}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}'

Instance

List Instance Children
Beta

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren

Lists an instance's children.

The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned Operation will be completed with an error result that has an error code of 422.

Bereiche
universe.place.instance:read
AnfragePfadparameter
universe_idstring
Erforderlich

The universe ID.

place_idstring
Erforderlich

The place ID.

instance_idstring
Erforderlich

The instance ID.

Anfrageparameter
maxPageSizenumber

The maximum number of child instance to return. The service may return fewer than this value. If unspecified, at most 200 children will be returned. The maximum value is 200; values above 200 will be coerced to 200.

pageTokenstring

A page token, received from a previous ListInstanceChildrenRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListInstanceChildrenRequest must match the call that provided the page token.

Rückmeldung

Diese Methode ist asynchron und gibt eine Operation zurück, die den aktuellen Status der Operation darstellt. Sie enthält einen Endpunktpfad, den du abfragen kannst, um die tatsächliche Antwort und die entsprechenden Metadaten zu erhalten. Weitere Informationen findest du in der Dokumentation.

Die folgenden Abschnitte beschreiben die Antwort- und Metadatenobjekte, die bereitgestellt werden, wenn eine Operation abgeschlossen ist.

Rückmeldung

Returns a list of the instance's children.

instancesarray<Instance>

A list of children instances.

.

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Metadaten

Keine

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren?maxPageSize=100&pageToken={string}' \

  -H 'x-api-key: {your-api-key}'