| Method | HTTP request | Description |
|---|---|---|
| getChannel | GET /streamsets/{webId}/channel | Opens a channel that will send messages about any value changes for the attributes of an Element, Event Frame, or Attribute. |
| getEnd | GET /streamsets/{webId}/end | Returns End of stream values of the attributes for an Element, Event Frame or Attribute |
| getInterpolated | GET /streamsets/{webId}/interpolated | Returns interpolated values of attributes for an element, event frame or attribute over the specified time range at the specified sampling interval. |
| getInterpolatedAtTimes | GET /streamsets/{webId}/interpolatedattimes | Returns interpolated values of attributes for an element, event frame or attribute at the specified times. |
| getPlot | GET /streamsets/{webId}/plot | Returns values of attributes for an element, event frame or attribute over the specified time range suitable for plotting over the number of intervals (typically represents pixels). |
| getRecorded | GET /streamsets/{webId}/recorded | Returns recorded values of the attributes for an element, event frame, or attribute. |
| updateValues | POST /streamsets/{webId}/recorded | Updates multiple values for the specified streams. |
| getRecordedAtTime | GET /streamsets/{webId}/recordedattime | Returns recorded values of the attributes for an element, event frame, or attribute. |
| getRecordedAtTimes | GET /streamsets/{webId}/recordedattimes | Returns recorded values of attributes for an element, event frame or attribute at the specified times. |
| getSummaries | GET /streamsets/{webId}/summary | Returns summary values of the attributes for an element, event frame or attribute. |
| getValues | GET /streamsets/{webId}/value | Returns values of the attributes for an Element, Event Frame or Attribute at the specified time. |
| updateValue | POST /streamsets/{webId}/value | Updates a single value for the specified streams. |
| getChannelAdHoc | GET /streamsets/channel | Opens a channel that will send messages about any value changes for the specified streams. |
| getEndAdHoc | GET /streamsets/end | Returns End Of Stream values for attributes of the specified streams |
| getInterpolatedAdHoc | GET /streamsets/interpolated | Returns interpolated values of the specified streams over the specified time range at the specified sampling interval. |
| getInterpolatedAtTimesAdHoc | GET /streamsets/interpolatedattimes | Returns interpolated values of the specified streams at the specified times. |
| getPlotAdHoc | GET /streamsets/plot | Returns values of attributes for the specified streams over the specified time range suitable for plotting over the number of intervals (typically represents pixels). |
| getRecordedAdHoc | GET /streamsets/recorded | Returns recorded values of the specified streams. |
| updateValuesAdHoc | POST /streamsets/recorded | Updates multiple values for the specified streams. |
| getRecordedAtTimeAdHoc | GET /streamsets/recordedattime | Returns recorded values based on the passed time and retrieval mode. |
| getRecordedAtTimesAdHoc | GET /streamsets/recordedattimes | Returns recorded values of the specified streams at the specified times. |
| getSummariesAdHoc | GET /streamsets/summary | Returns summary values of the specified streams. |
| getValuesAdHoc | GET /streamsets/value | Returns values of the specified streams. |
| updateValueAdHoc | POST /streamsets/value | Updates a single value for the specified streams. |
getChannel(String webId, String categoryName, Integer heartbeatRate, Boolean includeInitialValues, String nameFilter, Boolean searchFullHierarchy, Boolean showExcluded, Boolean showHidden, String templateName, String webIdType)
Opens a channel that will send messages about any value changes for the attributes of an Element, Event Frame, or Attribute.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.. | [required] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| heartbeatRate | Integer | Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which the client receives an empty payload. It helps to check if the connection is still alive. Zero/negative values correspond to no heartbeat, and the default value is no heartbeat.. | [optional] |
| includeInitialValues | Boolean | Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is 'false'.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getEnd(String webId, String categoryName, String nameFilter, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String sortField, String sortOrder, String templateName, String webIdType)
Returns End of stream values of the attributes for an Element, Event Frame or Attribute
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.. | [required] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getInterpolated(String webId, String categoryName, String endTime, String filterExpression, Boolean includeFilteredValues, String interval, String nameFilter, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String sortField, String sortOrder, String startTime, String syncTime, String syncTimeBoundaryType, String templateName, String timeZone, String webIdType)
Returns interpolated values of attributes for an element, event frame or attribute over the specified time range at the specified sampling interval.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.. | [required] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| endTime | String | An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.. | [optional] |
| filterExpression | String | An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.. | [optional] |
| includeFilteredValues | Boolean | Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.. | [optional] |
| interval | String | The sampling interval, in AFTimeSpan format.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| startTime | String | An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.. | [optional] |
| syncTime | String | An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for calculating the interval times.. | [optional] |
| syncTimeBoundaryType | String | An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The default is 'Inside'.. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getInterpolatedAtTimes(String webId, List time, String categoryName, String filterExpression, Boolean includeFilteredValues, String nameFilter, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String sortOrder, String templateName, String timeZone, String webIdType)
Returns interpolated values of attributes for an element, event frame or attribute at the specified times.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.. | [required] |
| time | List | The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.. | [required] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| filterExpression | String | An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.. | [optional] |
| includeFilteredValues | Boolean | Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'.. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getPlot(String webId, String categoryName, String endTime, Integer intervals, String nameFilter, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String sortField, String sortOrder, String startTime, String templateName, String timeZone, String webIdType)
Returns values of attributes for an element, event frame or attribute over the specified time range suitable for plotting over the number of intervals (typically represents pixels).
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.. | [required] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| endTime | String | An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.. | [optional] |
| intervals | Integer | The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| startTime | String | An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getRecorded(String webId, String boundaryType, String categoryName, String endTime, String filterExpression, Boolean includeFilteredValues, Integer maxCount, String nameFilter, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String sortField, String sortOrder, String startTime, String templateName, String timeZone, String webIdType)
Returns recorded values of the attributes for an element, event frame, or attribute.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.. | [required] |
| boundaryType | String | An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.. | [optional] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| endTime | String | An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.. | [optional] |
| filterExpression | String | An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.. | [optional] |
| includeFilteredValues | Boolean | Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.. | [optional] |
| maxCount | Integer | The maximum number of values to be returned. The default is 1000.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| startTime | String | An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
updateValues(String webId, List values, String bufferOption, String updateOption)
Updates multiple values for the specified streams.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the parent element, event frame, or attribute. Attributes specified in the body must be descendants of the specified object.. | [required] |
| values | List | The values to add or update.. | [required] |
| bufferOption | String | The desired AFBufferOption. The default is 'BufferIfPossible'.. | [optional] |
| updateOption | String | The desired AFUpdateOption. The default is 'Replace'.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getRecordedAtTime(String webId, String time, String categoryName, String nameFilter, String retrievalMode, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String templateName, String timeZone, String webIdType)
Returns recorded values of the attributes for an element, event frame, or attribute.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.. | [required] |
| time | String | The timestamp at which the values are desired.. | [required] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| retrievalMode | String | An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getRecordedAtTimes(String webId, List time, String categoryName, String nameFilter, String retrievalMode, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String sortOrder, String templateName, String timeZone, String webIdType)
Returns recorded values of attributes for an element, event frame or attribute at the specified times.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.. | [required] |
| time | List | The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.. | [required] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| retrievalMode | String | An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'.. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSummaries(String webId, String calculationBasis, String categoryName, String endTime, String filterExpression, String nameFilter, String sampleInterval, String sampleType, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String startTime, String summaryDuration, List summaryType, String templateName, String timeType, String timeZone, String webIdType)
Returns summary values of the attributes for an element, event frame or attribute.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an element, event frame or attribute, which is the base element or parent of all the stream attributes.. | [required] |
| calculationBasis | String | Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.. | [optional] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| endTime | String | An optional end time. The default is '' for element attributes and points. For event frame attributes, the default is the event frame's end time, or '' if that is not set. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.. | [optional] |
| filterExpression | String | A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute. The default is no filtering.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| sampleInterval | String | A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is 'Interval'.. | [optional] |
| sampleType | String | A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| startTime | String | An optional start time. The default is '-1d' for element attributes and points. For event frame attributes, the default is the event frame's start time, or '-1d' if that is not set.. | [optional] |
| summaryDuration | String | The duration of each summary interval.. | [optional] |
| summaryType | List | Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| timeType | String | Specifies how to calculate the timestamp for each interval. The default is 'Auto'.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getValues(String webId, String categoryName, String nameFilter, Boolean searchFullHierarchy, String selectedFields, Boolean showExcluded, Boolean showHidden, String sortField, String sortOrder, String templateName, String time, String timeZone, String webIdType)
Returns values of the attributes for an Element, Event Frame or Attribute at the specified time.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of an Element, Event Frame or Attribute, which is the base element or parent of all the stream attributes.. | [required] |
| categoryName | String | Specify that included attributes must have this category. The default is no category filter.. | [optional] |
| nameFilter | String | The name query string used for filtering attributes. The default is no filter.. | [optional] |
| searchFullHierarchy | Boolean | Specifies if the search should include attributes nested further than the immediate attributes of the searchRoot. The default is 'false'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| showExcluded | Boolean | Specified if the search should include attributes with the Excluded property set. The default is 'false'.. | [optional] |
| showHidden | Boolean | Specified if the search should include attributes with the Hidden property set. The default is 'false'.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| templateName | String | Specify that included attributes must be members of this template. The default is no template filter.. | [optional] |
| time | String | An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the default time context of the AF object will be used.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
updateValue(String webId, List values, String bufferOption, String updateOption)
Updates a single value for the specified streams.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the parent element, event frame, or attribute. Attributes specified in the body must be descendants of the specified object.. | [required] |
| values | List | The values to add or update.. | [required] |
| bufferOption | String | The desired AFBufferOption. The default is 'BufferIfPossible'.. | [optional] |
| updateOption | String | The desired AFUpdateOption. The default is 'Replace'.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getChannelAdHoc(List webId, Integer heartbeatRate, Boolean includeInitialValues, String webIdType)
Opens a channel that will send messages about any value changes for the specified streams.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| heartbeatRate | Integer | Specifies the maximum number of consecutive empty messages that can be elapsed with no new data updates from the PI System, after which the client receives an empty payload. It helps to check if the connection is still alive. Zero/negative values correspond to no heartbeat, and the default value is no heartbeat.. | [optional] |
| includeInitialValues | Boolean | Specified if the channel should send a message with the current values of all the streams after the connection is opened. The default is 'false'.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getEndAdHoc(List webId, String selectedFields, String sortField, String sortOrder, String webIdType)
Returns End Of Stream values for attributes of the specified streams
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getInterpolatedAdHoc(List webId, String endTime, String filterExpression, Boolean includeFilteredValues, String interval, String selectedFields, String sortField, String sortOrder, String startTime, String syncTime, String syncTimeBoundaryType, String timeZone, String webIdType)
Returns interpolated values of the specified streams over the specified time range at the specified sampling interval.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| endTime | String | An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.. | [optional] |
| filterExpression | String | An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.. | [optional] |
| includeFilteredValues | Boolean | Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.. | [optional] |
| interval | String | The sampling interval, in AFTimeSpan format.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| startTime | String | An optional start time. The default is '*-1d'.. | [optional] |
| syncTime | String | An optional start time anchor, in AFTime format. When specified, interpolated data retrieval will use the sync time as the origin for calculating the interval times.. | [optional] |
| syncTimeBoundaryType | String | An optional string specifying the boundary type to use when applying a syncTime. The allowed values are 'Inside' and 'Outside'. The default is 'Inside'.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getInterpolatedAtTimesAdHoc(List time, List webId, String filterExpression, Boolean includeFilteredValues, String selectedFields, String sortOrder, String timeZone, String webIdType)
Returns interpolated values of the specified streams at the specified times.
| Name | Type | Description | Notes |
|---|---|---|---|
| time | List | The timestamp at which to retrieve a interpolated value. Multiple timestamps may be specified with multiple instances of the parameter.. | [required] |
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| filterExpression | String | An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. If the attribute does not support filtering, the filter will be ignored. The default is no filtering.. | [optional] |
| includeFilteredValues | Boolean | Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getPlotAdHoc(List webId, String endTime, Integer intervals, String selectedFields, String sortField, String sortOrder, String startTime, String timeZone, String webIdType)
Returns values of attributes for the specified streams over the specified time range suitable for plotting over the number of intervals (typically represents pixels).
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| endTime | String | An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.. | [optional] |
| intervals | Integer | The number of intervals to plot over. Typically, this would be the number of horizontal pixels in the trend. The default is '24'. For each interval, the data available is examined and significant values are returned. Each interval can produce up to 5 values if they are unique, the first value in the interval, the last value, the highest value, the lowest value and at most one exceptional point (bad status or digital state).. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| startTime | String | An optional start time. The default is '*-1d'.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getRecordedAdHoc(List webId, String boundaryType, String endTime, String filterExpression, Boolean includeFilteredValues, Integer maxCount, String selectedFields, String sortField, String sortOrder, String startTime, String timeZone, String webIdType)
Returns recorded values of the specified streams.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| boundaryType | String | An optional value that determines how the times and values of the returned end points are determined. The default is 'Inside'.. | [optional] |
| endTime | String | An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.. | [optional] |
| filterExpression | String | An optional string containing a filter expression. Expression variables are relative to the data point. Use '.' to reference the containing attribute. The default is no filtering.. | [optional] |
| includeFilteredValues | Boolean | Specify 'true' to indicate that values which fail the filter criteria are present in the returned data at the times where they occurred with a value set to a 'Filtered' enumeration value with bad status. Repeated consecutive failures are omitted.. | [optional] |
| maxCount | Integer | The maximum number of values to be returned. The default is 1000.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| startTime | String | An optional start time. The default is '*-1d'.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
updateValuesAdHoc(List values, String bufferOption, String updateOption)
Updates multiple values for the specified streams.
| Name | Type | Description | Notes |
|---|---|---|---|
| values | List | The values to add or update.. | [required] |
| bufferOption | String | The desired AFBufferOption. The default is 'BufferIfPossible'.. | [optional] |
| updateOption | String | The desired AFUpdateOption. The default is 'Replace'.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getRecordedAtTimeAdHoc(String time, List webId, String retrievalMode, String selectedFields, String timeZone, String webIdType)
Returns recorded values based on the passed time and retrieval mode.
| Name | Type | Description | Notes |
|---|---|---|---|
| time | String | The timestamp at which the values are desired.. | [required] |
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| retrievalMode | String | An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getRecordedAtTimesAdHoc(List time, List webId, String retrievalMode, String selectedFields, String sortOrder, String timeZone, String webIdType)
Returns recorded values of the specified streams at the specified times.
| Name | Type | Description | Notes |
|---|---|---|---|
| time | List | The timestamp at which to retrieve a recorded value. Multiple timestamps may be specified with multiple instances of the parameter.. | [required] |
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| retrievalMode | String | An optional value that determines the values to return when values don't exist at the exact time specified. The default is 'Auto'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getSummariesAdHoc(List webId, String calculationBasis, String endTime, String filterExpression, String sampleInterval, String sampleType, String selectedFields, String startTime, String summaryDuration, List summaryType, String timeType, String timeZone, String webIdType)
Returns summary values of the specified streams.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| calculationBasis | String | Specifies the method of evaluating the data over the time range. The default is 'TimeWeighted'.. | [optional] |
| endTime | String | An optional end time. The default is '*'. Note that if endTime is earlier than startTime, the resulting values will be in time-descending order.. | [optional] |
| filterExpression | String | A string containing a filter expression. Expression variables are relative to the attribute. Use '.' to reference the containing attribute. The default is no filtering.. | [optional] |
| sampleInterval | String | A time span specifies how often the filter expression is evaluated when computing the summary for an interval, if the sampleType is 'Interval'.. | [optional] |
| sampleType | String | A flag which specifies one or more summaries to compute for each interval over the time range. The default is 'ExpressionRecordedValues'.. | [optional] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| startTime | String | An optional start time. The default is '*-1d'.. | [optional] |
| summaryDuration | String | The duration of each summary interval.. | [optional] |
| summaryType | List | Specifies the kinds of summaries to produce over the range. The default is 'Total'. Multiple summary types may be specified by using multiple instances of summaryType.. | [optional] |
| timeType | String | Specifies how to calculate the timestamp for each interval. The default is 'Auto'.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
getValuesAdHoc(List webId, String selectedFields, String sortField, String sortOrder, String time, String timeZone, String webIdType)
Returns values of the specified streams.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | List | The ID of a stream. Multiple streams may be specified with multiple instances of the parameter.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| sortField | String | The field or property of the object used to sort the returned collection. For better performance, The default is unsorted. 'Name' is the only supported field by which to sort.. | [optional] |
| sortOrder | String | The order that the returned collection is sorted. The default is 'Ascending'. | [optional] |
| time | String | An AF time string, which is used as the time context to get stream values if it is provided. By default, it is not specified, and the default time context of the AF object will be used.. | [optional] |
| timeZone | String | The time zone in which the time string will be interpreted. This parameter will be ignored if a time zone is specified in the time string. If no time zone is specified in either places, the PI Web API server time zone will be used.. | [optional] |
| webIdType | String | Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
updateValueAdHoc(List values, String bufferOption, String updateOption)
Updates a single value for the specified streams.
| Name | Type | Description | Notes |
|---|---|---|---|
| values | List | The values to add or update.. | [required] |
| bufferOption | String | The desired AFBufferOption. The default is 'BufferIfPossible'.. | [optional] |
| updateOption | String | The desired AFUpdateOption. The default is 'Replace'.. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]