entity.resolveBatch · Umwelt docs

Reference/Queries/entity.resolveBatch

entity.resolveBatchquerysince 0.1

Finds many entities by the ids another system gives them.

Command lineTypeScript.NET

Request

umwelt call story.umw entity.resolveBatch '{
  "projectId": "ball",
  "externalRefs": [
    { "system": "game", "id": "npc-12" },
    { "system": "game", "id": "npc-99" }
  ]
}'

Request

const result = await client.entityResolveBatch({
  projectId: 'ball',
  externalRefs: [{ system: 'game', id: 'npc-12' }, { system: 'game', id: 'npc-99' }],
});

Request

var result = engine.EntityResolveBatch(new ResolveEntitiesPayload
{
    ProjectId = "ball",
    ExternalRefs = new()
    {
        new ExternalRef { System = "game", Id = "npc-12" },
        new ExternalRef { System = "game", Id = "npc-99" },
    },
});

Response

[
  {
    "entityId": "guard",
    "externalRef": { "id": "npc-12", "system": "game" }
  },
  { "externalRef": { "id": "npc-99", "system": "game" } }
]

Payload

Field	Type	Description
`projectId`required	string	The project to read.
`externalRefs`required	ExternalRef[]	The references.

Result

A list of ResolvedEntity, each with:

Field	Type	Description
`externalRef`always	ExternalRef	The reference asked about.
`entityId`	string	The entity it belongs to. Absent when none does.

Rules

Missing references are not errors. A reference no entity has comes back without entityId.

Errors

VALIDATION_FAILEDThe payload is malformed.

NOT_FOUNDThe project does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.

Payload

Result

Rules

Errors

See also