Application Structure Resources - 2.11

Mon, 01 Jan 0001 00:00:00 +0000

On this page:

Glossary

Term	Definition
Application	An application represents an application as a measurable object. Each application snapshot is a measure point of an application.
Application Snapshot	An application snapshot is a measure point of an application. It is made up of a set of data (results, objects, etc.) computed and frozen at a given time
Attachment	A JSON content attached to an application, it can be a list of frameworks, a survey, etc.
Category	A tag belongs to a category. A category is a set of tags.
Domain	A domain is an identifier of a database. It is defined with a schema name and a connection string to a DBMS.
Module	A module represents a module as a measurable object. Each snapshot of a module is part of an application snapshot.
Module Snapshot	A module snapshot is a measure point of a module. It is made up of a set of data (results, objects, etc.) computed and frozen at a given time. A module snapshot is a part of an application snapshot.
System	A system represents a group of applications.
Tag	A tag is a keyword that can be assigned to an application.
Technology	A subset of source code belonging to a technology (i.e. JEE code , .NET code, ABAP code, etc.)
Tree Node	A structure that organizes application, modules, and components in a tree

Domain

URI Templates

HTTP Action	Media Type	URI Templates	Description
GET	application/json	/	Array of domains
GET	application/json	{Domain}	A domain content

JSON Representation

Properties	Description	Type	Occurs
href	Auto reference	URI	1
name	Domain name	String	1
dbType	Database type either “AAD” for Measurement Service database or “ADG” for Dashboard Service database	String	1
version	Package version of “ADG_FULL_CENTRAL”; which is considered as CAST AIP version number	String	1
schema	Name of the database schema	String	1
dbmsVersion	Product name and version of the Database Management System host	String	1
componentsIndexStatus	Status of the Lucene components index	String	1
violationsIndexStatus	Statuc of the Lucene violations index	String	1
systems.href	For a Central database, reference to get an array of systems	URI	1
applications.href	Reference to get an array of applications	URI	1
nbOfApplications	Returns total applications count present in domain	int	1
nbOfAuthorizedApplications	Returns authorized applications count, returns only for domain content (/{domainName})	int	1
nbOfAuthorizedSnapshots	Returns authorized snapshots count, returns only for domain content (/{domainName})	int	1
configurations.href	Reference to the history of configurations	URI	1
results.href	Reference to get results of all applications	URI	1
commonCategories.href	For a Measurement Database, reference to get all defined categories	URI	1
tags.href	For a Measurement Database, reference to get all application assignments	URI	1
technologyResults	For selected domain, return array of reference to get results for each technology	Array	1
technologyResults.href	For each technology present in selected domain, returns reference to get results	URI	1

JSON Example

JSON format for Array of domains

Engineering Resources - 2.11

Mon, 01 Jan 0001 00:00:00 +0000

Warning

Dashboard Service database only

On this page:

Glossary

Term Definition

Action Plan An action plan is a set of issues (i.e. violations requiring a remedial action)

Code Fragment A code fragment identifies a file contents extract.

Component Snapshot

A component is a source code item such as a class, a method, etc. The effective definition depends on the programming language and the technology of the analyzed application. Container of a component is either an application or a module.

Health Results Resources - 2.11

Mon, 01 Jan 0001 00:00:00 +0000

On this page:

Glossary

Term	Definition
Result	An assessment result of an application or a module.
Result Detail	Additional values, indicators, related to a result: • intermediate calculation results • breakdown of a measure • related quantitative values
Quality Standard Reference	A reference to a Quality Standard such as CWE-352

Assessment Result

URI Templates & Parameters

HTTP Action Media Type URI Templates Description

GET

application/json

{Domain}/results{?parameters}

Array of results of a domain split by snapshots, by applications

Quality and Sizing Model Resources - 2.11

Mon, 01 Jan 0001 00:00:00 +0000

On this page:

Glossary

Term	Definition
Background Fact	An external information that can be related to Quality Indicators or Sizing Measures
Business Criterion	A Quality Criterion which grade is based upon contributing technical criteria grades and critical violations
Category	A Quality Distribution slot. There are 4 categories defined for each Quality Distribution. A category measure is an input value to compute the Quality Distribution grade.
Configuration Item	A Quality Indicator, Sizing Measure of Background Fact, implemented as calculation rule to measure an application or a module.
Distribution Pattern	The Distribution Pattern is the definition of the Object property to use to decide in which distribution category to assign Objects. It also includes the associated documentation: description, rationale, reference, remediation, …
Grade Aggregator	An impacted Quality Indicator (see Grade Contributor)
Grade Contributor	A Quality Indicator which measure is used to compute another Quality Indicator (see Grade Aggregator)
Indirect Contributing Quality Indicator	A Quality Rule, Quality Distribution or Quality Measure contributing to a Business Criterion
Measure Pattern	The Measure Pattern is the definition of the measure to perform on each Module. It also includes the associated documentation: description, rationale, reference, remediation, …
Quality Indicator	An calculation measure which unit is a grade between 1.0 (very high risk) and 4.0 (low risk) to assess a source code quality.
Quality Distribution	A Quality Criterion based on a distribution pattern
Quality Rule	A Quality Criterion to assess compliance of a source code with a Rule Pattern.
Quality Measure	A Quality Criterion based on a measure pattern
Rule Pattern	The Rule Pattern is the pattern that is searched for in the analysis results (source code, cartography, etc.) to pinpoint Violations. It also includes the associated documentation: description, rationale, reference, remediation, …
Sizing Measure	A quantitative measure
Technical Criterion	A Quality Indicator which grade is based upon contributing Quality Rule , Quality Distribution and Quality Measures grades.

Configuration Snapshot

URI Templates

HTTP Action	Media Type	URI Templates	Description
GET	application/json	{Domain}/configuration/snapshots	Array of Configurations snapshots
GET	application/json	{Domain}/configuration/snapshots/{snapshotID}	A configuration snapshot content

JSON Representation

Properties	Description	Type	Occurs
href	Auto reference	URI	1
name	Configuration name	String	1
number	Snapshot order number.Snapshots are ordered according to the annotation.date	Integer	1
annotation	User annotations describing this snapshot	Structure	1
annotation.version	Assessment point number	String	1
annotation.date	Application date	Date	1
annotation.description	Snapshot description	String	1
annotation.name	Snapshot name	String	1
annotation.enhancementMeasure	Computation mode of enhancement data. It has one of the following values : “EFP” or “AEP”	String	1
qualityIndicators.href	Reference to get a group of indicators	URI	1
sizingMeasures.href	Reference to get a group of sizing measures	URI	1
backgroundFacts.href	Reference to get background facts	URI	1

JSON Example

{
	"href": "DEMO/configuration/snapshots/5",
	"name": "Configuration Snapshot #1",
	"number": 1,
	"annotation": {
		"version": "1.0",
		"date": {
			"time": 1338328800000
		},
		"description": null,
		"name": "GM_DRAS_201206180516",
		"enhancementMeasure": "EFP"
	},
	"qualityIndicators": {
		"href": "DEMO/configuration/snapshots/5/quality-indicators",
		"name": "All Quality Indicators"
	},
	"sizingMeasures": {
		"href": "DEMO/configuration/snapshots/5/sizing-measures",
		"name": "All Sizing Measures"
	},
	"backgroundFacts": {
		"href": "DEMO/configuration/snapshots/5/background-facts",
		"name": "All Background Facts"
	}
}

Remediation Efforts

URI Templates

HTTP Action

Report Service - 2.11

Mon, 01 Jan 0001 00:00:00 +0000

On this page:

Report

This Web Services allows to get a report using the Report Generator in an asynchronous way.

The REST API spawns the Report Generator processes, and the REST API is also called back by the Report Generator itself which runs as a REST API client.

See the server resource object and the reportEnabled attribute to check whether this web service is enabled

Configuration

The ## REPORT CONFIGURATION section in application.properties file allows to configure the interaction between the REST API and the Report Generator:

Server Services - 2.11

Mon, 01 Jan 0001 00:00:00 +0000

On this page:

Server

URI Templates

HTTP Action	Media Type	URI Templates	Description
GET	application/json	server	Information about REST API internal state

JSON Representation

Properties Description type Occurs

href Auto reference URI 1

name "Server" String 1

startDate Starting date of the server Date 1

memory Statistics about memory usage (mega-bytes) Structure 1

memory.totalInitialMemory Total memory according to the JVM in mega-bytes, before initializing memory cache Integer 1

memory.totalMemory Total memory according to the JVM in mega-bytes Integer 1

memory.freeMemory Free memory according to the JVM in mega-bytes Integer 1

memory.usedMemory Total memory - Free memory Integer 1

requests Statistics about requests Structure 1

requests.totalCounter Total number of requests Integer 1

requests.errorsCounter Total number of requests in errors Integer 1

requests.totalTime Total elapsed time of requests milliseconds Integer 1

requests.averageTime Total elapsed time of requests in milliseconds Integer 1

requests.maxTime Longest elapsed time of all requests in milliseconds Integer 1

clients Statistics about concurrent clients Structure 1

currentConcurrentClients The current number of concurrent clients in read time.
Note that the current request to fetch this information is not included in the count. Integer 1

maxConcurrentClients The maximum number of concurrent clients Integer 1

status

Server status either "LOADING" or "READY"

String

User Session Services - 2.11

Mon, 01 Jan 0001 00:00:00 +0000

On this page:

User

URI Templates

HTTP Action	Media Type	URI Templates	Description
GET	application/json	user{?parameters}	Get information about current user requesting REST API.

Parameters

URI Parameter

Description

Values

Default value

application-name

Get information about assigned roles for the specific application.

You can pass $all to get list of all authorized applications for the user.

String

none (Mandatory parameter)

db-type

AAD or ADG data type to get list of applications

String

none (Mandatory parameter)

JSON Representation

Properties	Description	Type	Occurs
href	Auto reference	URI	1
name	User name	String	1
contextUuid	A unique identifier of the current user session	String	1
administrator	Check whether the user has “ADMIN” role	Boolean	1
superConsumer	Check whether the user has permission to consume all applications without restriction	Boolean	1
userApplicationDetail[ ]	This list of matched applications returns roles assigned for this user	Array	0..*
userApplicationDetail[ ].applicationDetail	Application details	Structure	1
userApplicationDetail[ ].applicationDetail.name	Application name	String	1
userApplicationDetail[ ].applicationDetail.href	Auto reference	URI	1
userApplicationDetail[ ].applicationDetail.adgDatabase	For a Measurement Database, name of the Central database hosting this application	String	0..1
userApplicationDetail[ ].applicationDetail.nbOfAuthorizedSnapshots	Number of authorized or valid snapshots for this application	Integer	1
userApplicationDetail[ ].applicationDetail.latestSnapshotDate	Latest snapshot date for the selected application	Date	1
userApplicationDetail[ ].applicationRoles	Roles assigned for this application	Structure	1
userApplicationDetail[ ].applicationRoles.qualityManager	Check whether the user has “QUALITY_MANAGER” role for this application	Boolean	1
userApplicationDetail[ ].applicationRoles.exclusionManager	Check whether the user has “EXCLUSION_MANAGER” role for this application	Boolean	1
userApplicationDetail[ ].applicationRoles.qualityAutomationManager	Check whether the user has “QUALITY_AUTOMATION_MANAGER” role for this application	Boolean	1
userApplicationDetail[ ].applicationRoles.codeRestricted	Check whether the user has “CODE_RESTRICTED” role for this application	Boolean	1

JSON Example

 {
 "href": "user",
 "name": "CIO",
 "contextUuid": "031b54ae-5f26-45f7-9e34-84fa222ce4e1",
 "administrator": false,
 "superConsumer": true
}

 {
	"href": "user",
	"superConsumer": true,
	"administrator": true,
	"contextUuid": "64e9ff82-7b68-4ad1-916a-932294942593",
	"name": "admin",
	"userApplicationDetail": [
		{
			"applicationDetail": {
				"name": "Dream Team",
				"href": "AAD/applications/3",
				"adgDatabase": "adg_contrex_central"
			},
			"applicationRoles": {
				"codeRestricted": false,
				"qualityManager": false,
				"exclusionManager": false,
				"qualityAutomationManager": false
			}
		}
	]
}

Pseudo REST service to trigger a creation of end user session. Require an “Authorization” header containing user name and password

REST API Reference Documentation - 2.11 on Documentation - V2

Application Structure Resources - 2.11

Glossary

Domain

URI Templates

JSON Representation

JSON Example

Engineering Resources - 2.11

Glossary

Health Results Resources - 2.11

Glossary

Assessment Result

URI Templates & Parameters

Quality and Sizing Model Resources - 2.11

Glossary

Configuration Snapshot

URI Templates

JSON Representation

JSON Example

Remediation Efforts

URI Templates

Report Service - 2.11

Report

Configuration

Server Services - 2.11

Server

URI Templates

JSON Representation

User Session Services - 2.11

User

URI Templates

Parameters

JSON Representation

JSON Example

Login