Nuance Environments API

openapi: 3.2.0
info:
  title: Mix.api Specification Environments API
  version: 26.1026.216
security:
- OAuth2:
  - mix-api
  bearerAuth: []
tags:
- name: Environments
paths:
  /v4/organizations/{orgId}/environments:
    get:
      summary: Get organization environments
      description: 'Get the list of environments available in an organization.


        You can limit the number of results returned and use an offset to determine the starting position of results returned.


        You can also sort the results by id or displayName and specify the sort order with the - or + sign. For example, to sort by alphabetical order of displayName, enter +displayName. You can also specify multiple sorting fields by separating them with commas; for example: +displayName, -id. By default, results are sorted by alphabetical order of environment ID.'
      operationId: MixAPI_ListEnvironments
      responses:
        '200':
          description: List of environments in the organization specified.
          content:
            application/json:
              schema:
                type: array
                $ref: '#/components/schemas/mix.api.ListEnvironmentsResponse'
        '401':
          description: Request could not be authorized
          content:
            application/json:
              schema: {}
        '500':
          description: Internal server error
          content:
            application/json:
              schema: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: orgId
        description: ID of the organization for which to get the list of environments.
        in: path
        required: true
        schema:
          type: string
      - name: limit
        description: Maximum number of query results returned.
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: offset
        description: Offset to use when returning results.
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy
        description: 'Sort parameter; use the format: +displayName.'
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - Environments
components:
  schemas:
    google.protobuf.Any:
      type: object
      properties:
        type_url:
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
        value:
          type: string
          format: byte
          description: Must be a valid serialized protocol buffer of the above specified type.
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n    // or ...\n    if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n      foo = any.unpack(Foo.getDefaultInstance());\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    mix.api.EnvironmentType:
      type: string
      enum:
      - EST_TYPE_UNSPECIFIED
      - SANDBOX
      - PRODUCTION
      default: EST_TYPE_UNSPECIFIED
      description: "ENUM that defines the type of environment.\n\n - EST_TYPE_UNSPECIFIED: Unspecified type\n - SANDBOX: Sandbox environment\n - PRODUCTION: Production environment"
    grpc.gateway.runtime.Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
    mix.api.Geography:
      type: object
      properties:
        id:
          type: string
          description: Unique ID identifying the Nuance geography.
        displayName:
          type: string
          description: Name of the Nuance geography (for example, US, Canada).
      description: Message that defines a Nuance geography.
    mix.api.EnvironmentGeography:
      type: object
      properties:
        id:
          type: string
          description: Unique ID identifying the environment geography.
        geography:
          $ref: '#/components/schemas/mix.api.Geography'
          description: Object defining the Nuance geography.
        envType:
          $ref: '#/components/schemas/mix.api.EnvironmentType'
          description: Type of environment.
        envHost:
          type: string
          description: Host of environment.
        envName:
          type: string
          description: Environment name.
      description: Message that defines an environment geography.
    mix.api.Environment:
      type: object
      properties:
        id:
          type: string
          description: Unique ID identifying the environment in the organization.
        displayName:
          type: string
          description: Name of the environment.
        geographies:
          type: array
          items:
            $ref: '#/components/schemas/mix.api.EnvironmentGeography'
          description: List of environment geographies.
      description: Message that defines an environment.
    mix.api.ListEnvironmentsResponse:
      type: object
      example:
        environments:
        - id: '300'
          displayName: Sandbox
          geographies:
          - id: '337'
            geography:
              id: '1'
              displayName: Sandbox US
            envType: SANDBOX
            envHost: api.nuance.com
        - id: '301'
          displayName: Development
          geographies:
          - id: '338'
            geography:
              id: '14'
              displayName: US
            envType: SANDBOX
            envHost: api.nuance.com
        - id: '302'
          displayName: QA
          geographies:
          - id: '339'
            geography:
              id: '14'
              displayName: US
            envType: SANDBOX
            envHost: api.nuance.com
        - id: '303'
          displayName: Staging
          geographies:
          - id: '340'
            geography:
              id: '14'
              displayName: US
            envType: PRODUCTION
            envHost: api.nuance.com
          - id: '343'
            geography:
              id: '16'
              displayName: Canada
            envType: PRODUCTION
            envHost: api.nuance.com
        - id: '304'
          displayName: Production
          geographies:
          - id: '341'
            geography:
              id: '14'
              displayName: US
            envType: PRODUCTION
            envHost: api.nuance.com
          - id: '342'
            geography:
              id: '16'
              displayName: Canada
            envType: PRODUCTION
            envHost: api.nuance.com
        totalSize: 5
        count: 5
        limit: 10
        offset: 0
      properties:
        environments:
          type: array
          items:
            $ref: '#/components/schemas/mix.api.Environment'
          description: List of environments.
        totalSize:
          type: integer
          format: int32
          description: Total number of environments that match the request.
        count:
          type: integer
          format: int32
          description: Number of results returned.
        limit:
          type: integer
          format: int32
          description: Value of limit field specified in request.
        offset:
          type: integer
          format: int32
          description: Value of offset field specified in request.
      description: Response object returned by the Get Environments list request.
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            mix-api: Grants access to mix-api
          tokenUrl: /oauth2/token
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header