Web API ComplexType Reference

ComplexTypes represent structured data that doesn't have a key. Complex types are frequently returned as a response from using an Action or Function.

In This Section

Name Description
AddSolutionComponentResponse Contains the response from the AddSolutionComponent action.
AddToQueueResponse Contains the response from the AddToQueue action.
AddUserToRecordTeamResponse Contains the response from the AddUserToRecordTeam action.
AlmHandlerResponse Contains the response from the AlmHandler Action.
AnalyticsStoreDetails
AnalyzeResponse Contains the response from the Analyze Action.
AnalyzeSentimentResponse Contains the response from the AnalyzeSentiment Action.
AppointmentProposal Represents a proposed appointment time and date as a result of the Search function.
AppointmentRequest Provides the details of an appointment request for the Search function.
AppointmentsToIgnore Specifies the appointments to ignore in an appointment request from the Search function.
AppOverridableSettingInfo
AppSettingDetails
AppValidationResponse The response from App validation.
AssociatedMenuConfiguration Defines how the associated records are displayed for an entity relationship.
AttributeAuditDetail Contains the details of changes to entity attributes.
AttributeMapping For internal use only.
AttributePrivilege Specifies the field level security privileges allowed for an attribute.
AttributeQueryExpression Contains query to retrieve attribute metadata for entities retrieved using EntityQueryExpression ComplexType.
AttributeRequiredLevelManagedProperty Represents the data to define a RequiredLevel property for an attribute.
AttributeTypeDisplayName Provides a list of types of attributes used by AttributeMetadata.AttributeTypeName
AuditDetail Provides a base type for storing the details of data changes.
AuditDetailCollection Contains a collection of AuditDetail ComplexType variables.
AuditPartitionDetail Identifies a Microsoft SQL Server partition that is used to store changes to entity data records.
BackgroundSendEmailResponse Contains the response from BackgroundSendEmail action.
BatchGetFlowMachineStatusResponse Contains the response from the BatchGetFlowMachineStatus Action.
BatchPredictionResponse Contains the response from the BatchPrediction Action.
BookResponse Contains the response from the Book action.
BooleanManagedProperty Defines a managed property that stores a Boolean value.
BulkDeleteResponse The response from the BulkDelete Action.
BulkDetectDuplicatesResponse The response from the BulkDetectDuplicates Action.
BusinessEntityChanges The business entity changes from the RetrieveEntityChangesResponse.EntityChanges property
BusinessNotification For internal use only
BusinessNotificationParameter For internal use only.
CacheItem
CanBeReferencedResponse Contains the response from the CanBeReferenced action.
CanBeReferencingResponse Contains the response from the CanBeReferencing action
CancelTrainingResponse Contains the response from the CancelTraining Action.
CanManyToManyResponse Contains the response from the CanManyToMany action.
CanvasAppsDetails
CascadeConfiguration Contains properties representing actions that may be performed on the referenced entity in a one-to-many entity relationship.
CategorizeTextResponse Contains the response from the CategorizeText Action
CheckIncomingEmailResponse Contains the response from the CheckIncomingEmail function.
CheckPromoteEmailResponse Contains the response from the CheckPromoteEmail function.
CloneAsPatchResponse Contains the response from the CloneAsPatch action.
CloneAsSolutionResponse Contains the response from the CloneAsSolution action.
Collection_Int32_String
Collection_String_String
ColumnSet Specifies the attributes for which non-null values are returned from a query.
CommitAnnotationBlocksUploadResponse Contains the response from the CommitAnnotationBlocksUpload Action.
CommitAttachmentBlocksUploadResponse Contains the response from the CommitAttachmentBlocksUpload Action.
CommitFileBlocksUploadResponse Contains the response from the CommitFileBlocksUpload Action
ComplexAttributeMetadata Contains the metadata for a complex attribute.
ComplexBigIntAttributeMetadata
ComplexBooleanAttributeMetadata
ComplexBooleanOptionSetMetadata
ComplexDateTimeAttributeMetadata
ComplexDecimalAttributeMetadata
ComplexDoubleAttributeMetadata
ComplexEntityKeyMetadata Contains the metadata for a complex entity key.
ComplexEntityMetadata Contains the metadata for a complex entity.
ComplexEnumAttributeMetadata
ComplexFileAttributeMetadata
ComplexImageAttributeMetadata
ComplexIntegerAttributeMetadata
ComplexLookupAttributeMetadata The definition of a lookup attribute passed to the CreateCustomerRelationships Action Lookup parameter.
ComplexManagedPropertyAttributeMetadata
ComplexManyToManyRelationshipMetadata Contains the metadata for a many-to-many entity relationship.
ComplexMemoAttributeMetadata
ComplexMoneyAttributeMetadata
ComplexOneToManyRelationshipMetadata Contains the metadata for a one-to-many entity relationship.
ComplexOptionSetMetadata
ComplexStringAttributeMetadata
ComplexUniqueIdentifierAttributeMetadata
ComponentDetail Provides additional information about the solution components that are related to a missing component.
ConditionExpression An expression used to filter the results of the query.
ConstraintRelation Specifies additional constraints to be applied when you select resources for appointments.
CreateCustomerRelationshipsResponse The response from the CreateCustomerRelationships Action.
CreateExceptionResponse Contains the response from the CreateException action.
CreateHostedFlowMachineGroupResponse
CreateInstanceResponse Contains the response from the CreateInstance action.
CreatePolymorphicLookupAttributeResponse Contains the response from the CreatePolymorphicLookupAttribute Action
DateTimeBehavior Specifies the behavior of a DateTimeAttributeMetadata attribute using the DateTimeBehavior property.
DeleteAndPromoteResponse Contains the response from the DeleteAndPromote action.
DeleteAuditDataResponse Contains the response from the DeleteAuditData action.
DeletedMetadataCollection Contains deleted metadata.
DeleteRecordChangeHistoryResponse The response for the DeleteRecordChangeHistory action.
DetectLanguageResponse Contains the response from the DetectLanguage Action.
DownloadBlockResponse Contains the response from the DownloadBlock Action
DownloadReportDefinitionResponse Contains the response from the DownloadReportDefinition function.
DownloadSolutionExportDataResponse Contains the response from the DownloadSolutionExportData action.
EndpointCollection A collection of service endpoints.
EntityKeyQueryExpression Contains the details of retrieved entity keys.
EntityQueryExpression Contains the retrieved entity metadata.
EntityRecordCountCollection The collection of results for the RetrieveTotalRecordCount Function.
EntitySetting
ErrorInfo Specifies the results of a scheduling operation using the ValidateRequest, BookRequest, or Reschedule action.
ExpandCalendarResponse Contains the response from the ExpandCalendar function.
ExportComponentDetails
ExportComponentsParams
ExportFieldTranslationResponse Contains the response from the ExportFieldTranslation function.
ExportMappingsImportMapResponse The response from the ExportMappingsImportMap action.
ExportSolutionAsyncResponse Contains the response from the ExportSolutionAsync action.
ExportSolutionResponse Contains the response from the ExportSolution action.
ExportTranslationResponse Contains the response from the ExportTranslation action.
ExtractKeyPhrasesResponse Contains the response from the ExtractKeyPhrases Action.
ExtractTextEntitiesResponse Contains the response from the ExtractTextEntities Action.
FetchExpression
FetchXmlToQueryExpressionResponse The response from the FetchXmlToQueryExpression Action.
FileSasUrlResponse Contains data about a shared access signature (SAS) file
FilterExpression Specifies complex condition and logical filter expressions used for filtering the results of the query.
FormatAddressResponse Contains the response from the FormatAddress Function.
GenerateSharedLinkResponse Contains the response from the GenerateSharedLink Action.
GetAutoNumberSeedResponse Contains the response from the GetAutoNumberSeed Action.
GetDistinctValuesImportFileResponse The response from the GetDistinctValuesImportFile function.
GetFileSasUrlResponse Contains the response from the GetFileSasUrl Function.
GetHeaderColumnsImportFileResponse The response from the GetHeaderColumnsImportFile function.
GetJobStatusResponse Contains the response from the GetJobStatus Action.
GetNextAutoNumberValueResponse Contains the response from the GetNextAutoNumberValue Action
GetPublicKeyResponse Contains the response from the GetPublicKey Action.
GetReportHistoryLimitResponse Contains the response from the GetReportHistoryLimit function.
GetTimeZoneCodeByLocalizedNameResponse Contains the response from the GetTimeZoneCodeByLocalizedName function.
GetTrackingTokenEmailResponse Contains the response from the GetTrackingTokenEmail function.
GetValidManyToManyResponse Contains the response from the GetValidManyToMany function.
GetValidReferencedEntitiesResponse Contains the response from the GetValidReferencingEntities function.
GetValidReferencingEntitiesResponse Contains the response from the GetValidReferencingEntities function.
GuidCollection Contains the collection of unique identifiers.
IChangedItem The interface for the changed item.
ImmediateBookResponse Contains the response from the ImmediateBook Action.
ImportCardTypeSchemaResponse Contains the response from the ImportCardTypeSchema Action.
ImportSolutionAsyncResponse Contains the response from the ImportSolutionAsync action.
IngestResponse Contains the response from the Ingest Action.
InitializeAnnotationBlocksDownloadResponse Contains the response from the InitializeAnnotationBlocksDownload Action
InitializeAnnotationBlocksUploadResponse Contains the response from the InitializeAnnotationBlocksUpload Action.
InitializeAttachmentBlocksDownloadResponse Contains the response from the InitializeAttachmentBlocksDownload Action.
InitializeAttachmentBlocksUploadResponse Contains the response from the InitializeAttachmentBlocksUpload Action.
InitializeFileBlocksDownloadResponse Contains the response from the InitializeFileBlocksDownload Action.
InitializeFileBlocksUploadResponse Contains the response from the InitializeFileBlocksUpload Action.
InputArgument Contains custom application data.
InputArgumentCollection Contains a collection of InputArgument objects.
InsertOptionValueResponse Contains the response from the InsertOptionValue action.
InsertStatusValueResponse Contains the response from the InsertStatusValue action.
installResponse Contains the response from the install Action.
IsComponentCustomizableResponse Contains the response from the IsComponentCustomizable function.
IsDataEncryptionActiveResponse Contains the response from the IsDataEncryptionActive function.
IsPaiEnabledResponse Contains the response from the IsPaiEnabled Action.
IsPmEnabledResponse Contains the response from the IsPmEnabled  Action.
IsValidStateTransitionResponse Contains the response from the IsValidStateTransition function.
Label Contains a collection of translations for a label.
LabelQueryExpression Contains the languages for the labels to be retrieved for metadata items.
LayerDesiredOrder Holds data for a single hint. Internal use only.
LinkEntity Specifies the links between multiple entity types used in creating complex queries.
LocalizedLabel Contains a localized label, including the label string and the language code.
LocalTimeFromUtcTimeResponse Contains the response from the LocalTimeFromUtcTime Function.
MailboxTrackingFolderMapping Represents an individual folder-level tracking rule item in the MailboxTrackingFolderMappingCollection.
MemoFormatName
MetadataConditionExpression Contains a condition expression used to filter the results of the metadata query.
MetadataFilterExpression Contains logical filter expressions used for filtering the results of a metadata query.
MetadataPropertiesExpression Contains the properties for which non-null values are returned from a query.
MissingComponent Contains the data to describe a solution component that is required by a solution but not found in the system.
MissingDependency Provides information about a missing dependent solution component.
msdyn_DeleteCalendarResponse Contains the response from the msdyn_DeleteCalendar Action.
msdyn_MigrateSlaProactiveRunResponse Contains the response from the msdyn_MigrateSlaProactiveRun Action.
msdyn_SaveCalendarResponse Contains the response from the msdyn_SaveCalendar Action
msdyn_SLACustomTimeCalculationTemplateResponse Contains the response from the msdyn_SLACustomTimeCalculationTemplate Action.
msdyn_SLATimeCalculationResponse Contains the response from the msdyn_SLATimeCalculation Action.
Object Contains values to be passed as arguments.
ObjectiveRelation Contains the data that describes the scheduling strategy for an AppointmentRequest and that overrides the default constraints.
OptionMetadata Contains metadata representing an option within an Option set.
OrderExpression The order in which the entity instances are returned from the query.
OrganizationDetail Provides detailed information on an organization.
OrganizationInfo Provides information about the instance type and solutions available in an organization.
OrganizationResources Contains data regarding the resources used by an organization.
PagingInfo Specifies a number of pages and a number of entity instances per page to return from the query.
PredictByReferenceResponse Contains the response from the PredictByReference Action
PredictionSchemaResponse Contains the response from the PredictionSchema Action.
PredictResponse Contains the response from the PredictReponse Action.
PrincipalAccess Contains access rights information for the security principal (user or team).
ProposalParty Represents a party (user, team, or resource) that is needed for the proposed appointment.
PublishAIConfigurationResponse Contains the response from the PublishAIConfiguration Action.
PublishAllXmlAsyncResponse Contains the response from the PublishAllXmlAsync Action.
PvaCreateContentSnapshotResponse
PvaGetDirectLineEndpointResponse
PvaGetFeatureControlSetResponse
PvaGetUserBotsResponse
PvaPublishResponse
QueryBase The abstract base class for constructing a query.
QueryByAttribute
QueryExpression A complex query expressed in a hierarchy of expressions.
QueryExpressionToFetchXmlResponse Contains the response from the QueryExpressionToFetchXml Action.
QueryScheduleResponse Contains response from QuerySchedule function.
QuickTestResponse Contains the response from the QuickTest Action.
RecognizeTextResponse Contains the response from the RecognizeText Action.
RegisterFlowMachineResponse Contains the response from the RegisterFlowMachine Action.
RelationshipAttributeCT
RelationshipAuditDetail Contains the audited details of a change in a relationship.
RelationshipQueryExpression Contains a complex query to retrieve entity relationship metadata for entities retrieved using an EntityQueryExpression.
RemoveSolutionComponentResponse Contains the response from the RemoveSolutionComponent action.
RemoveUserFromRecordTeamResponse Contains the response from the RemoveUserFromRecordTeam action.
RequiredResource Specifies a resource that is required for a scheduling operation.
RescheduleResponse Contains the response from the Reschedule action.
ResourceInfo Contains information about a resource that has a scheduling problem for an appointment.
RetrieveAadUserPrivilegesResponse Contains the response from the RetrieveAadUserPrivileges Function.
RetrieveAadUserSetOfPrivilegesByIdsResponse Contains the response from the RetrieveAadUserSetOfPrivilegesByIds Function.
RetrieveAadUserSetOfPrivilegesByNamesResponse Contains the response from the RetrieveAadUserSetOfPrivilegesByNamesResponse Function.
RetrieveAbsoluteAndSiteCollectionUrlResponse The response from the RetrieveAbsoluteAndSiteCollectionUrl function.
RetrieveAccessOriginResponse Contains the response from the RetrieveAccessOrigin Function.
RetrieveAllEntitiesResponse Contains the response from the RetrieveAllEntities function.
RetrieveAnalyticsStoreDetailsResponse Contains the response from the RetrieveAnalyticsStoreDetails Function.
RetrieveApplicationRibbonResponse Contains the response from the RetrieveApplicationRibbon function.
RetrieveAttributeChangeHistoryResponse Contains the response from RetrieveAttributeChangeHistory function.
RetrieveAuditDetailsResponse Contains the response from RetrieveAuditDetails function.
RetrieveAuditPartitionListResponse Contains the response from the RetrieveAuditPartitionList function.
RetrieveAvailableLanguagesResponse Contains the response from the RetrieveAvailableLanguages function.
RetrieveCascadeAssignAsyncJobIdResponse Contains the response from the RetrieveCascadeDeleteAsyncJobId Function.
RetrieveCascadeDeleteAsyncJobIdResponse
RetrieveCurrentOrganizationResponse Contains the response from processing RetrieveCurrentOrganization function.
RetrieveDataEncryptionKeyResponse Contains the response from the RetrieveDataEncryptionKey function.
RetrieveDeploymentLicenseTypeResponse Contains the response from the RetrieveDeploymentLicenseType function.
RetrieveDeprovisionedLanguagesResponse Contains the response from the RetrieveDeprovisionedLanguages function.
RetrieveEntityResponse Contains the response from RetrieveEntity function.
RetrieveEntityRibbonResponse Contains the response from the RetrieveEntityRibbon function.
RetrieveEnvironmentVariableValueResponse
RetrieveExchangeRateResponse Contains the response from the RetrieveExchangeRate function.
RetrieveFinanceAndOperationsIntegrationDetailsResponse Contains the response from the RetrieveFinanceAndOperationsIntegrationDetails Function.
RetrieveFormattedImportJobResultsResponse Contains the response from the RetrieveFormattedImportJobResults function.
RetrieveInstalledLanguagePacksResponse Contains the response from the RetrieveInstalledLanguagePacks function.
RetrieveInstalledLanguagePackVersionResponse Contains the response from the RetrieveInstalledLanguagePackVersion function.
RetrieveLicenseInfoResponse Contains the response from the RetrieveLicenseInfo function.
RetrieveLocLabelsResponse Contains the response from the RetrieveLocLabels function.
RetrieveMailboxTrackingFoldersResponse Contains the response from the RetrieveMailboxTrackingFolders function.
RetrieveMetadataChangesResponse Contains the response from RetrieveMetadataChanges function.
RetrieveMissingComponentsResponse Contains the response from the RetrieveMissingComponents function.
RetrieveOrganizationInfoResponse Contains the response from the RetrieveOrganizationInfo Function.
RetrieveOrganizationResourcesResponse Contains the response from the RetrieveOrganizationResources function.
RetrieveParsedDataImportFileResponse Contains the response from the RetrieveParsedDataImportFile function.
RetrievePrincipalAccessResponse Contains the response from the RetrievePrincipalAccess function.
RetrievePrincipalAttributePrivilegesResponse Contains the response from the RetrievePrincipalAttributePrivileges function.
RetrievePrincipalSyncAttributeMappingsResponse Contains the response from the RetrievePrincipalSyncAttributeMappings function.
RetrieveProvisionedLanguagePackVersionResponse Contains the response from the RetrieveProvisionedLanguagePackVersion function.
RetrieveProvisionedLanguagesResponse Contains the response from the RetrieveProvisionedLanguages function.
RetrieveRecordChangeHistoryResponse Contains the response from RetrieveRecordChangeHistory function.
RetrieveRolePrivilegesRoleResponse Contains the response from the RetrieveRolePrivilegesRole function.
RetrieveSettingResponse Contains the response from the RetrieveSetting Function.
RetrieveSharedPrincipalsAndAccessResponse Contains the response from RetrieveSharedPrincipalsAndAccess function.
RetrieveTeamPrivilegesResponse Contains the response from the RetrieveTeamPrivileges function.
RetrieveTimelineWallRecordsResponse Contains the response from the RetrieveTimelineWallRecords Function.
RetrieveTimestampResponse Contains the response from the RetrieveTimestamp function.
RetrieveTotalRecordCountResponse Contains the response from the RetrieveTotalRecordCount Function.
RetrieveUserLicenseInfoResponse Contains the response from the RetrieveUserLicenseInfo function.
RetrieveUserPrivilegeByPrivilegeIdResponse Contains the response from the RetrieveUserPrivilegeByPrivilegeId Function.
RetrieveUserPrivilegeByPrivilegeNameResponse Contains the response from the RetrieveUserPrivilegeByPrivilegeName Function.
RetrieveUserPrivilegesResponse Contains the response from the RetrieveUserPrivileges function.
RetrieveUserSetOfPrivilegesByIdsResponse Contains the response from the RetrieveUserSetOfPrivilegesByIdsResponse Function.
RetrieveUserSetOfPrivilegesByNamesResponse Contains the response from the RetrieveUserSetOfPrivilegesByNamesResponse Function.
RetrieveUsersPrivilegesThroughTeamsResponse Contains the response from the RetrieveUsersPrivilegesThroughTeams Function.
RetrieveVersionResponse Contains the response from the RetrieveVersion function.
RolePrivilege Contains information about a privilege.
RolePrivilegeAuditDetail Represents audited changes to the privileges of a security role.
RunDesktopFlowResponse Contains the response from the RunDesktopFlow Action.
SchedulePredictionResponse Contains the response from the SchedulePrediction Action.
ScheduleRetrainResponse Contains the response from the ScheduleRetrain Action.
ScheduleTrainingResponse Contains the response from the ScheduleTraining Action.
searchautocompleteResponse Contains the response from the searchautocomplete Action.
searchqueryResponse Contains the response from the searchquery Action.
SearchResponse Contains the response from the Search function.
SearchResults Contains the results from the Search action.
searchstatisticsResponse Contains the response from the searchstatistics Action.
searchstatusResponse Contains the response from the searchstatus Action.
searchsuggestResponse Contains the response from the searchsuggest Action.
SecurityPrivilegeMetadata The metadata that describes a security privilege for access to an entity.
SendEmailResponse Contains the response from the BackgroundSendEmail action.
ServicePlanCT Contains information about a service plan assigned to a system user.
SettingDetail Provides information about a setting.
ShareAuditDetail A shared audit detail record.
ShareResponse Contains the response from the Share Action.
Solution Contains information about a solution in an organization.
SolutionComponentDetails Provides detailed information about a solution component.
SolutionComponentOption
SolutionDetails Provides detailed information about a solution.
SolutionInfo Contains information about the details of the solution. Internal use only.
SolutionParameters Additional solution parameters.
SolutionValidationResult The result returned from validating the solution.
StageAndUpgradeResponse Contains the response from the StageAndUpgrade Action.
StageSolutionResponse Contains the response from the StageSolution action.
StageSolutionResults Contains detailed information from staging a solution.
StateOptionMetadata Contains data to define an option for the options in a State attribute.
StatusOptionMetadata Contains one of the possible values for an attribute of type status.
StringCollection Collection of strings.
StringFormatName Specifies the format of a StringAttributeMetadata attribute using the FormatName property.
SubscriptionEntityMetadata
SubscriptionUpdatedEntityData
SyncBulkOperationResponse Contains the response from the SyncBulkOperation Action.
TimeInfo Specifies a set of time blocks with appointment information.
TraceInfo Contains the results of a scheduling operation using the ValidateRequest, BookRequest, RescheduleRequest, or Search actions.
TrainResponse Contains the response from the Train Action.
UnpublishAIConfigurationResponse Contains the response from the UnpublishAIConfiguration Action.
UnschedulePredictionResponse Contains the response from the UnschedulePrediction Action.
UnscheduleTrainingResponse Contains the response from the UnscheduleTraining Action.
UserAccessAuditDetail Contains data used for user access auditing.
UserLicenseInfo Contains information about the service plans that a system user has access to.
ValidateAIConfigurationResponse Contains the response from the ValidateAIConfiguration Action.
ValidateAppResponse Contains the response from the ValidateApp Function.
ValidateFetchXmlExpressionResponse
ValidateFetchXmlExpressionResult
ValidateRecurrenceRuleResponse Contains the response from the ValidateRecurrenceRule function.
ValidateResponse Contains the response from the Validate action.
ValidationResult Contains the result from the ValidateRequest, BookRequest, or Reschedule actions.
ValidatorIssue
WhoAmIResponse Contains the response from WhoAmI function.
XrmAttributeExpression Contains data to specify aggregation.

See also