> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eorion.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取消息事件

> Retrieves a message event subscription for a given execution by id and a message
name.



## OpenAPI

````yaml GET /execution/{id}/messageSubscriptions/{messageName}
openapi: 3.0.2
info:
  title: ORION Platform REST API
  description: OpenApi Spec for ORION Camunda Platform REST API.
  version: 7.22.6-ee
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ORION Rest API
  url: https://docs.eorion.com
paths:
  /execution/{id}/messageSubscriptions/{messageName}:
    get:
      tags:
        - Execution
      summary: Get Message Event Subscription
      description: >-
        Retrieves a message event subscription for a given execution by id and a
        message

        name.
      operationId: getMessageEventSubscription
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          description: The id of the execution that holds the subscription.
        - name: messageName
          in: path
          schema:
            type: string
          required: true
          description: The name of the message that the subscription corresponds to.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionDto'
              examples:
                example-1:
                  description: >-
                    GET
                    `/execution/anExecutionId/messageSubscriptions/someMessage`
                  value:
                    id: anEventSubscriptionId
                    eventType: message
                    eventName: anEvent
                    executionId: anExecutionId
                    processInstanceId: aProcInstId
                    activityId: anActivity
                    tenantId: null
                    createdDate: 2013-01-23T13:59:43.000+0200
          description: Request successful.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            A message subscription for the given name and execution does not
            exist.

            This may either mean that the execution does not exist, or that

            it is not subscribed on such a message.

            See the

            [Introduction](https://docs.camunda.org/manual/7.22/reference/rest/overview/#error-handling)

            for the error response format.
components:
  schemas:
    EventSubscriptionDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the event subscription.
        eventType:
          type: string
          nullable: true
          description: The type of the event subscription.
        eventName:
          type: string
          nullable: true
          description: >-
            The name of the event this subscription belongs to as defined in the
            process model.
        executionId:
          type: string
          nullable: true
          description: The execution that is subscribed on the referenced event.
        processInstanceId:
          type: string
          nullable: true
          description: The process instance this subscription belongs to.
        activityId:
          type: string
          nullable: true
          description: >-
            The identifier of the activity that this event subscription belongs
            to.

            This could for example be the id of a receive task.
        createdDate:
          type: string
          format: date-time
          nullable: true
          description: The time this event subscription was created.
        tenantId:
          type: string
          nullable: true
          description: |-
            The id of the tenant this event subscription belongs to.
            Can be `null` if the subscription belongs to no single tenant.
    ExceptionDto:
      title: ExceptionDto
      type: object
      properties:
        type:
          type: string
          nullable: true
          description: An exception class indicating the occurred error.
        message:
          type: string
          nullable: true
          description: A detailed message of the error.
        code:
          type: number
          description: >-
            The code allows your client application to identify the error in an
            automated fashion.

            You can look up the meaning of all built-in codes and learn how to
            add custom codes

            in the [User
            Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/error-handling/#exception-codes).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````