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

# List bulk operations

> List all bulk operations with optional filtering and pagination. Returns operations of all types including publish, unpublish, edit, delete, and migrate.



## OpenAPI

````yaml /api-reference/saas/cs-rules-rewrites.json get /bulk-operations
openapi: 3.0.3
info:
  title: Rules & Rewrites API
  description: >-
    Manage Commerce Studio rules and query rewrites. Rules control search result
    behavior including boosting, burying, pinning, redirects, banners, and facet
    configuration. Query rewrites handle synonym expansion, misspelling
    correction, phrase matching, and query term manipulation.


    The endpoints require an authentication token with scope
    `commercestudio.rules` for rule operations, `commercestudio.rewrites` for
    query rewrite operations, and `commercestudio.bulkoperations` for bulk
    operations.
  version: 1.0.0
  contact:
    name: Lucidworks
    url: https://lucidworks.com/
    email: support@lucidworks.com
servers:
  - url: https://{commerce_studio_id}.experiencemanager.lucidworks.com
    description: Production.
    variables:
      commerce_studio_id:
        default: commerce_studio_id
        description: The ID of your Commerce Studio instance.
security:
  - authToken: []
tags:
  - name: Rule Management
    description: Create/Read/Update/Delete (CRUD) operations for Commerce Studio rules.
  - name: Query Rewrite Management
    description: >-
      Create/Read/Update/Delete (CRUD) operations for Commerce Studio query
      rewrites.
  - name: Bulk Operations
    description: >-
      Perform actions on multiple rules simultaneously, including publish,
      unpublish, edit, delete, and migrate operations. Requires an
      authentication token with scope `commercestudio.bulkoperations`.
paths:
  /bulk-operations:
    get:
      tags:
        - Bulk Operations
      summary: List bulk operations
      description: >-
        List all bulk operations with optional filtering and pagination. Returns
        operations of all types including publish, unpublish, edit, delete, and
        migrate.
      operationId: list_7
      parameters:
        - name: specification
          in: query
          required: true
          description: Filter criteria for bulk operations.
          example: {}
          schema:
            $ref: '#/components/schemas/DefaultSpecification'
        - name: pageable
          in: query
          required: true
          description: Pagination parameters including page number and size.
          example:
            page: 0
            size: 20
            sort:
              - lastModified,desc
          schema:
            $ref: '#/components/schemas/Pageable'
        - name: fields
          in: query
          required: false
          description: Fields to include in the response.
          example:
            - NONE
          schema:
            type: array
            items:
              type: string
              enum:
                - NONE
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagedModelBulkOperationSummary'
              example:
                content:
                  - type: publishRule
                    id: 8fc2056c-6515-497d-9bb3-74e26d961d90
                    createdBy: >-
                      fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
                    creationDate: '2026-07-13T17:59:29.690429Z'
                    lastModifiedBy: >-
                      fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
                    lastModified: '2026-07-13T17:59:32.647840Z'
                    status: COMPLETED
                    lastHeartbeat: '2026-07-13T17:59:32.646828Z'
                    errorMessage: null
                    rules:
                      - ruleId: af2d99c0-3d11-4002-a5d0-835b673d7f32
                        status: COMPLETED
                        errorMessage: null
                        detailedErrorMessage: null
                      - ruleId: 68e2aa2f-f27b-4f29-87f4-ce39f2ba050c
                        status: COMPLETED
                        errorMessage: null
                        detailedErrorMessage: null
                page:
                  size: 20
                  number: 0
                  totalElements: 1
                  totalPages: 1
components:
  schemas:
    DefaultSpecification:
      type: object
      description: >-
        Base class for all list endpoint specifications - indicates no filtering
        is allowed for this entity if used directly in a controller.
    Pageable:
      type: object
      properties:
        page:
          minimum: 0
          type: integer
          format: int32
        size:
          minimum: 1
          type: integer
          format: int32
        sort:
          type: array
          items:
            type: string
    PagedModelBulkOperationSummary:
      type: object
      properties:
        content:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/DeleteRuleBulkOperationSummary'
              - $ref: '#/components/schemas/EditRuleBulkOperationSummary'
              - $ref: '#/components/schemas/MigrateRuleBulkOperationSummary'
              - $ref: '#/components/schemas/PublishRuleBulkOperationSummary'
              - $ref: '#/components/schemas/UnpublishRuleBulkOperationSummary'
        page:
          $ref: '#/components/schemas/PageMetadata'
    DeleteRuleBulkOperationSummary:
      type: object
      title: Delete
      description: Summary of a bulk delete rule operation.
      example:
        type: deleteRule
        id: 3c90c3cc-0d44-4b50-8888-8dd25736052a
        createdBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        creationDate: '2026-07-13T18:04:12.190428685Z'
        lastModifiedBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        lastModified: '2026-07-13T18:04:14.902428685Z'
        status: COMPLETED
        lastHeartbeat: '2026-07-13T18:04:14.900484876Z'
        errorMessage: null
        rules:
          - ruleId: af2d99c0-3d11-4002-a5d0-835b673d7f32
            status: COMPLETED
            errorMessage: null
            detailedErrorMessage: null
      allOf:
        - $ref: '#/components/schemas/BulkOperationSummary'
        - type: object
          properties:
            type:
              type: string
              description: >-
                Discriminator for the operation type. Is `deleteRule` for this
                operation.
              enum:
                - deleteRule
            rules:
              type: array
              description: >-
                List of rules and their individual status in this bulk
                operation.
              items:
                $ref: '#/components/schemas/BulkOperationRuleStatusSummary'
    EditRuleBulkOperationSummary:
      type: object
      title: Edit
      description: Edit a set of rules in bulk.
      example:
        type: editRule
        id: 5b1a2f3e-9c44-4b50-8888-8dd257360abc
        createdBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        creationDate: '2026-07-13T18:06:02.190428685Z'
        lastModifiedBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        lastModified: '2026-07-13T18:06:04.902428685Z'
        status: COMPLETED
        lastHeartbeat: '2026-07-13T18:06:04.900484876Z'
        errorMessage: null
        rules:
          - ruleId: af2d99c0-3d11-4002-a5d0-835b673d7f32
            status: COMPLETED
            errorMessage: null
            detailedErrorMessage: null
          - ruleId: 68e2aa2f-f27b-4f29-87f4-ce39f2ba050c
            status: COMPLETED
            errorMessage: null
            detailedErrorMessage: null
        patch:
          precedence: 5
        stageChanges: false
      allOf:
        - $ref: '#/components/schemas/BulkOperationSummary'
        - type: object
          properties:
            type:
              type: string
              description: >-
                Discriminator for the operation type. Is `editRule` for this
                operation.
              enum:
                - editRule
            rules:
              type: array
              description: >-
                List of rules and their individual status in this bulk
                operation.
              items:
                $ref: '#/components/schemas/BulkOperationRuleStatusSummary'
            patch:
              $ref: '#/components/schemas/JsonNode'
            stageChanges:
              type: boolean
              description: >-
                When true, the patch is applied to staging content only for any
                published rule, using the current live content as the baseline
                (discarding any existing staged changes). Has no effect on
                unpublished rules.
    MigrateRuleBulkOperationSummary:
      type: object
      title: Migrate
      description: Summary of a bulk migrate rule operation.
      example:
        type: migrateRule
        id: 7d4e8f21-3a55-4b50-8888-8dd25736def0
        createdBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        creationDate: '2026-07-13T18:08:19.190428685Z'
        lastModifiedBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        lastModified: '2026-07-13T18:08:22.902428685Z'
        status: COMPLETED
        lastHeartbeat: '2026-07-13T18:08:22.900484876Z'
        errorMessage: null
        rules:
          - ruleId: af2d99c0-3d11-4002-a5d0-835b673d7f32
            status: COMPLETED
            errorMessage: null
            detailedErrorMessage: null
        targetExperienceManagerInstanceId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        published: true
      allOf:
        - $ref: '#/components/schemas/BulkOperationSummary'
        - type: object
          properties:
            type:
              type: string
              description: >-
                Discriminator for the operation type. Is `migrateRule` for this
                operation.
              enum:
                - migrateRule
            rules:
              type: array
              description: >-
                List of rules and their individual status in this bulk
                operation.
              items:
                $ref: '#/components/schemas/BulkOperationRuleStatusSummary'
            targetExperienceManagerInstanceId:
              type: string
              description: ID of the Commerce Studio destination instance.
              format: uuid
            published:
              type: boolean
              description: >-
                Whether the migrated rules should be published (true) or in
                draft state (false).
    PublishRuleBulkOperationSummary:
      type: object
      title: Publish
      description: Summary of a bulk publish rule operation.
      example:
        type: publishRule
        id: 8fc2056c-6515-497d-9bb3-74e26d961d90
        createdBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        creationDate: '2026-07-13T17:59:29.690428685Z'
        lastModifiedBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        lastModified: '2026-07-13T17:59:29.690428685Z'
        status: PENDING
        lastHeartbeat: '2026-07-13T17:59:29.681484876Z'
        errorMessage: null
        rules:
          - ruleId: af2d99c0-3d11-4002-a5d0-835b673d7f32
            status: PENDING
            errorMessage: null
            detailedErrorMessage: null
          - ruleId: 68e2aa2f-f27b-4f29-87f4-ce39f2ba050c
            status: PENDING
            errorMessage: null
            detailedErrorMessage: null
      allOf:
        - $ref: '#/components/schemas/BulkOperationSummary'
        - type: object
          properties:
            type:
              type: string
              description: >-
                Discriminator for the operation type. Is `publishRule` for this
                operation.
              enum:
                - publishRule
            rules:
              type: array
              description: >-
                List of rules and their individual status in this bulk
                operation.
              items:
                $ref: '#/components/schemas/BulkOperationRuleStatusSummary'
    UnpublishRuleBulkOperationSummary:
      type: object
      title: Unpublish
      description: Summary of a bulk unpublish rule operation.
      example:
        type: unpublishRule
        id: 1f9c7a3d-2b66-4b50-8888-8dd257361234
        createdBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        creationDate: '2026-07-13T18:10:45.190428685Z'
        lastModifiedBy: >-
          fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com
        lastModified: '2026-07-13T18:10:47.902428685Z'
        status: COMPLETED
        lastHeartbeat: '2026-07-13T18:10:47.900484876Z'
        errorMessage: null
        rules:
          - ruleId: af2d99c0-3d11-4002-a5d0-835b673d7f32
            status: COMPLETED
            errorMessage: null
            detailedErrorMessage: null
          - ruleId: 68e2aa2f-f27b-4f29-87f4-ce39f2ba050c
            status: COMPLETED
            errorMessage: null
            detailedErrorMessage: null
      allOf:
        - $ref: '#/components/schemas/BulkOperationSummary'
        - type: object
          properties:
            type:
              type: string
              description: >-
                Discriminator for the operation type. Is `unpublishRule` for
                this operation.
              enum:
                - unpublishRule
            rules:
              type: array
              description: >-
                List of rules and their individual status in this bulk
                operation.
              items:
                $ref: '#/components/schemas/BulkOperationRuleStatusSummary'
    PageMetadata:
      type: object
      properties:
        size:
          type: integer
          format: int64
        number:
          type: integer
          format: int64
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
    BulkOperationSummary:
      required:
        - type
      type: object
      properties:
        id:
          type: string
          description: Entity id.
          format: uuid
        createdBy:
          type: string
          description: User who created the entity.
        creationDate:
          type: string
          description: Date when the entity was created.
          format: date-time
        lastModifiedBy:
          type: string
          description: User who last updated the entity.
        lastModified:
          type: string
          description: Date when the entity was last updated.
          format: date-time
        status:
          type: string
          description: Current status of the bulk operation.
          enum:
            - PENDING
            - WAITING
            - COMPLETED
            - COMPLETED_WITH_ERRORS
            - FAILED
        lastHeartbeat:
          type: string
          description: Last time the heartbeat was sent for this bulk operation.
          format: date-time
        errorMessage:
          type: string
          nullable: true
          description: >-
            User friendly message if the bulk operation failed or completed with
            errors. `null` if the operation has not failed.
        type:
          type: string
      description: Summary of a bulk operation.
    BulkOperationRuleStatusSummary:
      type: object
      properties:
        ruleId:
          type: string
          description: ID of the rule.
          format: uuid
        externalId:
          type: string
          description: >-
            External ID of the rule at the time the bulk operation was created,
            if the rule had one.
        status:
          type: string
          description: Current status of the rule in this bulk operation.
          enum:
            - PENDING
            - WAITING
            - COMPLETED
            - FAILED
        errorMessage:
          type: string
          nullable: true
          description: >-
            Error message if the operation failed for this rule. `null` if the
            rule has not failed.
        detailedErrorMessage:
          type: string
          nullable: true
          description: >-
            Detailed error message if the operation failed for this rule. `null`
            if the rule has not failed.
      description: Status of an individual rule in a bulk operation.
    JsonNode:
      type: object
      description: Query parameters to be passed to Fusion in the body.
  securitySchemes:
    authToken:
      type: http
      scheme: bearer

````