Atlassian The Confluence Cloud REST API — Relation

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Confluence Cloud REST API — Relation
  description: 'Atlassian The Confluence Cloud REST API — Relation. 5 operations. Lead operation: Atlassian Find Target Entities
    Related To A Source Entity. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Relation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: confluence-relation
    baseUri: ''
    description: Atlassian The Confluence Cloud REST API — Relation business capability. Self-contained, no shared references.
    resources:
    - name: wiki-rest-api-relation-relationName-from-sourceType-sourceKey-to-targetType
      path: /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}
      operations:
      - name: atlassianfindtargetfromsource
        method: GET
        description: Atlassian Find Target Entities Related To A Source Entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: relationName
          in: path
          type: string
          description: The name of the relationship. This method supports relationships created via
          required: true
        - name: sourceType
          in: path
          type: string
          description: The source entity type of the relationship.
          required: true
        - name: sourceKey
          in: path
          type: string
          description: 'The identifier for the source entity:'
          required: true
        - name: targetType
          in: path
          type: string
          description: The target entity type of the relationship.
          required: true
        - name: sourceStatus
          in: query
          type: string
          description: The status of the source. This parameter is only used when the
        - name: targetStatus
          in: query
          type: string
          description: The status of the target. This parameter is only used when the
        - name: sourceVersion
          in: query
          type: integer
          description: The version of the source. This parameter is only used when the
        - name: targetVersion
          in: query
          type: integer
          description: The version of the target. This parameter is only used when the
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the response
        - name: start
          in: query
          type: integer
          description: The starting index of the returned relationships.
        - name: limit
          in: query
          type: integer
          description: The maximum number of relationships to return per page.
    - name: wiki-rest-api-relation-relationName-from-sourceType-sourceKey-to-targetType-targ
      path: /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
      operations:
      - name: atlassiangetrelationship
        method: GET
        description: Atlassian Find Relationship From Source To Target
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: relationName
          in: path
          type: string
          description: The name of the relationship. This method supports the 'favourite'
          required: true
        - name: sourceType
          in: path
          type: string
          description: The source entity type of the relationship. This must be 'user', if
          required: true
        - name: sourceKey
          in: path
          type: string
          description: '- The identifier for the source entity:'
          required: true
        - name: targetType
          in: path
          type: string
          description: The target entity type of the relationship. This must be 'space' or
          required: true
        - name: targetKey
          in: path
          type: string
          description: 'The identifier for the target entity:'
          required: true
        - name: sourceStatus
          in: query
          type: string
          description: The status of the source. This parameter is only used when the
        - name: targetStatus
          in: query
          type: string
          description: The status of the target. This parameter is only used when the
        - name: sourceVersion
          in: query
          type: integer
          description: The version of the source. This parameter is only used when the
        - name: targetVersion
          in: query
          type: integer
          description: The version of the target. This parameter is only used when the
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the response
      - name: atlassiancreaterelationship
        method: PUT
        description: Atlassian Create Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: relationName
          in: path
          type: string
          description: The name of the relationship. This method supports the 'favourite'
          required: true
        - name: sourceType
          in: path
          type: string
          description: The source entity type of the relationship. This must be 'user', if
          required: true
        - name: sourceKey
          in: path
          type: string
          description: '- The identifier for the source entity:'
          required: true
        - name: targetType
          in: path
          type: string
          description: The target entity type of the relationship. This must be 'space' or
          required: true
        - name: targetKey
          in: path
          type: string
          description: '- The identifier for the target entity:'
          required: true
        - name: sourceStatus
          in: query
          type: string
          description: The status of the source. This parameter is only used when the
        - name: targetStatus
          in: query
          type: string
          description: The status of the target. This parameter is only used when the
        - name: sourceVersion
          in: query
          type: integer
          description: The version of the source. This parameter is only used when the
        - name: targetVersion
          in: query
          type: integer
          description: The version of the target. This parameter is only used when the
      - name: atlassiandeleterelationship
        method: DELETE
        description: Atlassian Delete Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: relationName
          in: path
          type: string
          description: The name of the relationship.
          required: true
        - name: sourceType
          in: path
          type: string
          description: The source entity type of the relationship. This must be 'user', if
          required: true
        - name: sourceKey
          in: path
          type: string
          description: '- The identifier for the source entity:'
          required: true
        - name: targetType
          in: path
          type: string
          description: The target entity type of the relationship. This must be 'space' or
          required: true
        - name: targetKey
          in: path
          type: string
          description: '- The identifier for the target entity:'
          required: true
        - name: sourceStatus
          in: query
          type: string
          description: The status of the source. This parameter is only used when the
        - name: targetStatus
          in: query
          type: string
          description: The status of the target. This parameter is only used when the
        - name: sourceVersion
          in: query
          type: integer
          description: The version of the source. This parameter is only used when the
        - name: targetVersion
          in: query
          type: integer
          description: The version of the target. This parameter is only used when the
    - name: wiki-rest-api-relation-relationName-to-targetType-targetKey-from-sourceType
      path: /wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}
      operations:
      - name: atlassianfindsourcesfortarget
        method: GET
        description: Atlassian Find Source Entities Related To A Target Entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: relationName
          in: path
          type: string
          description: The name of the relationship. This method supports relationships created via
          required: true
        - name: sourceType
          in: path
          type: string
          description: The source entity type of the relationship.
          required: true
        - name: targetType
          in: path
          type: string
          description: The target entity type of the relationship.
          required: true
        - name: targetKey
          in: path
          type: string
          description: 'The identifier for the target entity:'
          required: true
        - name: sourceStatus
          in: query
          type: string
          description: The status of the source. This parameter is only used when the
        - name: targetStatus
          in: query
          type: string
          description: The status of the target. This parameter is only used when the
        - name: sourceVersion
          in: query
          type: integer
          description: The version of the source. This parameter is only used when the
        - name: targetVersion
          in: query
          type: integer
          description: The version of the target. This parameter is only used when the
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the response
        - name: start
          in: query
          type: integer
          description: The starting index of the returned relationships.
        - name: limit
          in: query
          type: integer
          description: The maximum number of relationships to return per page.
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: confluence-relation-rest
    port: 8080
    description: REST adapter for Atlassian The Confluence Cloud REST API — Relation. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/wiki/rest/api/relation/{relationname}/from/{sourcetype}/{sourcekey}/to/{targettype}
      name: wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype
      description: REST surface for wiki-rest-api-relation-relationName-from-sourceType-sourceKey-to-targetType.
      operations:
      - method: GET
        name: atlassianfindtargetfromsource
        description: Atlassian Find Target Entities Related To A Source Entity
        call: confluence-relation.atlassianfindtargetfromsource
        with:
          relationName: rest.relationName
          sourceType: rest.sourceType
          sourceKey: rest.sourceKey
          targetType: rest.targetType
          sourceStatus: rest.sourceStatus
          targetStatus: rest.targetStatus
          sourceVersion: rest.sourceVersion
          targetVersion: rest.targetVersion
          expand: rest.expand
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/relation/{relationname}/from/{sourcetype}/{sourcekey}/to/{targettype}/{targetkey}
      name: wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targ
      description: REST surface for wiki-rest-api-relation-relationName-from-sourceType-sourceKey-to-targetType-targ.
      operations:
      - method: GET
        name: atlassiangetrelationship
        description: Atlassian Find Relationship From Source To Target
        call: confluence-relation.atlassiangetrelationship
        with:
          relationName: rest.relationName
          sourceType: rest.sourceType
          sourceKey: rest.sourceKey
          targetType: rest.targetType
          targetKey: rest.targetKey
          sourceStatus: rest.sourceStatus
          targetStatus: rest.targetStatus
          sourceVersion: rest.sourceVersion
          targetVersion: rest.targetVersion
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassiancreaterelationship
        description: Atlassian Create Relationship
        call: confluence-relation.atlassiancreaterelationship
        with:
          relationName: rest.relationName
          sourceType: rest.sourceType
          sourceKey: rest.sourceKey
          targetType: rest.targetType
          targetKey: rest.targetKey
          sourceStatus: rest.sourceStatus
          targetStatus: rest.targetStatus
          sourceVersion: rest.sourceVersion
          targetVersion: rest.targetVersion
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: atlassiandeleterelationship
        description: Atlassian Delete Relationship
        call: confluence-relation.atlassiandeleterelationship
        with:
          relationName: rest.relationName
          sourceType: rest.sourceType
          sourceKey: rest.sourceKey
          targetType: rest.targetType
          targetKey: rest.targetKey
          sourceStatus: rest.sourceStatus
          targetStatus: rest.targetStatus
          sourceVersion: rest.sourceVersion
          targetVersion: rest.targetVersion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/relation/{relationname}/to/{targettype}/{targetkey}/from/{sourcetype}
      name: wiki-rest-api-relation-relationname-to-targettype-targetkey-from-sourcetype
      description: REST surface for wiki-rest-api-relation-relationName-to-targetType-targetKey-from-sourceType.
      operations:
      - method: GET
        name: atlassianfindsourcesfortarget
        description: Atlassian Find Source Entities Related To A Target Entity
        call: confluence-relation.atlassianfindsourcesfortarget
        with:
          relationName: rest.relationName
          sourceType: rest.sourceType
          targetType: rest.targetType
          targetKey: rest.targetKey
          sourceStatus: rest.sourceStatus
          targetStatus: rest.targetStatus
          sourceVersion: rest.sourceVersion
          targetVersion: rest.targetVersion
          expand: rest.expand
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: confluence-relation-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Confluence Cloud REST API — Relation. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: atlassian-find-target-entities-related
      description: Atlassian Find Target Entities Related To A Source Entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-relation.atlassianfindtargetfromsource
      with:
        relationName: tools.relationName
        sourceType: tools.sourceType
        sourceKey: tools.sourceKey
        targetType: tools.targetType
        sourceStatus: tools.sourceStatus
        targetStatus: tools.targetStatus
        sourceVersion: tools.sourceVersion
        targetVersion: tools.targetVersion
        expand: tools.expand
        start: tools.start
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-find-relationship-source-target
      description: Atlassian Find Relationship From Source To Target
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-relation.atlassiangetrelationship
      with:
        relationName: tools.relationName
        sourceType: tools.sourceType
        sourceKey: tools.sourceKey
        targetType: tools.targetType
        targetKey: tools.targetKey
        sourceStatus: tools.sourceStatus
        targetStatus: tools.targetStatus
        sourceVersion: tools.sourceVersion
        targetVersion: tools.targetVersion
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-relationship
      description: Atlassian Create Relationship
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: confluence-relation.atlassiancreaterelationship
      with:
        relationName: tools.relationName
        sourceType: tools.sourceType
        sourceKey: tools.sourceKey
        targetType: tools.targetType
        targetKey: tools.targetKey
        sourceStatus: tools.sourceStatus
        targetStatus: tools.targetStatus
        sourceVersion: tools.sourceVersion
        targetVersion: tools.targetVersion
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-relationship
      description: Atlassian Delete Relationship
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: confluence-relation.atlassiandeleterelationship
      with:
        relationName: tools.relationName
        sourceType: tools.sourceType
        sourceKey: tools.sourceKey
        targetType: tools.targetType
        targetKey: tools.targetKey
        sourceStatus: tools.sourceStatus
        targetStatus: tools.targetStatus
        sourceVersion: tools.sourceVersion
        targetVersion: tools.targetVersion
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-find-source-entities-related
      description: Atlassian Find Source Entities Related To A Target Entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-relation.atlassianfindsourcesfortarget
      with:
        relationName: tools.relationName
        sourceType: tools.sourceType
        targetType: tools.targetType
        targetKey: tools.targetKey
        sourceStatus: tools.sourceStatus
        targetStatus: tools.targetStatus
        sourceVersion: tools.sourceVersion
        targetVersion: tools.targetVersion
        expand: tools.expand
        start: tools.start
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.