Web Services API data structures

This section provides reference information for the BMC Atrium Core Web Services API data structures. The BMC Atrium Core Web Services data structures are used as parameters for BMC Atrium Core Web Services operations. The data structures are categorized by the type of functions they perform, as listed in the following table.

List of data structures categorized by type

Data structure type	Data structure list
Common structures The common data structures are XML elements used by one or more web service operations.	AtriumBackendFault AtriumFault AtriumServiceFault AtriumServiceFaultType Attachment AttributeValue AttributeValueList AttributeValueListList ByteArray ByteList ByteListType ClassNameId ClassNameIdList ComplexExtensionType Coordinate CoordinateList Currency DatasetType DateTimeArray DiaryItem DiaryItemList DiaryValue ExpirationIn ExpirationOut	ExtensionList FunctionalCurrency FunctionalCurrencyList GetMask InstanceInfoOut InstanceInfoOutList IntArray Keyword Location LoginInfo NameValue NameValueList NullType SimpleExtensionType Status StatusList StatusOutput StatusType StringArray Value ValueList (page 352)
Business object structures Business Objects are an abstraction of a business entity (such as a service offering, contract, or organization) that models service-model information in a familiar way. A business object corresponds to BMC Atrium CMDB Common Data Model (CDM) classes. The following structures were designed specifically for work with business objects.	BOBusinessService BOContract BOContractLine BOContractLineList BOContractLineType BOContractType BOOffering BOOfferingBase BOOfferingLifeCycleStageType BOOfferingType BOOrganization BOPerson BORef BORefList BORequestableOffering BOService BOServiceBase BOServiceLevelTarget BOServiceLevelTargetList BOServiceLevelTargetType BOServiceOffering BOServiceOfferingList BOServiceType BOTechnicalService BOTechnicalServiceList BusinessObject BusinessObjectBase	BusinessObjectList CreateBusinessObject CreateBusinessObjectOutput CreateMultipleBusinessObjects CreateMultipleBusinessObjectsOutput DeleteBusinessObject DeleteMultipleBusinessObjects GetBusinessObject GetBusinessObjectOutput GetMultipleBusinessObjects GetMultipleBusinessObjectsOutput QueryBusinessObjectRefs QueryBusinessObjectRefsOutput QueryBusinessObjects QueryBusinessObjectsOutput SetBusinessObject SetBusinessObjectOutput SetMultipleBusinessObjects SetMultipleBusinessObjectsOutput
Atrium Audit structures The audit structures enable you to retrieve information about changes to relationship and CI classes in BMC Atrium CMDB.	AuditOperationType (atrium_audit) AuditValueList (atrium_audit)	AuditValueListList (atrium_audit)
Class structures The class structures enable you to work with relationship and CI classes in BMC Atrium CMDB.	AbstractType AttachmentLimit AttachPoolLimit AttributeAuditType AttributeCreateMode AttributeEntryMode AttributeInfoIn AttributeInfoList AttributeInfoOut AttributeLimit AttributeLimitBase AttributeType Cardinality CharLimit ClassAuditInfo ClassAuditType ClassDeleteOption ClassFederation ClassFederationRelationship ClassInfoIn ClassInfoOut ClassProperties ClassRegular ClassRelationship ClassType CreateAttribute CreateClass CurrencyDetail CurrencyDetailList CurrencyLimit DateLimit	DecimalLimit DeleteAttribute DeleteClass DiaryLimit EnumItem EnumItemList EnumLimit EnumStyle ExposureType GetAttributes GetAttributesOutput GetClass GetClassOutput IndexInfo IndexList IntLimit ListClasses ListClassesOutput Property PropertyList PropInfo PropInfoList RealLimit RelationType SchemaType SetAttribute SetClass TimeLimit TimeOfDayLimit WeakPropagatedAttrs WeakPropagatedAttrsList
Classic federation structures Classic federation structures see the data structures as defined in the atrium_classicfederation_200901.xsd file. The following data structures support the classic federation operations.	ActivateFederatedInContext ActivateFederatedInContextOutput FederatedAccessType FederatedAccessTypeAR FederatedActionType	FederatedActivateInfo FederatedActivationOption FederatedARInfo GetRelatedFederatedInContext GetRelatedFederatedInContextOutput
Classic reconciliation Classic reconciliation structures see the data structures as defined in the atrium_classicreconcilliation_200901.xsd file. The following data structures support the classic reconciliation operations.	CancelREJobRun (classic reconciliation) ClassQualifier (classic reconciliation) ClassQualifierList (classic reconciliation) DatasetPair (classic reconciliation) DatasetPairList (classic reconciliation) GetREJobRun (classic reconciliation) GetREJobRunList (classic reconciliation)	GetREJobRunListOutput (classic reconciliation) GetREJobRunOutput (classic reconciliation) REJobRunInfo REJobRunInfoList REJobRunStatusType StartREJobRun (classic reconciliation) StartREJobRunOutput (classic reconciliation)
Federated CMDB configuration structures These structures allow you to set up a federated CMDB for queries.	ClassSchemaDescription ClassSchemaDescriptionList ClassSchemaReference ClassSchemaReferenceList ClassToAttributesMapEntry ClassToAttributesMap CMDBfConfigurationParameters CMDBfConfigurationManifest CommonSchemaDescription	ElementDescription ElementDescriptionList ElementType ElementTypeList EnumerationValue EnumerationValues EnumerationValueList SchemaRelationshipDescription WSPolicyMapEntry WSPolicyMap XmlSchemaConstraintType
Dataset structures The dataset structures enable you to work with the datasets in BMC Atrium CMDB.	CreateDataset DatasetAccessType (datasets) DatasetInfo DatasetInfoList DeleteDataset	GetDataset GetDatasetOutput ListDatasets ListDatasetsOutput SetDataset
Graph query structures The graph query structures allow you to build a list of graph query objects with qualifications.	CreateSavedQuery DeleteSavedQuery (atrium_graphquery) EdgeList EdgeListArray ExecuteSavedQuery GetSavedQuery (atrium_graphquery) GetSavedQueryOutput (atrium_graphquery) GraphQuery GraphQueryInput GraphQueryObject GraphQueryOutput GraphQueryResult GraphQueryResultFormat NodeList NodeListArray QueryCardinality QueryCardinalityType QueryItem QueryItemList QueryQualifier (atrium_graphquery) QueryQualifierBase QueryQualifierOpAnd (atrium_graphquery) QueryQualifierOpAndOr (atrium_graphquery) QueryQualifierOpNot (atrium_graphquery) QueryQualifierOpOr (atrium_graphquery) QueryQualifierOperation (atrium_graphquery) QueryQualifierSetOp (atrium_graphquery)	QueryQualifierSetOpOperation (atrium_graphquery) QueryQualifierSimpleOp (atrium_graphquery) QueryQualifierValueTypeArithExpr (atrium_graphquery) QueryQualifierValueTypeAttributeName (atrium_graphquery) QueryQualifierValue (atrium_graphquery) QueryRelationship QueryRelationshipList QueryRelEndpoint QueryResultGraph (atrium_graphquery) QueryResultList QuerySort QuerySortArray RelationshipResult RelationshipResultArray SavedGraphQuery SavedQueryQualifierSimpleOp SavedQueryParameter SavedQueryParameterType SavedQueryParameterOption SavedQueryParameterValue SavedQueryParameterValueList SavedQueryRef SavedQueryRefList UpdateSavedQuery
Graph walk structures The graph walk structures enable you to work with the graph walk queries.	BeginGraphWalk BeginGraphWalkOutput EndGraphWalk GetGraphWalkStatus GetGraphWalkStatusOutput GraphWalkAttributeFlag GraphWalkObjectFlag GraphWalkQuery GraphWalkQueryMode GraphWalkRelation GraphWalkRelationArray GraphWalkRelationDirection	GraphWalkRelationList GraphWalkResult GraphWalkSelectorAndFilter GraphWalkSelectorAndFilterArray GraphWalkSelectorAndFilterList PullGraphWalkResults PullGraphWalkResultsOutput RenewGraphWalk RenewGraphWalkOutput
Instance structures The instance structures enable you to work with the CI or relationship class instances.	AuditOperationType (atrium_instances) AuditValueList (atrium_instances) AuditValueListList (atrium_instances) ComponentType CreateInstance CreateInstanceInfoIn CreateInstanceInfoInList CreateInstanceOutput CreateMultipleInstances CreateMultipleInstancesOutput DeleteInstance DeleteInstanceInfoIn DeleteInstanceInfoInList DeleteMultipleInstances GetCopyAuditData (atrium_instances)	GetCopyAuditDataOutput GetInstances GetInstancesOutput GetUIComponents GetUIComponentsOutput InstanceDeleteOption SetInstance SetInstanceInfoIn SetInstanceInfoInList SetMultipleInstances SortOrder SortOrderList SortOrderType UIComponentInfo UIComponentResult UIComponentResultList
Normalization structures Use normalization structures to help with the normalization of your data to minimize duplication of information and to help reduce data anomalies.	CancelNEJobRun ExportNEConfiguration ExportNEConfigurationOutput GetLastNEJobRunStatus GetLastNEJobRunStatusOutput GetNEJobRunStatus GetNEJobRunStatusOutput GetNormalizedInfoList GetNormalizedInfoListByFileInfo GetNormalizedInfoListByFPKey GetNormalizedInfoListByName GetNormalizedInfoListByPCKey ImportNEConfiguration ImportNEConfigurationOutput NEExportOptionType	NEExportOptionTypeList NEFileInfo NEFileInfoList NEImportOptionType NEJobRunInfo NEJobRunStatusType NEMultiMatchOptionType NENameInfo NENameInfoList NEQueryInfo NEQueryInfoList NEQueryResult NEQueryResultCriteriaType NEQueryResultList NEQueryResultListOutput NormalizeInstanceList ResumeNEJobRun ResumeNEJobRunOutput SetInstanceInfoInList StartNEJobRunOutput
Query structures The query structures allow you to build a list of query objects with qualifications.	DeleteSavedQuery (atrium_query) GetSavedQuery (atrium_graphquery) GetSavedQueryOutput (atrium_graphquery) ListSavedQueries (atrium_graphquery) ListSavedQueriesOutput (atrium_query) NestedQuery Query QueryArithOpType (atrium_graphquery) QueryByPath QueryByPathInput QueryByPathOutput QueryByPathXML QueryByPathXMLInput QueryExecuteOption QueryInput QueryInput2 QueryObject QueryObjectList QueryObjectRegular QueryObjectRelationship QueryObjectSel QueryObjectSelector QueryObjectSelectorList QueryObjectSelectorFlag QueryQualifier (atrium_query)	QueryQualifierAndOr QueryQualifierOpAnd (atrium_query) QueryQualifierOpNot (atrium_query) QueryQualifierOpOr (atrium_query) QueryQualifierOperation (atrium_query) QueryQualifierSetOp (atrium_query) QueryQualifierSetOpOperation (atrium_query) QueryQualifierSimpleOp (atrium_query) QueryQualifierValue (atrium_query) QueryQualifierValueSetSel QueryQualifierValueSetTypeQuery QueryQualifierValueSetTypeValueSet QueryQualifierValueTypeArithExpr (atrium_query) QueryQualifierValueTypeAttributeName (atrium_query) QueryQualifierValueTypeValue QueryResultGraph (atrium_query) RelationshipDirection SavedQueryData SavedQueryInfo SavedQueryInfoList
Reconciliation structures	CancelREJobRun (reconciliation) ClassQualifier (reconciliation) ClassQualifierList (reconciliation) DatasetPair (reconciliation) DatasetPairList GetREJobRun (reconciliation) GetREJobRunEvent GetREJobRunEventList GetREJobRunEventListOutput GetREJobRunEventOutput GetREJobRunList (reconciliation) GetREJobRunListOutput (reconciliation)	GetREJobRunOutput (reconciliation) JobRunStatusType PauseREJobRun QueryDateQualifier QueryDateSpan REJobRun REJobRunEvent REJobRunEventList REJobRunList ResumeREJobRun StartREJobRun (reconciliation) StartREJobRunOutput (reconciliation)
Service configuration structures	ConfigProperty ConfigPropertyList ConfigPropertyValue DeleteProperties DeletePropertiesOutput	GetProperties (service configuration) GetPropertiesOutput SetProperties SetPropertiesOutput
Service impact structures	DatasetAccessType (service impact) GetRelatedServices GetRelatedServicesOutput
Service utility structures	GetProperties (service utility) PropertyFileFormat
Version structures	GetVersions GetVersionsOutput VersionInfo VersionInfoList

Web Services API data structures

Comments