Package-level declarations

Types

Link copied to clipboard
data class AssignmentPrincipalResponse(val principalId: String, val principalMetadata: Map<String, String>? = null, val principalType: String)

The AssignmentPrincipal

Link copied to clipboard
data class CanonicalProfileDefinitionResponse(val canonicalProfileId: Int? = null, val properties: List<CanonicalProfileDefinitionResponseProperties>? = null)

Definition of canonical profile.

data class CanonicalProfileDefinitionResponseProperties(val profileName: String? = null, val profilePropertyName: String? = null, val rank: Int? = null, val type: String? = null, val value: String? = null)

The definition of a canonical profile property.

Link copied to clipboard
data class ConnectorMappingAvailabilityResponse(val frequency: String? = null, val interval: Int)

Connector mapping property availability.

data class ConnectorMappingCompleteOperationResponse(val completionOperationType: String? = null, val destinationFolder: String? = null)

The complete operation.

Link copied to clipboard
data class ConnectorMappingErrorManagementResponse(val errorLimit: Int? = null, val errorManagementType: String)

The error management.

Link copied to clipboard
data class ConnectorMappingFormatResponse(val acceptLanguage: String? = null, val arraySeparator: String? = null, val columnDelimiter: String? = null, val formatType: String, val quoteCharacter: String? = null, val quoteEscapeCharacter: String? = null)

Connector mapping property format.

Link copied to clipboard
data class ConnectorMappingPropertiesResponse(val availability: ConnectorMappingAvailabilityResponse, val completeOperation: ConnectorMappingCompleteOperationResponse, val errorManagement: ConnectorMappingErrorManagementResponse, val fileFilter: String? = null, val folderPath: String? = null, val format: ConnectorMappingFormatResponse, val hasHeader: Boolean? = null, val structure: List<ConnectorMappingStructureResponse>)

The connector mapping properties.

Link copied to clipboard
data class ConnectorMappingStructureResponse(val columnName: String, val customFormatSpecifier: String? = null, val isEncrypted: Boolean? = null, val propertyName: String)

Connector mapping property structure.

Link copied to clipboard
data class DataSourcePrecedenceResponse(val dataSourceReferenceId: String, val dataSourceType: String, val id: Int, val name: String, val precedence: Int? = null, val status: String)

The data source precedence is a way to know the precedence of each data source.

Link copied to clipboard
data class GetConnectorMappingResult(val azureApiVersion: String, val connectorMappingName: String, val connectorName: String, val connectorType: String? = null, val created: String, val dataFormatId: String, val description: String? = null, val displayName: String? = null, val entityType: String, val entityTypeName: String, val id: String, val lastModified: String, val mappingProperties: ConnectorMappingPropertiesResponse, val name: String, val nextRunTime: String, val runId: String, val state: String, val tenantId: String, val type: String)

The connector mapping resource format.

Link copied to clipboard
data class GetConnectorResult(val azureApiVersion: String, val connectorId: Int, val connectorName: String? = null, val connectorProperties: Map<String, Any>, val connectorType: String, val created: String, val description: String? = null, val displayName: String? = null, val id: String, val isInternal: Boolean? = null, val lastModified: String, val name: String, val state: String, val tenantId: String, val type: String)

The connector resource format.

Link copied to clipboard
data class GetHubResult(val apiEndpoint: String, val azureApiVersion: String, val hubBillingInfo: HubBillingInfoFormatResponse? = null, val id: String, val location: String? = null, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val tenantFeatures: Int? = null, val type: String, val webEndpoint: String)

Hub resource.

Link copied to clipboard
data class GetImageUploadUrlForDataResult(val contentUrl: String? = null, val imageExists: Boolean? = null, val relativePath: String? = null)

The image definition.

Link copied to clipboard
data class GetImageUploadUrlForEntityTypeResult(val contentUrl: String? = null, val imageExists: Boolean? = null, val relativePath: String? = null)

The image definition.

Link copied to clipboard
data class GetKpiResult(val aliases: List<KpiAliasResponse>? = null, val azureApiVersion: String, val calculationWindow: String, val calculationWindowFieldName: String? = null, val description: Map<String, String>? = null, val displayName: Map<String, String>? = null, val entityType: String, val entityTypeName: String, val expression: String, val extracts: List<KpiExtractResponse>? = null, val filter: String? = null, val function: String, val groupBy: List<String>? = null, val groupByMetadata: List<KpiGroupByMetadataResponse>, val id: String, val kpiName: String, val name: String, val participantProfilesMetadata: List<KpiParticipantProfilesMetadataResponse>, val provisioningState: String, val tenantId: String, val thresHolds: KpiThresholdsResponse? = null, val type: String, val unit: String? = null)

The KPI resource format.

Link copied to clipboard
data class GetLinkResult(val azureApiVersion: String, val description: Map<String, String>? = null, val displayName: Map<String, String>? = null, val id: String, val linkName: String, val mappings: List<TypePropertiesMappingResponse>? = null, val name: String, val operationType: String? = null, val participantPropertyReferences: List<ParticipantPropertyReferenceResponse>, val provisioningState: String, val referenceOnly: Boolean? = null, val sourceEntityType: String, val sourceEntityTypeName: String, val targetEntityType: String, val targetEntityTypeName: String, val tenantId: String, val type: String)

The link resource format.

Link copied to clipboard
data class GetPredictionModelStatusResult(val message: String, val modelVersion: String, val predictionGuidId: String, val predictionName: String, val signalsUsed: Int, val status: String, val tenantId: String, val testSetCount: Int, val trainingAccuracy: Int, val trainingSetCount: Int, val validationSetCount: Int)

The prediction model status.

Link copied to clipboard
data class GetPredictionResult(val autoAnalyze: Boolean, val azureApiVersion: String, val description: Map<String, String>? = null, val displayName: Map<String, String>? = null, val grades: List<PredictionResponseGrades>? = null, val id: String, val involvedInteractionTypes: List<String>? = null, val involvedKpiTypes: List<String>? = null, val involvedRelationships: List<String>? = null, val mappings: PredictionResponseMappings, val name: String, val negativeOutcomeExpression: String, val positiveOutcomeExpression: String, val predictionName: String? = null, val primaryProfileType: String, val provisioningState: String, val scopeExpression: String, val scoreLabel: String, val systemGeneratedEntities: PredictionResponseSystemGeneratedEntities, val tenantId: String, val type: String)

The prediction resource format.

Link copied to clipboard
data class GetPredictionTrainingResultsResult(val canonicalProfiles: List<CanonicalProfileDefinitionResponse>, val predictionDistribution: PredictionDistributionDefinitionResponse, val primaryProfileInstanceCount: Double, val scoreName: String, val tenantId: String)

The training results of the prediction.

Link copied to clipboard
data class GetProfileResult(val apiEntitySetName: String? = null, val attributes: Map<String, List<String>>? = null, val azureApiVersion: String, val description: Map<String, String>? = null, val displayName: Map<String, String>? = null, val entityType: String? = null, val fields: List<PropertyDefinitionResponse>? = null, val id: String, val instancesCount: Int? = null, val largeImage: String? = null, val lastChangedUtc: String, val localizedAttributes: Map<String, Map<String, String>>? = null, val mediumImage: String? = null, val name: String, val provisioningState: String, val schemaItemTypeLink: String? = null, val smallImage: String? = null, val strongIds: List<StrongIdResponse>? = null, val tenantId: String, val timestampFieldName: String? = null, val type: String, val typeName: String? = null)

The profile resource format.

Link copied to clipboard
data class GetRelationshipLinkResult(val azureApiVersion: String, val description: Map<String, String>? = null, val displayName: Map<String, String>? = null, val id: String, val interactionType: String, val linkName: String, val mappings: List<RelationshipLinkFieldMappingResponse>? = null, val name: String, val profilePropertyReferences: List<ParticipantProfilePropertyReferenceResponse>, val provisioningState: String, val relatedProfilePropertyReferences: List<ParticipantProfilePropertyReferenceResponse>, val relationshipGuidId: String, val relationshipName: String, val tenantId: String, val type: String)

The relationship link resource format.

Link copied to clipboard
data class GetRelationshipResult(val azureApiVersion: String, val cardinality: String? = null, val description: Map<String, String>? = null, val displayName: Map<String, String>? = null, val expiryDateTimeUtc: String? = null, val fields: List<PropertyDefinitionResponse>? = null, val id: String, val lookupMappings: List<RelationshipTypeMappingResponse>? = null, val name: String, val profileType: String, val provisioningState: String, val relatedProfileType: String, val relationshipGuidId: String, val relationshipName: String, val tenantId: String, val type: String)

The relationship resource format.

Link copied to clipboard
data class GetRoleAssignmentResult(val assignmentName: String, val azureApiVersion: String, val conflationPolicies: ResourceSetDescriptionResponse? = null, val connectors: ResourceSetDescriptionResponse? = null, val description: Map<String, String>? = null, val displayName: Map<String, String>? = null, val id: String, val interactions: ResourceSetDescriptionResponse? = null, val kpis: ResourceSetDescriptionResponse? = null, val links: ResourceSetDescriptionResponse? = null, val name: String, val principals: List<AssignmentPrincipalResponse>, val profiles: ResourceSetDescriptionResponse? = null, val provisioningState: String, val relationshipLinks: ResourceSetDescriptionResponse? = null, val relationships: ResourceSetDescriptionResponse? = null, val role: String, val roleAssignments: ResourceSetDescriptionResponse? = null, val sasPolicies: ResourceSetDescriptionResponse? = null, val segments: ResourceSetDescriptionResponse? = null, val tenantId: String, val type: String, val views: ResourceSetDescriptionResponse? = null, val widgetTypes: ResourceSetDescriptionResponse? = null)

The Role Assignment resource format.

Link copied to clipboard
data class GetViewResult(val azureApiVersion: String, val changed: String, val created: String, val definition: String, val displayName: Map<String, String>? = null, val id: String, val name: String, val tenantId: String, val type: String, val userId: String? = null, val viewName: String)

The view resource format.

Link copied to clipboard
data class HubBillingInfoFormatResponse(val maxUnits: Int? = null, val minUnits: Int? = null, val skuName: String? = null)

Hub billing info.

Link copied to clipboard
data class KpiAliasResponse(val aliasName: String, val expression: String)

The KPI alias.

Link copied to clipboard
data class KpiExtractResponse(val expression: String, val extractName: String)

The KPI extract.

Link copied to clipboard
data class KpiGroupByMetadataResponse(val displayName: Map<String, String>? = null, val fieldName: String? = null, val fieldType: String? = null)

The KPI GroupBy field metadata.

Link copied to clipboard

The KPI participant profile metadata.

Link copied to clipboard
data class KpiThresholdsResponse(val increasingKpi: Boolean, val lowerLimit: Double, val upperLimit: Double)

Defines the KPI Threshold limits.

data class ParticipantProfilePropertyReferenceResponse(val interactionPropertyName: String, val profilePropertyName: String)

The participant profile property reference.

Link copied to clipboard
data class ParticipantPropertyReferenceResponse(val sourcePropertyName: String, val targetPropertyName: String)

The participant property reference.

Link copied to clipboard
data class PredictionDistributionDefinitionResponse(val distributions: List<PredictionDistributionDefinitionResponseDistributions>? = null, val totalNegatives: Double? = null, val totalPositives: Double? = null)

The definition of the prediction distribution.

data class PredictionDistributionDefinitionResponseDistributions(val negatives: Double? = null, val negativesAboveThreshold: Double? = null, val positives: Double? = null, val positivesAboveThreshold: Double? = null, val scoreThreshold: Int? = null)

The definition of a prediction distribution.

Link copied to clipboard
data class PredictionResponseGrades(val gradeName: String? = null, val maxScoreThreshold: Int? = null, val minScoreThreshold: Int? = null)

The definition of a prediction grade.

Link copied to clipboard
data class PredictionResponseMappings(val grade: String, val reason: String, val score: String)

Definition of the link mapping of prediction.

data class PredictionResponseSystemGeneratedEntities(val generatedInteractionTypes: List<String>? = null, val generatedKpis: Map<String, String>? = null, val generatedLinks: List<String>? = null)

System generated entities.

Link copied to clipboard
data class ProfileEnumValidValuesFormatResponse(val localizedValueNames: Map<String, String>? = null, val value: Int? = null)

Valid enum values in case of an enum property.

Link copied to clipboard
data class PropertyDefinitionResponse(val arrayValueSeparator: String? = null, val dataSourcePrecedenceRules: List<DataSourcePrecedenceResponse>, val enumValidValues: List<ProfileEnumValidValuesFormatResponse>? = null, val fieldName: String, val fieldType: String, val isArray: Boolean? = null, val isAvailableInGraph: Boolean? = null, val isEnum: Boolean? = null, val isFlagEnum: Boolean? = null, val isImage: Boolean? = null, val isLocalizedString: Boolean? = null, val isName: Boolean? = null, val isRequired: Boolean? = null, val maxLength: Int? = null, val propertyId: String? = null, val schemaItemPropLink: String? = null)

Property definition.

Link copied to clipboard
data class RelationshipLinkFieldMappingResponse(val interactionFieldName: String, val linkType: String? = null, val relationshipFieldName: String)

The fields mapping for Relationships.

Link copied to clipboard
data class RelationshipTypeFieldMappingResponse(val profileFieldName: String, val relatedProfileKeyProperty: String)

Map a field of profile to its corresponding StrongId in Related Profile.

Link copied to clipboard

Maps fields in Profile to their corresponding StrongIds in Related Profile.

Link copied to clipboard
data class ResourceSetDescriptionResponse(val elements: List<String>? = null, val exceptions: List<String>? = null)

The resource set description.

Link copied to clipboard
data class StrongIdResponse(val description: Map<String, String>? = null, val displayName: Map<String, String>? = null, val keyPropertyNames: List<String>, val strongIdName: String)

Property/Properties which represent a unique ID.

Link copied to clipboard
data class TypePropertiesMappingResponse(val linkType: String? = null, val sourcePropertyName: String, val targetPropertyName: String)

Metadata for a Link's property mapping.