Health Results Resources - 1.24

{Domain}/results{?parameters}

application/vnd.openxmlformats-

{Domain}/applications/{ApplicationID}/results{?parameters}

application/vnd.openxmlformats-

{Domain}/applications/{ApplicationID}/snapshots/{SnapshotID}/results{?parameters}

application/vnd.openxmlformats-

{Domain}/modules/{ModuleID}/results{?parameters}

application/vnd.openxmlformats-

{Domain}/modules/{ModuleID}/snapshots/{SnapshotID}/results{?parameters}

Array of results for a given module and snapshot

application/vnd.openxmlformats-

{Domain}/transactions/{TransactionID}/results{?parameters}

Quality Indicators identifiers or keywords, separated by a comma

Ex: .../results/?quality-indicators=(business-criteria)
Ex: .../results/?quality-indicators=(technical-criteria)
Ex: .../results/?quality-indicators=(quality-rules)
Ex: .../results/?quality-indicators=(quality-distributions)
Ex: .../results/?quality-indicators=(quality-measures)

use 'c:' modifier to specify direct grade contributors of a Quality Indicator or a Quality Stantard reference( aka tag)

Ex: c:61027

Ex: c:CISQ

Note: this list is based on the union set of targeted snapshots

use 'cc:' modifier to specify critical grade contributors of a Quality Indicator

Ex: cc:61027

Note: the critical contributors of a Business Criterion (eg. cc:61027) are the BC's critical children, union the TCs' critical children. A Quality Rule is said to be critical if it is critical for at least one of its parents. In the Assessment Model, some metrics have multiple parents therefore a Quality Rule can be critical for parent A, and non-critical for parent B. In other words, using the "cc" modifier can return non-critical Quality Rules.

use 'nc:' modifier to specify non-critical grade contributors of a Quality Indicator

Ex: nc:61027

Note: the non-critical contributors (nc) of a Business Criterion (eg. nc:61027) are the BC's non-critical children, union the TCs' non-critical children. A Quality Rule is said to be critical if it is critical for at least one of its parents. In the Assessment Model, some metrics have multiple parents therefore a Quality Rule can be critical for parent A, and non-critical for parent B.

Quality Standards references, separated by a comma

Ex: .../results/?quality-standards=(CISQ,CISQ-Maintainability)

Sizing measures identifiers or keywords, separated by a comma

Ex: .../results/?sizing-measures=(technical-size-measures)
Ex: .../results/?sizing-measures=(functional-weight-measures)
Ex: .../results/?sizing-measures=(critical-violation-statistics)
  Ex:   .../results/ ?sizing-measures=(violation-statistics)
Ex: .../results/?sizing-measures=(technical-debt-statistics)
Ex: .../results/?sizing-measures=(run-time-statistics)

Background Facts identifiers, separated by a comma

Ex: .../results/?background-facts=(66061)

Keyword $all or application names separated by a comma

Ex: .../results/?applications=($all)
Ex: .../results/?applications=(name1,name with space 2) 

Keyword $all or module names separated by a comma

Ex: .../results/?modules=($all)
Ex: .../results/?modules=(name1,name with space 2) 

Keyword $all or technology names separated by a comma

Ex: .../results/?technologies=($all)
Ex: .../results/?technologies=(name1,name with space 2) 

• a positive or negative integer
  Ex: .../results/?snapshots=(-1)
  Ex: .../results/?snapshots=(1)
  
  A negative number matches snapshots from the end (eg. -1 matches the last snapshot, -2 matches the last and previous snapshots).
  A positive number matches snapshots from the beginning (eg. 1 matches the first snapshot, 2 matches the first and second snapshots).

• the keyword $all
  Ex: .../results/?snapshots=($all)
  
  This means all snapshots.
  
  
• a snapshot date
  Ex: .../results/?snapshots=(2012-10-01) 
  
  The date format is the standard W3C Date format: YYYY-MM-DD
  
  If there is a snapshot at this date, select this snapshot, otherwise select the oldest snapshot after this date, otherwise select the most recent snapshot before this date.

The input value is a list of snapshot ids separated by commas.

Ex: .../results/ ?snapshot-ids=(5,12,3)

NB. The 'snapshot-ids' and 'snapshots' parameters are exclusive. You cannot use both in the same request.

• violationRatio
  Ex .../results?quality-indicators=(quality-rules)&select=(violationRatio)
  It must be used along with a Quality Indicator parameter specifying Quality Rules.
  ViolationRatio can apply to applications, modules and technologies.
• evolutionSummary
  Ex: .../results?quality-indicators=(business-criteria,technical-criteria,quality-rules)&select=(evolutionSummary)
  It must be used along with a Quality Indicator parameter specifying one or more Business Criteria, Technical Criteria or Quality Rule.
  EvolutionSummary can apply to applications, modules and technologies.
• categories
  Ex: .../results?quality-indicators=(quality-distributions)&select=(categories)
  It must be used along with a Quality Indicator parameter specifying one or more Quality Distributions.
  Categories can apply to applications, modules and technologies.
• aggregators
  Ex: .../results?sizing-measures=(c:10202)&select=aggregators 
  Add gradeAggregators on each result. An aggregator is an indicator impacted by the result.
• improvementGap
  Ex .../results?quality-indicators=(quality-rules)&select=(improvementGap)
  It must be used along with a Quality Indicator parameter specifying Quality Rules.
• omgTechnicalDebt
  Ex: .../results?metrics=c:1062100&select=omgTechnicalDebt
  It must be used along with a CISQ Quality Indicator (Business Criterion, Technical Criterion, or a rule). See also: The com.castsoftware.cisq-index documentation

• grade
  Ex: .../results?quality-indicators=(business-criteria)&unselect=(grade)
  It prevents the grade parameter to be displayed for a Quality Indicator.
  It applies to applications, modules and technologies. 

• snapshotsAsRows
  Ex: .../results?snapshots=(-2)&format=(snapshotsAsRows)
  For CSV and Excel output, this displays the values for different snapshots on new rows instead of new columns (default behaviour).  

Possible sorting parameters are:

• improvementGap
• rule-pattern-name
• rule-id

Application Name

Module Name

Module name.

If specified then assessment results are in the scope of this module

Technology

Technology name.

If specified then assessment results are in the scope of this technology

Metric Name

Snapshot Date #N

Date of the assessment result. Assessment results are ordered from the most recent (N=1), to the less recent (N > 1).

Effective selected snapshots depends on the snapshot query parameter.

Violations (Result #N)

Total Checks (Result #N)

Added Critical Violations (Result #N)

Critical Violations in New and Modified Code (Result #N)

Value is "business-criterion"

technologiesResults

Results Breakdown by technology

Array

0..1

result

Application snapshot own result

Double

0..1

result.evolutionSummary

See Evolution Summary structure

Structure

0..1

0..1

reference

Reference to a Business Criterion

Structure

1

reference.href

URI

1

reference.name

String

1

Value is "technical-criterion"

technologiesResults

Results Breakdown by technology

Array

0..1

result

Application snapshot own result

Double

0..1

0..1

reference

Reference to a Quality Indicator

Structure

1

reference.href

URI

1

reference.name

String

1

reference.key

Integer

1

reference.gradeAggregators

Indicators computed with this result

Array

1

reference.gradeAggregators[].key

A parent Quality Indicator key

String

0..*

Value is "quality-rules"

technologiesResults

Results Breakdown by technology

Array

0..1

result

Application snapshot own result

Double

0..1

0..1

reference

Reference to a Quality Indicator

Structure

1

reference.href

URI

1

reference.name

String

1

reference.key

Integer

1

reference.gradeAggregators

Indicators computed with this result

Array

1

reference.gradeAggregators[].key

A parent Quality Indicator key

String

0..*

Value is "quality-distributions"

technologiesResults

Results Breakdown by technology

Array

0..1

result

Application snapshot own result

Double

0..1

result.categories

See Category Structure

Array

1

0..1

reference

Reference to a Quality Indicator

Structure

1

reference.href

URI

1

reference.name

String

1

reference.key

Integer

1

reference.gradeAggregators

Indicators computed with this result

Array

1

reference.gradeAggregators[].key

A parent Quality Indicator key

String

0..*

Value is "quality-measures"

technologiesResults

Results Breakdown by technology

Array

0..1

result

Application snapshot own result

Double

0..1

0..1

reference

Reference to a Qualilty Indicator

Structure

1

reference.href

URI

1

reference.name

String

1

reference.key

Integer

1

reference.gradeAggregators

Indicators computed with this result

Array

1

reference.gradeAggregators[].key

A parent Quality Indicator key

String

0..*

Value is among

• technical-size-measures
• functional-weight-measures
• critical-violation-statistics
• technical-debt-statistics
• run-time-statistics

technologiesResults

Results Breakdown by technology

Array

0..1

result

Application snapshot own result

Double

0..1

0..1

reference

Reference to a Sizing Measure

Structure

1

reference.href

URI

1

reference.name

String

1

reference.key

Integer

1

background-fact

technologiesResults

Results Breakdown by technology

Array

0..1

result

Application snapshot own result

Double

0..1

0..1

reference

Reference to a Sizing Measure

Structure

1

reference.href

URI

1

reference.name

String

1

reference.key

Integer

1

violationRatio

For a quality rule, this ratio in an input value required
to compute the grade according to 4 thresholds.

Structure

0..1

violationRatio.totalChecks

Total number of checked items in the current scope

Integer

1

violationRatio.failedChecks

Total number of failed items in the current scope

Integer

1

violationRatio.successfulChecks

Result of totalChecks - failedChecks

Integer

1

violationRatio.ratio

Compliance Ratio, i.e. successfulChecks / totalChecks

Double

1

{Domain}/quality-standards-categories/{QualityStandardCategory}

{Domain}/applications/{ID}/quality-standards

Array of quality standard references for an application. Only quality standard references with violations are reported.

{Domain}/applications/{ID}/snapshots/{SnapshotID}/quality-standards

{Domain}/custom-quality-tags

Download CUSTOM TAGS mapping

Example of curl command line:

C:\>curl --header "Accept: text/csv" http://localhost:8080/CAST-RESTAPI/rest/{Domain}/custom-quality-tags

Add rule/CUSTOM TAGS mapping. If the mapping already exists, it is left unchanged.

The tag must begin with the 'CUSTOM' prefix, otherwise the web service raises an error.

All new TAGS are automatically assigned to the  'CUSTOM' standard. 

Example of curl command line:
C:\>curl -X PUT --header "Content-type: text/csv" --upload-file data.csv http://localhost:8080/CAST-RESTAPI/rest/{Domain}/custom-quality-tags

Remove rule/CUSTOM TAGS mapping

The tag must begin with the 'CUSTOM' prefix, otherwise the web service raises an error

All deleted TAGS are automatically removed from  'CUSTOM' standard. 

Example of curl command line:

C:\>curl -X DELETE --header "Content-type: text/csv" --upload-file data.csv http://localhost:8080/CAST-RESTAPI/rest/{Domain}/custom-quality-tags