Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-25250

BAF: Add REST endpoint for page provider

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 10.3
    • Component/s: Bulk, Query & PageProvider

      Description

      We want to be able to run a BulkCommand on a page provider from REST.

      Endpoint could be:

      • POST /api/v1/search/pp/ {providerName}/bulk
        {
          "action":"...",
          "parameters":"..."
        }
        


        * POST /api/v1/search/pp/{providerName}

        /bulk/

        {action}
        {
          "action":"...",
          "parameters":"..."
        }
        

      Technical Specifications

      Bulk action parameters JSON format

      Parameters can be added as an input to a bulk action.
      Here is an example of bulk action parameters format used to execute the SetProperties action in Nuxeo REST API :

      {
        "dc:title": "new title",
        "dc:description":"new description"
      }
      
      REST Endpoints

      Several endpoints are added, here the exhaustive list:

      HTTP Method Path Request Body Response
      POST
      /nuxeo/api/v1/search/bulk/{actionId}
      Bulk action parameters Bulk action status
      POST
      /nuxeo/api/v1/search/pp/{pageProviderName}/bulk/{actionId}
      Bulk action parameters Bulk action status
      POST
      /nuxeo/api/v1/search/saved/{savedSearchId}/bulk/{actionId}
      Bulk action parameters Bulk action status

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 2 days
                  2d