Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - measureListItemType

  • Article
  • 2 minutes to read

Description

This type is used when returning a list of defined measures.

Properties

Name Type Occurrence Description
measureId xs:unsignedInt Required The unique identifier of the measure.
application appNameType Optional The application this measure is associated with. This is only provided if there is no application filter applied
title xs:string Required Specify the name of the measure.
timeZone xs:string Optional The Time Zone applied to this measure.
status measureStatusType Required The current statis of this measure. If the status is ‘error’ then a descriptive error is provided in the statusError property.
statusError xs:string Optional If the status is set ot ‘error’ then this provides a description of the error that was encountered.
actual xs:decimal Optional The latest value for this measure. If the value is NULL then this element will not be present
difference xs:decimal Required The change in value of “actual” from the previous value, this shows the last movement of the value.
unitType measureValueUnitType Required The type of meaning the value of the measure has.
measureFrequency measureFrequencyType Required Frequency at which the measure is taken.
highIsGood xs:boolean Required If this is set to ‘true’ then a value above or equal to the “threshold” value is good, if set to “false” then a value below or equal to the “threshold” value is good.
targetWarning xs:decimal Optional A measure can set a target warning level in order to visualize good/warning status of the measure.
targetBreach xs:decimal Optional A measure can set a breach threshold in order to visualize good/bad status of the measure.
lastSampleTime xs:dateTime Required This is the date/time of the last sample taken.
trendValue Array<measureTrendValueType> Optional The latest values for this measure, ordered in cronological order with the newest value appearing first
scorecardLimit xs:unsignedInt Required The maximum number of values to show when displaying a scorecard.
sparklineLimit xs:unsignedInt Required The maximum number of points to use when sparkline.
createdOn xs:dateTime Required The date/time the measure was first created.
createdBy xs:string Required This is DEPRECATED and should not be used, USE createdByUserInfo INSTEAD Who created the measure.
createdByUserInfo accountBasicDetailsType Required Who created the measure.
updatedOn xs:dateTime Required The date/time the measure was last changed.
updatedBy xs:string Required This is DEPRECATED and should not be used, USE updatedByUserInfo INSTEAD Who last updated the measure.
updatedByUserInfo accountBasicDetailsType Required Who last updated the measure.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document