Guida SDK › Open API › API Backward Compatibility › Changes to API › Changes to the API Interface

Changes to the API Interface

The following change was made to the API Interface.

• A new field called ParameterOrder was added to the ParameterData structure. This affects the following methods:
  • CreateContractMetric
  • CreateContractMetricParameter
  • AddContractParameter
  • CreateContractTemplateMetric
  • CreateContractTemplateMetricParameter
  • CreateContractTemplateParameter
  • CreateServiceDefinitionMetric
  • CreateServiceDefinitionMetricParameter
  • CreateServiceDefinitionParameter
  • GetContractMetricDetails
  • GetContractParameters
  • GetContractTemplateMetricDetails
  • GetContractTemplateParameters
  • GetServiceDefinitionParameters
  • GetServiceDefinitionMetricDetails
  • UpdateContractMetricParameter
  • UpdateContractParameter
  • UpdateContractMetricDetails
  • UpdateContractTemplateParameter
  • UpdateContractTemplateMetricParameter
  • UpdateContractTemplateMetricDetails
  • UpdateServiceDefinitionMetricParameter
  • UpdateServiceDefinitionMetricDetails
  • UpdateServiceDefinitionParameter

Remarks

Various API methods return a set of parameters containing a structure without any specific internal order.

The CreateContractMetric and UpdateContractMetricDetails methods (as well as others) get the MetricData structure with all metric parameters. As of version 7.0 Service Pack 1 the user can set the parameter order in this structure.

Note: The API does not check for consistency (more than one member can have the same ParameterOrder value. In this case, there is no way to know the precise internal order of members with a duplicated order).

Example

The GetContractParameters method returns a set of parameter data in which the new ParameterOrder field is assigned a value (e.g., 0,1,2, ..) If we want to change the order of any of the data we must change the value of the ParameterOrder field according to the desired order.