The API calls in this section are all used to create and manipulate QiTypes. See .. _Qi Types: https://github.com/osisoft/Qi-Docs/blob/Qi_Edits/docs/Qi_Types.rst for a list of supported QiTypes, a discussion of compound indexes, and general information about QiTypes.
Returns the type definition that is associated with a given stream from the specified namespace.
Syntax
QiType GetStreamType(string tenantId, string namespaceId, string streamId); Task<QiType> GetStreamTypeAsync(string tenantId, string namespaceId, string streamId);
Http
GET Qi/{tenantId}/{namespaceId}/Streams/{streamId}/Type
Parameters
string tenantID- The tenant identifier for the request
- string
namespaceId - The namespace identifier for the request
- string
streamId - The ID of the stream to search for the specified type definition
Optional parameters
None
Returns
Qitype type definition
- Security
- Allowed by administrator and user accounts
Returns the type of the specified typeId from the specified namespace.
Syntax
QiType GetType(string tenantId, string namespaceId, string typeId); Task<QiType> GetTypeAsync(string tenantId, string namespaceId, string typeId);
Http
GET Qi/{tenantId}/{namespaceId}/Types/{typeId}
Parameters
string tenantID- The tenant identifier for the request
string namespaceId- The namespace identifier for the request
typeId- The ID of the type to retrieve
Optional parameters
None
- Returns
- A QiType specified by the typeId
- Security
- Allowed by administrator and user accounts
Returns a list of all types within a given namespace.
Syntax
IEnumerable<QiType> GetTypes(); Task<IEnumerable<QiType>> GetTypesAsync();
Http
GET Qi/Types
Parameters
string tenantID- The tenant identifier for the request
string namespaceId- The namespace identifier for the request
QiType entity- The object
Optional parameters
None
Returns
IEnumerable QiType of all types in the namespace
- Security
- Allowed by administrator account
Returns the type of the specified typeId within a namespace, or creates the type if the typeId does not already exist. If the typeId exists, it is returned to the caller unchanged.
Syntax
QiType GetOrCreateType(string tenantId, string namespaceId, QiType entity); Task<QiType> GetOrCreateTypeAsync(string tenantId, string namespaceId, QiType entity);
Http
POST Qi/{tenantId}/{namespaceId}/Types
Parameters
string tenantID- The tenant identifier for the request
string namespaceId- The namespace identifier for the request
QiType entity- The ID of the stream for which the type request is made
Optional parameters
None
Returns
Qitype
- Security
- Allowed by administrator account
Deletes a type from the specified namespace. Note that a type cannot be deleted if there are streams associated with it.
Syntax
void DeleteType(string tenantId, string namespaceId, string typeId); Task DeleteTypeAsync(string tenantId, string namespaceId, string typeId);
Http
DELETE Qi/{tenantId}/{namespaceId}/Types/{typeId}
Parameters
string tenantID- The tenant identifier for the request
string namespaceId- The namespace identifier for the request
string typeId- The ID of the type to delete
Optional parameters
None
Returns
Qitype
- Security
- Allowed by administrator account
Updates the definition of a type. Note that a type cannot be updated if there are streams associated with it.
Syntax
void UpdateType(string tenantId, string namespaceId, string typeId, QiType entity); Task UpdateTypeAsync(string tenantId, string namespaceId, string typeId, QiType entity);
Http
PUT Qi/{tenantId}/{namespaceId}/Types/{typeId}
Parameters
string tenantID- The tenant identifier for the request
string namespaceId- The namespace identifier for the request
string typeId- The typeId of the type to update
Optional parameters
None
Returns
Qitype
- Security
- Allowed by Administrator account