RP_APIGetEntityReference: RP_APIGetEntityReference

View source: R/RP_SelfServiceAPI_EndPoints.R

RP_APIGetEntityReferenceR Documentation

RP_APIGetEntityReference

Description

Request reference data for a single entity in RavenPack’s entity universe. It is possible to have more than one value for a particular type of data. This is encoded as separate EntityData objects with possibly different time ranges associated. Please note that it is also normal to have more than one value for a particular type of data over the same time range.

Usage

RP_APIGetEntityReference(APIHandler, entity_id)

Arguments

APIHandler

An API handler, created using RP_CreateAPIHandler

entity_id

A valid RP_ENTITY_ID.

Value

A list with the mapping information.

Author(s)

Jose A. Guerrero-Colon


RavenPack/r-api documentation built on July 30, 2022, 9:56 p.m.