> ## 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.

# 抛出信号

> A signal is an event of global scope (broadcast semantics) and is delivered to all
active handlers. Internally this maps to the engine's signal event received builder
method `RuntimeService#createSignalEvent()`. For more information about the signal
behavior, see the [Signal Events](https://docs.camunda.org/manual/7.22/reference/bpmn20/events/signal-events/)
section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.22/reference/bpmn20/).



## OpenAPI

````yaml POST /signal
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:
  /signal:
    post:
      tags:
        - Signal
      summary: Event
      description: >-
        A signal is an event of global scope (broadcast semantics) and is
        delivered to all

        active handlers. Internally this maps to the engine's signal event
        received builder

        method `RuntimeService#createSignalEvent()`. For more information about
        the signal

        behavior, see the [Signal
        Events](https://docs.camunda.org/manual/7.22/reference/bpmn20/events/signal-events/)

        section of the [BPMN 2.0 Implementation
        Reference](https://docs.camunda.org/manual/7.22/reference/bpmn20/).
      operationId: throwSignal
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignalDto'
            examples:
              examle-1:
                summary: POST /signal
                description: The content of the Request Body
                value:
                  name: policy_conditions_changed
                  variables:
                    newTimePeriodInMonth:
                      value: 24
      responses:
        '204':
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Returned if:


            * no name was given

            * the variable value or type is invalid, for example if the value
            could not be

            parsed to an integer value or the passed variable type is not
            supported

            * a tenant id and an execution id is specified.


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

            error response format.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationExceptionDto'
          description: >-
            Returned if the user is not allowed to throw a signal event.


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

            error response format.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >-
            Returned if a single execution is specified and no such execution
            exists or has not

            subscribed to the signal.


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

            error response format.
components:
  schemas:
    SignalDto:
      type: object
      properties:
        name:
          type: string
          description: |-
            The name of the signal to deliver.

            **Note**: This property is mandatory.
        executionId:
          type: string
          nullable: true
          description: >-
            Optionally specifies a single execution which is notified by the
            signal.


            **Note**: If no execution id is defined the signal is broadcasted to
            all subscribed

            handlers. 
        variables:
          type: object
          nullable: true
          additionalProperties:
            $ref: '#/components/schemas/VariableValueDto'
          description: >-
            A JSON object containing variable key-value pairs. Each key is a
            variable name and

            each value a JSON variable value object.
        tenantId:
          type: string
          nullable: true
          description: >-
            Specifies a tenant to deliver the signal. The signal can only be
            received on

            executions or process definitions which belongs to the given tenant.


            **Note**: Cannot be used in combination with executionId.
        withoutTenantId:
          type: boolean
          nullable: true
          description: >-
            If true the signal can only be received on executions or process
            definitions which

            belongs to no tenant. Value may not be false as this is the default
            behavior.


            **Note**: Cannot be used in combination with `executionId`.
    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).
    AuthorizationExceptionDto:
      allOf:
        - type: object
          properties:
            userId:
              type: string
              nullable: true
              description: The id of the user that does not have expected permissions
            missingAuthorizations:
              type: array
              nullable: true
              items:
                $ref: '#/components/schemas/MissingAuthorizationDto'
              description: ''
        - $ref: '#/components/schemas/ExceptionDto'
    VariableValueDto:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/AnyValue'
        type:
          type: string
          nullable: true
          description: The value type of the variable.
        valueInfo:
          type: object
          additionalProperties: true
          description: >-
            A JSON object containing additional, value-type-dependent
            properties.

            For serialized variables of type Object, the following properties
            can be provided:


            * `objectTypeName`: A string representation of the object's type
            name.

            * `serializationDataFormat`: The serialization format used to store
            the variable.


            For serialized variables of type File, the following properties can
            be provided:


            * `filename`: The name of the file. This is not the variable name
            but the name that will be used when downloading the file again.

            * `mimetype`: The MIME type of the file that is being uploaded.

            * `encoding`: The encoding of the file that is being uploaded.


            The following property can be provided for all value types:


            * `transient`: Indicates whether the variable should be transient or

            not. See
            [documentation](https://docs.camunda.org/manual/7.22/user-guide/process-engine/variables#transient-variables)
            for more informations.

            (Not applicable for `decision-definition`, `
            /process-instance/variables-async`, and `/migration/executeAsync`
            endpoints)
    MissingAuthorizationDto:
      type: object
      properties:
        permissionName:
          type: string
          nullable: true
          description: The permission name that the user is missing.
        resourceName:
          type: string
          nullable: true
          description: The name of the resource that the user is missing permission for.
        resourceId:
          type: string
          nullable: true
          description: The id of the resource that the user is missing permission for.
    AnyValue:
      description: |-
        Can be any value - string, number, boolean, array or object.
         **Note**: Not every endpoint supports every type.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````