Identifier Refs

The IdentifierRef table, located within the Reference package, serves as a reference for all unique identifiers used within the database. This table contains a list of all identifiers and their associated data, such as source system, type, and description. It is used to ensure consistency and accuracy in data retrieval and analysis. This table plays a crucial role in maintaining data integrity and serves as a valuable tool for database administrators and data analysts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
int32

The IdentifierRefId field is an identity field in the IdentifierRef table, with a data type of integer. This field serves as a unique identifier for each record in the table. It automatically generates a sequential number for each new record added to the table, making it easy to reference and identify specific records. The IdentifierRefId field plays a crucial role in maintaining the integrity and organization of data within the table, allowing for efficient retrieval and management of information. It serves as a primary key for the table, ensuring that each record has a unique and unchangeable identifier.

string | null

The IdentifierCode field in the IdentifierRef table is a data type of nvarchar, which stands for a variable-length string of alphanumeric characters. This field is used to store unique codes that identify specific items or objects within the referenced system. These codes can be used for efficient retrieval and organization of data and are crucial for accurately referencing and identifying various entities within the system. This field plays an essential role in maintaining data integrity and facilitating communication between different components of the system.

int32 | null

The ParentId field in the IdentifierRef table is a data type of int and is used to identify the parent record associated with a particular entry. This field is essential in organizing and categorizing data within the table, allowing for easy navigation and retrieval of related records. The ParentId can also be used to establish hierarchical relationships between records, where one record can have multiple child records. This field plays a crucial role in maintaining data integrity and facilitating efficient data management within the IdentifierRef table.

string | null

EntityId is a field in the IdentifierRef table that is of data type nvarchar with a maximum length of 450. This field is used to store a unique identification number for each entity in the database. The EntityId serves as a primary key, allowing for efficient and accurate retrieval of information related to a specific entity. It is limited to a maximum length of 450 characters, ensuring that all necessary information can be stored while maintaining data integrity. The EntityId is an essential component of the IdentifierRef table, providing a fundamental basis for data organization and retrieval within the database.

string
required
length between 1 and 450

The IdentifierTypeId field in the IdentifierRef table is a data type nvarchar with a maximum length of 450 characters. This field is used to store the type of identifier for a given record, such as a social security number, driver's license number, or student ID. It serves as a reference and allows for easy identification and sorting within the data set. The length limit of 450 characters ensures that all types of identifiers can be stored accurately and completely.

int32 | null

The SystemDefnId field is a crucial component of the IdentifierRef table, as it stores a unique identifier number that is associated with a specific system or definition. This field is of the data type int, meaning it can only contain whole numbers. The purpose of this field is to provide a way to easily reference and link the IdentifierRef table with other systems or definitions within a larger database. This allows for efficient and accurate organization and management of data within the system.

string | null

The ParentStringId field in the IdentifierRef table is a nvarchar data type with a maximum length of 64 characters. It is designed to store a unique identification string that is associated with a parent entity in the database. This field serves as a reference to the parent entity and allows for efficient organization and retrieval of data in the table. This identifier could be used to link related data records or to establish hierarchical relationships within the database. With a maximum length of 64 characters, this field provides ample space to accommodate diverse identification codes and can help ensure data integrity within the table.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!