Package org.apache.fineract.client.services

Interface SchedulerJobApi

public interface SchedulerJobApi

  • Method Details

    • executeJob

      @Headers("Content-Type:application/json") @POST("v1/jobs/{jobId}") retrofit2.Call<Void> executeJob(@Path("jobId") Long jobId, @Query("command") String command, @Body ExecuteJobRequest executeJobRequest)
      Run a Job Manually Execute Specific Job.
      Parameters:
      jobId - jobId (required)
      command - command (optional)
      executeJobRequest - (optional)
      Returns:
      Call<Void>

    • executeJobByShortName

      @Headers("Content-Type:application/json") @POST("v1/jobs/short-name/{shortName}") retrofit2.Call<Void> executeJobByShortName(@Path("shortName") String shortName, @Query("command") String command, @Body ExecuteJobRequest executeJobRequest)
      Run a Job Manually Execute Specific Job.
      Parameters:
      shortName - short-name (required)
      command - command (optional)
      executeJobRequest - (optional)
      Returns:
      Call<Void>

    • retrieveAll8

      @GET("v1/jobs") retrofit2.Call<List<GetJobsResponse>> retrieveAll8()
      Retrieve Scheduler Jobs Returns the list of jobs. Example Requests: jobs
      Returns:
      Call<List<GetJobsResponse>>

    • retrieveByShortName

      @GET("v1/jobs/short-name/{shortName}") retrofit2.Call<GetJobsResponse> retrieveByShortName(@Path("shortName") String shortName)
      Retrieve a Job Returns the details of a Job bu shortName. Example Requests: jobs/short-name/SA_PINT
      Parameters:
      shortName - short-name (required)
      Returns:
      Call<GetJobsResponse>

    • retrieveHistory

      @GET("v1/jobs/{jobId}/runhistory") retrofit2.Call<GetJobsJobIDJobRunHistoryResponse> retrieveHistory(@Path("jobId") Long jobId, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder)
      Retrieve Job Run History Example Requests: jobs/5/runhistory?offset=0&limit=200
      Parameters:
      jobId - jobId (required)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetJobsJobIDJobRunHistoryResponse>

    • retrieveHistoryByShortName

      @GET("v1/jobs/short-name/{shortName}/runhistory") retrofit2.Call<GetJobsJobIDJobRunHistoryResponse> retrieveHistoryByShortName(@Path("shortName") String shortName, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder)
      Retrieve Job Run History Example Requests: jobs/short-name/SA_PINT/runhistory?offset=0&limit=200
      Parameters:
      shortName - short-name (required)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetJobsJobIDJobRunHistoryResponse>

    • retrieveOne5

      @GET("v1/jobs/{jobId}") retrofit2.Call<GetJobsResponse> retrieveOne5(@Path("jobId") Long jobId)
      Retrieve a Job Returns the details of a Job. Example Requests: jobs/5
      Parameters:
      jobId - jobId (required)
      Returns:
      Call<GetJobsResponse>

    • updateJobDetail

      @Headers("Content-Type:application/json") @PUT("v1/jobs/{jobId}") retrofit2.Call<Void> updateJobDetail(@Path("jobId") Long jobId, @Body PutJobsJobIDRequest putJobsJobIDRequest)
      Update a Job Updates the details of a job.
      Parameters:
      jobId - jobId (required)
      putJobsJobIDRequest - (required)
      Returns:
      Call<Void>

    • updateJobDetailByShortName

      @Headers("Content-Type:application/json") @PUT("v1/jobs/short-name/{shortName}") retrofit2.Call<Void> updateJobDetailByShortName(@Path("shortName") String shortName, @Body PutJobsJobIDRequest putJobsJobIDRequest)
      Update a Job Updates the details of a job.
      Parameters:
      shortName - short-name (required)
      putJobsJobIDRequest - (required)
      Returns:
      Call<Void>

    • executeJob

      @Headers("Content-Type:application/json") @POST("v1/jobs/{jobId}") retrofit2.Call<Void> executeJob(@Path("jobId") Long jobId, @Query("command") String command)
      Run a Job Manually Execute Specific Job.
      Parameters:
      jobId - jobId (required)
      command - command (optional)
      executeJobRequest - (optional)
      Returns:
      Call<Void>

    • executeJobByShortName

      @Headers("Content-Type:application/json") @POST("v1/jobs/short-name/{shortName}") retrofit2.Call<Void> executeJobByShortName(@Path("shortName") String shortName, @Query("command") String command)
      Run a Job Manually Execute Specific Job.
      Parameters:
      shortName - short-name (required)
      command - command (optional)
      executeJobRequest - (optional)
      Returns:
      Call<Void>

    • executeJob

      @Headers("Content-Type:application/json") @POST("v1/jobs/{jobId}") retrofit2.Call<Void> executeJob(@Path("jobId") Long jobId, @Query("command") String command, @Body ExecuteJobRequest executeJobRequest, @HeaderMap Map<String,String> headers)
      Run a Job Manually Execute Specific Job.
      Parameters:
      jobId - jobId (required)
      command - command (optional)
      executeJobRequest - (optional)
      Returns:
      Call<Void>

    • executeJobByShortName

      @Headers("Content-Type:application/json") @POST("v1/jobs/short-name/{shortName}") retrofit2.Call<Void> executeJobByShortName(@Path("shortName") String shortName, @Query("command") String command, @Body ExecuteJobRequest executeJobRequest, @HeaderMap Map<String,String> headers)
      Run a Job Manually Execute Specific Job.
      Parameters:
      shortName - short-name (required)
      command - command (optional)
      executeJobRequest - (optional)
      Returns:
      Call<Void>

    • retrieveAll8

      @GET("v1/jobs") retrofit2.Call<List<GetJobsResponse>> retrieveAll8(@HeaderMap Map<String,String> headers)
      Retrieve Scheduler Jobs Returns the list of jobs. Example Requests: jobs
      Returns:
      Call<List<GetJobsResponse>>

    • retrieveByShortName

      @GET("v1/jobs/short-name/{shortName}") retrofit2.Call<GetJobsResponse> retrieveByShortName(@Path("shortName") String shortName, @HeaderMap Map<String,String> headers)
      Retrieve a Job Returns the details of a Job bu shortName. Example Requests: jobs/short-name/SA_PINT
      Parameters:
      shortName - short-name (required)
      Returns:
      Call<GetJobsResponse>

    • retrieveHistory

      @GET("v1/jobs/{jobId}/runhistory") retrofit2.Call<GetJobsJobIDJobRunHistoryResponse> retrieveHistory(@Path("jobId") Long jobId, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @HeaderMap Map<String,String> headers)
      Retrieve Job Run History Example Requests: jobs/5/runhistory?offset=0&limit=200
      Parameters:
      jobId - jobId (required)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetJobsJobIDJobRunHistoryResponse>

    • retrieveHistoryByShortName

      @GET("v1/jobs/short-name/{shortName}/runhistory") retrofit2.Call<GetJobsJobIDJobRunHistoryResponse> retrieveHistoryByShortName(@Path("shortName") String shortName, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @HeaderMap Map<String,String> headers)
      Retrieve Job Run History Example Requests: jobs/short-name/SA_PINT/runhistory?offset=0&limit=200
      Parameters:
      shortName - short-name (required)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetJobsJobIDJobRunHistoryResponse>

    • retrieveOne5

      @GET("v1/jobs/{jobId}") retrofit2.Call<GetJobsResponse> retrieveOne5(@Path("jobId") Long jobId, @HeaderMap Map<String,String> headers)
      Retrieve a Job Returns the details of a Job. Example Requests: jobs/5
      Parameters:
      jobId - jobId (required)
      Returns:
      Call<GetJobsResponse>

    • updateJobDetail

      @Headers("Content-Type:application/json") @PUT("v1/jobs/{jobId}") retrofit2.Call<Void> updateJobDetail(@Path("jobId") Long jobId, @Body PutJobsJobIDRequest putJobsJobIDRequest, @HeaderMap Map<String,String> headers)
      Update a Job Updates the details of a job.
      Parameters:
      jobId - jobId (required)
      putJobsJobIDRequest - (required)
      Returns:
      Call<Void>

    • updateJobDetailByShortName

      @Headers("Content-Type:application/json") @PUT("v1/jobs/short-name/{shortName}") retrofit2.Call<Void> updateJobDetailByShortName(@Path("shortName") String shortName, @Body PutJobsJobIDRequest putJobsJobIDRequest, @HeaderMap Map<String,String> headers)
      Update a Job Updates the details of a job.
      Parameters:
      shortName - short-name (required)
      putJobsJobIDRequest - (required)
      Returns:
      Call<Void>

    • executeJob

      @Headers("Content-Type:application/json") @POST("v1/jobs/{jobId}") retrofit2.Call<Void> executeJob(@Path("jobId") Long jobId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Run a Job Manually Execute Specific Job.
      Parameters:
      jobId - jobId (required)
      command - command (optional)
      executeJobRequest - (optional)
      Returns:
      Call<Void>

    • executeJobByShortName

      @Headers("Content-Type:application/json") @POST("v1/jobs/short-name/{shortName}") retrofit2.Call<Void> executeJobByShortName(@Path("shortName") String shortName, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Run a Job Manually Execute Specific Job.
      Parameters:
      shortName - short-name (required)
      command - command (optional)
      executeJobRequest - (optional)
      Returns:
      Call<Void>