Digital-Twins-Get-Relationship-By-Id.yml

### YamlMime:RESTOperation
uid: digitaltwins-hostname.dataplane.twins.digitaltwins_getrelationshipbyid
name: DigitalTwins GetRelationshipById
service: Reference
groupName: Twins
apiVersion: 2023-10-31
summary: >-
  Retrieves a relationship between two digital twins.

  Status codes:

  * 200 OK

  * 400 Bad Request
    * InvalidArgument - The digital twin id or relationship id is invalid.
  * 404 Not Found
    * DigitalTwinNotFound - The digital twin was not found.
    * RelationshipNotFound - The relationship was not found.
consumes:
- application/json
produces:
- application/json
paths:
- content: GET https://digitaltwins-hostname/digitaltwins/{id}/relationships/{relationshipId}?api-version=2023-10-31
uriParameters:
- name: id
  in: path
  isRequired: true
  description: The id of the digital twin. The id is unique within the service and case sensitive.
  types:
  - uid: string
- name: relationshipId
  in: path
  isRequired: true
  description: The id of the relationship. The id is unique within the digital twin and case sensitive.
  types:
  - uid: string
- name: api-version
  in: query
  isRequired: true
  description: The requested API version.
  types:
  - uid: string
responses:
- name: 200 OK
  headers:
  - name: ETag
    value: string
  description: Success
  types:
  - uid: Relationship
- name: Other Status Codes
  headers:
  - name: x-ms-error-code
    value: string
  description: Default response.
  types:
  - uid: ErrorResponse
requestHeader:
- name: traceparent
  in: header
  description: Identifies the request in a distributed tracing system.
  types:
  - uid: string
- name: tracestate
  in: header
  description: Provides vendor-specific trace identification information and is a companion to traceparent.
  types:
  - uid: string
definitions:
- name: ErrorResponse
  description: Error response.
  kind: object
  properties:
  - name: error
    description: The error details.
    types:
    - uid: Error
- name: Error
  description: Error definition.
  kind: object
  properties:
  - name: code
    isReadOnly: true
    description: Service specific error code which serves as the substatus for the HTTP error code.
    types:
    - uid: string
  - name: message
    isReadOnly: true
    description: A human-readable representation of the error.
    types:
    - uid: string
  - name: details
    isReadOnly: true
    description: Internal error details.
    types:
    - uid: Error
      isArray: true
  - name: innererror
    description: An object containing more specific information than the current object about the error.
    types:
    - uid: InnerError
- name: InnerError
  description: A more specific error description than was provided by the containing error.
  kind: object
  properties:
  - name: code
    description: A more specific error code than was provided by the containing error.
    types:
    - uid: string
  - name: innererror
    description: An object containing more specific information than the current object about the error.
    types:
    - uid: InnerError
examples:
- name: Get a relationship by id
  request:
    uri: GET https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31
    codeTab: |+
      # [HTTP](#tab/HTTP)
      ``` http
      GET https://digitaltwins-hostname/digitaltwins/mySourceTwin/relationships/myRelationshipId?api-version=2023-10-31
      ```

  responses:
  - statusCode: "200"
    body: >-
      {
        "$relationshipId": "myRelationshipId",
        "$sourceId": "mySourceTwin",
        "$targetId": "myTargetTwin",
        "$relationshipName": "myRelationship",
        "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
        "relationshipProperty": "some value"
      }
security:
- name: oauth2
  type: oauth2
  flow: implicit
  authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0
metadata:
  description: >-
    Retrieves a relationship between two digital twins.

    Status codes:

    200 OK

    400 Bad Request

    InvalidArgument - The digital twin id or relationship id is invalid.
errorCodes: []