Manuel de référence de l'API de service Web › Initial Resources › Show a Specific Characteristic

Rubrique précédente: Show All SMI Characteristics

Rubrique suivante: Capabilities

Show a Specific Characteristic

This web service displays the SMI characteristics starting from a specific characteristic.

HTTP Type

GET

Restriction

None. Open to all public users.

URI

{type}/SMI/{version}/smiCharacteristic/{characteristic}

Parameter

Description

{characteristic}

The name of the SMI characteristic where you want to start. This is a hierarchical model and can be defined here as such. Consider it like a directory structure.

&key

The API Key that is provided when your application has been registered.

&secret

The Shared Secret that is provided when your application has been registered.

&page

Defines the page number to display.

&rows

Defines the number of records to display per page.

&sort

Valid value for this web service is: “name”. If not defined, no sorting is performed.

&childInfo

This may be set to either “true” to show the scores of all sub characteristics or “false” to show only the score of the specified characteristic. If &childInfo is not defined the default is true.

Example:

The following URI displays the "Quality" characteristic. The “childInfo=false” can be removed from the URI to show all characteristics that are children, grandchildren, great-grandchildren, etc… of the “Quality” characteristic.

https://smi.cloudcommons.com:8443/Insight_API/json/SMI/0.5/smiCharacteristic/Overall/Quality?childInfo=false&key=df3936ec01c5d3adf9f0048116cd5b84&secret=13f6232ebf484e57103cd4ac234a22aa&page=1&rows=10

Sample output of successful execution:

{
"result":
	{
	"returnCode": "0",
	"errorMessage": "Operation Successful.",
	"resultCount": 10,
	"Bean-List": {
		"ResourceCharacteristic-Bean":[
			{ "entityName": "Quality", "parentEntityName": "Overall" },
			{ "entityName": "Quality_measure", "parentEntityName": "Quality" },
			{ "entityName": "Effectiveness", "parentEntityName": "Quality" },
			{ "entityName": "Functionality", "parentEntityName": "Quality" },
			{ "entityName": "Availability", "parentEntityName": "Quality" },
			{ "entityName": "Serviceability", "parentEntityName": "Quality" },
			{ "entityName": "Serviceability_measure", "parentEntityName": "Serviceability" },
			{ "entityName": "Service Continuity", "parentEntityName": "Serviceability" },
			{ "entityName": "Supportability", "parentEntityName": "Serviceability" },
			{ "entityName": "Maintainability", "parentEntityName": "Serviceability" }
					   ]
		     }
	}
}