Uploaded image for project: 'Oozie'
  1. Oozie
  2. OOZIE-1183

Update WebServices API documentation

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: trunk
    • Fix Version/s: 4.0.0
    • Component/s: docs
    • Labels:
      None

      Description

      We recently had some trouble trying to rerun a coordinator job using the WebServices API. According to the documentation, we were trying to POST a URL like this:

      PUT http://localhost:11000/oozie/v1/job/0000024-130108101138395-oozie-oozi-C?action=rerun&type=exact&end-action=1&start-action=1

      but this gave an error.

      After looking through the client and server code, I figured out that there's a huge discrepancy between it and the documentation. The parameters its using in the PUT request for a coordinator job are:

      • action=coord-rerun
      • type=[date|action]
      • scope=a comma-separated list of date ranges. Each date range element is specified with two dates separated by '::' (if type=date)
      • scope=a comma-separated list of action ranges. The action range is specified with two action numbers separated by '-' (if type=action)
      • refresh=[true|false] used to indicate if user wants to refresh an action's input and output events.
      • nocleanup=[true|false] used to indicate if user wants to cleanup output events for given rerun actions

      Based on that, the correct URL to PUT is:

      http://localhost:11000/oozie/v1/job/0000024-130108101138395-oozie-oozi-C?action=coord-rerun&type=action&scope=1-1&refresh=false&nocleanup=false

      We should update the documentation with the correct information above. We should also go through the rest of the WebServices API documentation and make sure its accurate (this isn't the first time I've had to go through the code when using the WebServices API).

        Attachments

        1. OOZIE-1183.patch
          20 kB
          Robert Kanter
        2. OOZIE-1183.patch
          21 kB
          Robert Kanter

          Activity

            People

            • Assignee:
              rkanter Robert Kanter
              Reporter:
              rkanter Robert Kanter
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: