interactions

Creates, updates, deletes, gets or lists a interactions resource.

Overview

Name	interactions
Type	Resource
Id	azure_extras.customer_insights.interactions

Fields

vw_interactions

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
api_entity_set_name	text	field from the properties object
data_source_precedence_rules	text	field from the properties object
default_data_source	text	field from the properties object
entity_type	text	field from the properties object
fields	text	field from the properties object
hubName	text	field from the properties object
id_property_names	text	field from the properties object
instances_count	text	field from the properties object
interactionName	text	field from the properties object
is_activity	text	field from the properties object
last_changed_utc	text	field from the properties object
participant_profiles	text	field from the properties object
primary_participant_profile_property_name	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
schema_item_type_link	text	field from the properties object
subscriptionId	text	field from the properties object
tenant_id	text	field from the properties object
timestamp_field_name	text	field from the properties object
type	text	Resource type.
type_name	text	field from the properties object

interactions

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The Interaction Type Definition
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hubName, interactionName, resourceGroupName, subscriptionId	Gets information about the specified interaction.
list_by_hub	SELECT	hubName, resourceGroupName, subscriptionId	Gets all interactions in the hub.
create_or_update	INSERT	hubName, interactionName, resourceGroupName, subscriptionId	Creates an interaction or updates an existing interaction within a hub.
suggest_relationship_links	EXEC	hubName, interactionName, resourceGroupName, subscriptionId	Suggests relationships to create relationship links.

SELECT examples

Gets all interactions in the hub.

vw_interactions

SELECT
id,
name,
api_entity_set_name,
data_source_precedence_rules,
default_data_source,
entity_type,
fields,
hubName,
id_property_names,
instances_count,
interactionName,
is_activity,
last_changed_utc,
participant_profiles,
primary_participant_profile_property_name,
provisioning_state,
resourceGroupName,
schema_item_type_link,
subscriptionId,
tenant_id,
timestamp_field_name,
type,
type_name
FROM azure_extras.customer_insights.vw_interactions
WHERE hubName = '{{ hubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

interactions

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.interactions
WHERE hubName = '{{ hubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new interactions resource.

All Properties

/*+ create */
INSERT INTO azure_extras.customer_insights.interactions (
hubName,
interactionName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ hubName }}',
'{{ interactionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: apiEntitySetName
          value: string
        - name: entityType
          value: string
        - name: fields
          value:
            - - name: arrayValueSeparator
                value: string
              - name: enumValidValues
                value:
                  - - name: value
                      value: integer
                    - name: localizedValueNames
                      value: object
              - name: fieldName
                value: string
              - name: fieldType
                value: string
              - name: isArray
                value: boolean
              - name: isEnum
                value: boolean
              - name: isFlagEnum
                value: boolean
              - name: isImage
                value: boolean
              - name: isLocalizedString
                value: boolean
              - name: isName
                value: boolean
              - name: isRequired
                value: boolean
              - name: propertyId
                value: string
              - name: schemaItemPropLink
                value: string
              - name: maxLength
                value: integer
              - name: isAvailableInGraph
                value: boolean
              - name: dataSourcePrecedenceRules
                value:
                  - - name: dataSource
                      value:
                        - name: name
                          value: string
                        - name: dataSourceType
                          value: string
                        - name: status
                          value: string
                        - name: id
                          value: integer
                        - name: dataSourceReferenceId
                          value: string
                    - name: precedence
                      value: integer
        - name: instancesCount
          value: integer
        - name: lastChangedUtc
          value: string
        - name: provisioningState
          value: []
        - name: schemaItemTypeLink
          value: string
        - name: tenantId
          value: string
        - name: timestampFieldName
          value: string
        - name: typeName
          value: string
        - name: idPropertyNames
          value:
            - string
        - name: participantProfiles
          value:
            - - name: profileTypeName
                value: string
              - name: participantPropertyReferences
                value:
                  - - name: sourcePropertyName
                      value: string
                    - name: targetPropertyName
                      value: string
              - name: participantName
                value: string
              - name: displayName
                value: object
              - name: description
                value: object
              - name: role
                value: string
        - name: primaryParticipantProfilePropertyName
          value: string
        - name: dataSourcePrecedenceRules
          value:
            - - name: precedence
                value: integer
        - name: isActivity
          value: boolean
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string