getEntityById: Gets an entity by id

View source: R/JSON_library.R

getEntityByIdR Documentation

Gets an entity by id

Description

Gets an entity object by id and kind

Usage

getEntityById(id, entityKind, include = "", errorEnv = NULL,
  lsServerURL = racas::applicationSettings$client.service.persistence.fullpath)

getEntityByCodeName(codeName, entityKind, include = "", errorEnv = NULL,
  lsServerURL = racas::applicationSettings$client.service.persistence.fullpath)

Arguments

entityKind

the kind of entity, such as "experiment" or "analysisgroup", see acasEntityHierarchy

include

a character string describing what to include

lsServerURL

the url for the roo server

entity

an entity object, such as an experiment or analysis group

Details

This will fail with an error if the object does not exist. include is only implemented for some entities, see getExperimentById for more detail.

Value

a named list representing an object.


mcneilco/racas documentation built on May 4, 2024, 9:53 p.m.