Documentation Center

Baseline 2.5 CompleteBaselineByCandidateAndMode

This method will generate a baseline report for the starting points selecting the versions in the following order:
  1. The highest version with a Candidate for baseline specified
  2. The version specified in the provided baseline
  3. The version matching the auto complete mode

CompleteBaselineByCandidateAndMode combines GetBaseline with CompleteReportByCandidateAndMode


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services, making this parameter redundant.
psBaselineIdStringInThe element name of the baseline.
psExtendBaselineIdStringInThe element name of the baseline which will be used to complete the Baseline (Report) XML.
peAutoCompleteModeeBaselineAutoCompleteModeInIndicates which auto complete mode must be used to select the version in the baseline report.
pasStartLogicalIdsStringArrayInString list with the logical identifiers that are used as starting points in the baseline reporting methods.
pasStartResourceLogicalIdsStringArrayInString list with the logical identifiers of the resources that are used as (extra) starting points in the baseline reporting methods.
pasLanguagesStringArrayInString list with the languages.
pasIllustrationLanguagesStringArrayInString list with the languages used for illustrations.
pasResourceLanguagesStringArrayInString list with the languages used for resources.
pasResolutionsStringArrayInString list with the resolutions.
psOutXMLBaselineReportStringOutA Baseline Report XML structure.

Requirements are:
  • The user must have read access for all objects used in the baseline
Note that:
  • When no baseline is found with the supplied psBaselineId, an InvalidObjectException is thrown.
  • When no extend baseline is provided, the incoming baseline is auto completed using the auto complete mode.
  • The parameters pasIllustrationLanguages and pasResourceLanguages contain extra (fallback) languages for the illustrations and the resources.
  • The pasResourceLanguages is not only used for the objects which are specified in the pasStartResourceLogicalIds parameter but also for all objects which are referenced by those objects.
  • When a library is referenced by a resource, the language information is retrieved in all languages which are specified in the parameters pasLanguages and pasResourceLanguages.
  • When an illustration is referenced by a resource, the language information is retrieved in all languages which are specified in the parameters pasLanguages, pasResourceLanguages AND pasIllustrationLanguages.
  • Objects which are present in the baseline but not referenced by one of the starting objects, are not returned in the Baseline Report XML.
  • Objects in the baseline for which the user has no read access are reported as missing.