swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector RelationshipLinks API
schemes:
- https
tags:
- name: RelationshipLinks
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationshipLinks/{relationshipLinkName}
  : put:
      tags:
      - RelationshipLinks
      operationId: microsoftAzureRelationshiplinksCreateorupdate
      x-ms-examples:
        RelationshipLinks_CreateOrUpdate:
          $ref: ./examples/RelationshipLinksCreateOrUpdate.json
      description: Creates a relationship link or updates an existing relationship link within a hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: relationshipLinkName
        in: path
        required: true
        type: string
        description: The name of the relationship link.
        pattern: ^[a-zA-Z][a-zA-Z0-9_]+$
        minLength: 1
        maxLength: 512
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/RelationshipLinkResourceFormat'
        description: Parameters supplied to the CreateOrUpdate relationship link operation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully created the relationship link.
          schema:
            $ref: '#/definitions/RelationshipLinkResourceFormat'
        '202':
          description: Accepted. The create relationship operation is accepted.
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Relationshiplinks Relationshiplinkname
    get:
      tags:
      - RelationshipLinks
      operationId: microsoftAzureRelationshiplinksGet
      x-ms-examples:
        RelationshipLinks_Get:
          $ref: ./examples/RelationshipLinksGet.json
      description: Gets information about the specified relationship Link.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: relationshipLinkName
        in: path
        required: true
        type: string
        description: The name of the relationship link.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get the relationship link.
          schema:
            $ref: '#/definitions/RelationshipLinkResourceFormat'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Relationshiplinks Relationshiplinkname
    delete:
      tags:
      - RelationshipLinks
      operationId: microsoftAzureRelationshiplinksDelete
      x-ms-examples:
        RelationshipLinks_Delete:
          $ref: ./examples/RelationshipLinksDelete.json
      description: Deletes a relationship link within a hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - name: relationshipLinkName
        in: path
        required: true
        type: string
        description: The name of the relationship.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. The relationship link is deleted.
        '202':
          description: Accepted. The delete operation is accepted.
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Relationshiplinks Relationshiplinkname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationshipLinks
  : get:
      tags:
      - RelationshipLinks
      operationId: microsoftAzureRelationshiplinksListbyhub
      x-ms-examples:
        RelationshipLinks_ListByHub:
          $ref: ./examples/RelationshipLinksListByHub.json
      description: Gets all relationship links in the hub.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: hubName
        in: path
        required: true
        type: string
        description: The name of the hub.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: OK. Successfully get all the relationship links in the hub.
          schema:
            $ref: '#/definitions/RelationshipLinkListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Relationshiplinks
definitions:
  RelationshipLinkResourceFormat:
    description: The relationship link resource format.
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/RelationshipLinkDefinition'
    allOf:
    - $ref: '#/definitions/ProxyResource'
  RelationshipLinkFieldMapping:
    required:
    - interactionFieldName
    - relationshipFieldName
    properties:
      interactionFieldName:
        type: string
        description: The field name on the Interaction Type.
      linkType:
        type: string
        enum:
        - UpdateAlways
        - CopyIfNull
        x-ms-enum:
          name: LinkTypes
          modelAsString: false
        description: Link type.
      relationshipFieldName:
        type: string
        description: The field name on the Relationship metadata.
    description: The fields mapping for Relationships.
  ProxyResource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource ID.
      name:
        readOnly: true
        type: string
        description: Resource name.
      type:
        readOnly: true
        type: string
        description: Resource type.
    x-ms-azure-resource: true
    description: Common properties of proxy resource.
  RelationshipLinkDefinition:
    required:
    - interactionType
    - profilePropertyReferences
    - relatedProfilePropertyReferences
    - relationshipName
    properties:
      displayName:
        type: object
        additionalProperties:
          type: string
        description: Localized display name for the Relationship Link.
      description:
        type: object
        additionalProperties:
          type: string
        description: Localized descriptions for the Relationship Link.
      interactionType:
        type: string
        description: The InteractionType associated with the Relationship Link.
      linkName:
        type: string
        readOnly: true
        description: The name of the Relationship Link.
      mappings:
        type: array
        items:
          $ref: '#/definitions/RelationshipLinkFieldMapping'
        description: The mappings between Interaction and Relationship fields.
      profilePropertyReferences:
        type: array
        items:
          $ref: '#/definitions/ParticipantProfilePropertyReference'
        description: The property references for the Profile of the Relationship.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
        description: Provisioning state.
      relatedProfilePropertyReferences:
        type: array
        items:
          $ref: '#/definitions/ParticipantProfilePropertyReference'
        description: The property references for the Related Profile of the Relationship.
      relationshipName:
        type: string
        description: The Relationship associated with the Link.
      relationshipGuidId:
        type: string
        readOnly: true
        description: The relationship guid id.
      tenantId:
        type: string
        readOnly: true
        description: The hub name.
    description: The definition of relationship link.
  ProvisioningState:
    type: string
    enum:
    - Provisioning
    - Succeeded
    - Expiring
    - Deleting
    - HumanIntervention
    - Failed
    x-ms-enum:
      name: ProvisioningStates
      modelAsString: true
    description: Provisioning state.
  RelationshipLinkListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/RelationshipLinkResourceFormat'
        description: Results of the list operation.
      nextLink:
        type: string
        description: Link to the next set of results.
    description: The response of list relationship link operation.
  ParticipantProfilePropertyReference:
    required:
    - interactionPropertyName
    - profilePropertyName
    properties:
      interactionPropertyName:
        type: string
        description: The source interaction property that maps to the target profile property.
      profilePropertyName:
        type: string
        description: The target profile property that maps to the source interaction property.
    description: The participant profile property reference.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'