Job History Service

Algorithms

jobsHistoryAlgorithmsGet

Fetch list of all distinct algorithms used by the filtered jobs.

This endpoint lists all distinct algorithms used by the filtered jobs.


/jobs/history/algorithms

Usage and SDK Samples

curl -X GET "http://localhost/v1/jobs/history/algorithms?q=&locale="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AlgorithmsApi;

import java.io.File;
import java.util.*;

public class AlgorithmsApiExample {

    public static void main(String[] args) {
        
        AlgorithmsApi apiInstance = new AlgorithmsApi();
        String q = q_example; // String | The query in RSQL format.
        String locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.
        try {
            AlgorithmResponse result = apiInstance.jobsHistoryAlgorithmsGet(q, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlgorithmsApi#jobsHistoryAlgorithmsGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AlgorithmsApi;

public class AlgorithmsApiExample {

    public static void main(String[] args) {
        AlgorithmsApi apiInstance = new AlgorithmsApi();
        String q = q_example; // String | The query in RSQL format.
        String locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.
        try {
            AlgorithmResponse result = apiInstance.jobsHistoryAlgorithmsGet(q, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlgorithmsApi#jobsHistoryAlgorithmsGet");
            e.printStackTrace();
        }
    }
}
String *q = q_example; // The query in RSQL format. (optional) (default to null)
String *locale = locale_example; // The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional) (default to null)

AlgorithmsApi *apiInstance = [[AlgorithmsApi alloc] init];

// Fetch list of all distinct algorithms used by the filtered jobs.
[apiInstance jobsHistoryAlgorithmsGetWith:q
    locale:locale
              completionHandler: ^(AlgorithmResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var JobHistoryService = require('job_history_service');

var api = new JobHistoryService.AlgorithmsApi()
var opts = {
  'q': q_example, // {String} The query in RSQL format.
  'locale': locale_example // {String} The locale adopted for internationalization. When provided, this locale defines the language for message responses.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobsHistoryAlgorithmsGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class jobsHistoryAlgorithmsGetExample
    {
        public void main()
        {
            
            var apiInstance = new AlgorithmsApi();
            var q = q_example;  // String | The query in RSQL format. (optional)  (default to null)
            var locale = locale_example;  // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional)  (default to null)

            try
            {
                // Fetch list of all distinct algorithms used by the filtered jobs.
                AlgorithmResponse result = apiInstance.jobsHistoryAlgorithmsGet(q, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlgorithmsApi.jobsHistoryAlgorithmsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\AlgorithmsApi();
$q = q_example; // String | The query in RSQL format.
$locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.

try {
    $result = $api_instance->jobsHistoryAlgorithmsGet($q, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlgorithmsApi->jobsHistoryAlgorithmsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AlgorithmsApi;

my $api_instance = WWW::OPenAPIClient::AlgorithmsApi->new();
my $q = q_example; # String | The query in RSQL format.
my $locale = locale_example; # String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.

eval { 
    my $result = $api_instance->jobsHistoryAlgorithmsGet(q => $q, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlgorithmsApi->jobsHistoryAlgorithmsGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.AlgorithmsApi()
q = q_example # String | The query in RSQL format. (optional) (default to null)
locale = locale_example # String | The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional) (default to null)

try: 
    # Fetch list of all distinct algorithms used by the filtered jobs.
    api_response = api_instance.jobs_history_algorithms_get(q=q, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlgorithmsApi->jobsHistoryAlgorithmsGet: %s\n" % e)
extern crate AlgorithmsApi;

pub fn main() {
    let q = q_example; // String
    let locale = locale_example; // String

    let mut context = AlgorithmsApi::Context::default();
    let result = client.jobsHistoryAlgorithmsGet(q, locale, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
q
String
The query in RSQL format.
locale
String
The locale adopted for internationalization. When provided, this locale defines the language for message responses.

Responses


Jobs

jobsHistoryDelete

Archive a job execution.

This endpoint archives the job execution, removing from the list of searchable jobs.


/jobs/history

Usage and SDK Samples

curl -X DELETE "http://localhost/v1/jobs/history?jobIds=&locale="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        array[String] jobIds = ; // array[String] | The IDs of the jobs to be archived.
        String locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.
        try {
            apiInstance.jobsHistoryDelete(jobIds, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsHistoryDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        array[String] jobIds = ; // array[String] | The IDs of the jobs to be archived.
        String locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.
        try {
            apiInstance.jobsHistoryDelete(jobIds, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsHistoryDelete");
            e.printStackTrace();
        }
    }
}
array[String] *jobIds = ; // The IDs of the jobs to be archived. (default to null)
String *locale = locale_example; // The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional) (default to null)

JobsApi *apiInstance = [[JobsApi alloc] init];

// Archive a job execution.
[apiInstance jobsHistoryDeleteWith:jobIds
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var JobHistoryService = require('job_history_service');

var api = new JobHistoryService.JobsApi()
var jobIds = ; // {array[String]} The IDs of the jobs to be archived.
var opts = {
  'locale': locale_example // {String} The locale adopted for internationalization. When provided, this locale defines the language for message responses.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.jobsHistoryDelete(jobIds, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class jobsHistoryDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new JobsApi();
            var jobIds = new array[String](); // array[String] | The IDs of the jobs to be archived. (default to null)
            var locale = locale_example;  // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional)  (default to null)

            try
            {
                // Archive a job execution.
                apiInstance.jobsHistoryDelete(jobIds, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.jobsHistoryDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobIds = ; // array[String] | The IDs of the jobs to be archived.
$locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.

try {
    $api_instance->jobsHistoryDelete($jobIds, $locale);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobsHistoryDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobIds = []; # array[String] | The IDs of the jobs to be archived.
my $locale = locale_example; # String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.

eval { 
    $api_instance->jobsHistoryDelete(jobIds => $jobIds, locale => $locale);
};
if ($@) {
    warn "Exception when calling JobsApi->jobsHistoryDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.JobsApi()
jobIds =  # array[String] | The IDs of the jobs to be archived. (default to null)
locale = locale_example # String | The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional) (default to null)

try: 
    # Archive a job execution.
    api_instance.jobs_history_delete(jobIds, locale=locale)
except ApiException as e:
    print("Exception when calling JobsApi->jobsHistoryDelete: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobIds = ; // array[String]
    let locale = locale_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.jobsHistoryDelete(jobIds, locale, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
jobIds*
array[String]
The IDs of the jobs to be archived.
Required
locale
String
The locale adopted for internationalization. When provided, this locale defines the language for message responses.

Responses


jobsHistoryGet

Fetch filtered list of jobs from view job_view.

This endpoint list all jobs that match the parameters criteria


/jobs/history

Usage and SDK Samples

curl -X GET "http://localhost/v1/jobs/history?q=&offset=&limit=&asc=&attr=&showParam=&locale="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        String q = q_example; // String | The query in RSQL format.
        Integer offset = 56; // Integer | The zero based position of the first item to retrieve
        Integer limit = 56; // Integer | The number of items to retrieve
        Boolean asc = true; // Boolean | Parameter indicating the sorting direction of the results
        String attr = attr_example; // String | Attribute that should be used to sort the results
        Boolean showParam = true; // Boolean | Add algorithm's parameter values.
        String locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.
        try {
            JobResponse result = apiInstance.jobsHistoryGet(q, offset, limit, asc, attr, showParam, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsHistoryGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String q = q_example; // String | The query in RSQL format.
        Integer offset = 56; // Integer | The zero based position of the first item to retrieve
        Integer limit = 56; // Integer | The number of items to retrieve
        Boolean asc = true; // Boolean | Parameter indicating the sorting direction of the results
        String attr = attr_example; // String | Attribute that should be used to sort the results
        Boolean showParam = true; // Boolean | Add algorithm's parameter values.
        String locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.
        try {
            JobResponse result = apiInstance.jobsHistoryGet(q, offset, limit, asc, attr, showParam, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsHistoryGet");
            e.printStackTrace();
        }
    }
}
String *q = q_example; // The query in RSQL format. (optional) (default to null)
Integer *offset = 56; // The zero based position of the first item to retrieve (optional) (default to null)
Integer *limit = 56; // The number of items to retrieve (optional) (default to null)
Boolean *asc = true; // Parameter indicating the sorting direction of the results (optional) (default to null)
String *attr = attr_example; // Attribute that should be used to sort the results (optional) (default to null)
Boolean *showParam = true; // Add algorithm's parameter values. (optional) (default to true)
String *locale = locale_example; // The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional) (default to null)

JobsApi *apiInstance = [[JobsApi alloc] init];

// Fetch filtered list of jobs from view job_view.
[apiInstance jobsHistoryGetWith:q
    offset:offset
    limit:limit
    asc:asc
    attr:attr
    showParam:showParam
    locale:locale
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var JobHistoryService = require('job_history_service');

var api = new JobHistoryService.JobsApi()
var opts = {
  'q': q_example, // {String} The query in RSQL format.
  'offset': 56, // {Integer} The zero based position of the first item to retrieve
  'limit': 56, // {Integer} The number of items to retrieve
  'asc': true, // {Boolean} Parameter indicating the sorting direction of the results
  'attr': attr_example, // {String} Attribute that should be used to sort the results
  'showParam': true, // {Boolean} Add algorithm's parameter values.
  'locale': locale_example // {String} The locale adopted for internationalization. When provided, this locale defines the language for message responses.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobsHistoryGet(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class jobsHistoryGetExample
    {
        public void main()
        {
            
            var apiInstance = new JobsApi();
            var q = q_example;  // String | The query in RSQL format. (optional)  (default to null)
            var offset = 56;  // Integer | The zero based position of the first item to retrieve (optional)  (default to null)
            var limit = 56;  // Integer | The number of items to retrieve (optional)  (default to null)
            var asc = true;  // Boolean | Parameter indicating the sorting direction of the results (optional)  (default to null)
            var attr = attr_example;  // String | Attribute that should be used to sort the results (optional)  (default to null)
            var showParam = true;  // Boolean | Add algorithm's parameter values. (optional)  (default to true)
            var locale = locale_example;  // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional)  (default to null)

            try
            {
                // Fetch filtered list of jobs from view job_view.
                JobResponse result = apiInstance.jobsHistoryGet(q, offset, limit, asc, attr, showParam, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.jobsHistoryGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\JobsApi();
$q = q_example; // String | The query in RSQL format.
$offset = 56; // Integer | The zero based position of the first item to retrieve
$limit = 56; // Integer | The number of items to retrieve
$asc = true; // Boolean | Parameter indicating the sorting direction of the results
$attr = attr_example; // String | Attribute that should be used to sort the results
$showParam = true; // Boolean | Add algorithm's parameter values.
$locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.

try {
    $result = $api_instance->jobsHistoryGet($q, $offset, $limit, $asc, $attr, $showParam, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobsHistoryGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $q = q_example; # String | The query in RSQL format.
my $offset = 56; # Integer | The zero based position of the first item to retrieve
my $limit = 56; # Integer | The number of items to retrieve
my $asc = true; # Boolean | Parameter indicating the sorting direction of the results
my $attr = attr_example; # String | Attribute that should be used to sort the results
my $showParam = true; # Boolean | Add algorithm's parameter values.
my $locale = locale_example; # String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.

eval { 
    my $result = $api_instance->jobsHistoryGet(q => $q, offset => $offset, limit => $limit, asc => $asc, attr => $attr, showParam => $showParam, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobsHistoryGet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.JobsApi()
q = q_example # String | The query in RSQL format. (optional) (default to null)
offset = 56 # Integer | The zero based position of the first item to retrieve (optional) (default to null)
limit = 56 # Integer | The number of items to retrieve (optional) (default to null)
asc = true # Boolean | Parameter indicating the sorting direction of the results (optional) (default to null)
attr = attr_example # String | Attribute that should be used to sort the results (optional) (default to null)
showParam = true # Boolean | Add algorithm's parameter values. (optional) (default to true)
locale = locale_example # String | The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional) (default to null)

try: 
    # Fetch filtered list of jobs from view job_view.
    api_response = api_instance.jobs_history_get(q=q, offset=offset, limit=limit, asc=asc, attr=attr, showParam=showParam, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobsHistoryGet: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let q = q_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer
    let asc = true; // Boolean
    let attr = attr_example; // String
    let showParam = true; // Boolean
    let locale = locale_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.jobsHistoryGet(q, offset, limit, asc, attr, showParam, locale, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Query parameters
Name Description
q
String
The query in RSQL format.
offset
Integer
The zero based position of the first item to retrieve
limit
Integer
The number of items to retrieve
asc
Boolean
Parameter indicating the sorting direction of the results
attr
String
Attribute that should be used to sort the results
showParam
Boolean
Add algorithm's parameter values.
locale
String
The locale adopted for internationalization. When provided, this locale defines the language for message responses.

Responses


jobsHistoryJobIdCommentPut

Changes a job comment.

This endpoint edits a job comment.


/jobs/history/{jobId}/comment

Usage and SDK Samples

curl -X PUT "http://localhost/v1/jobs/history/{jobId}/comment?locale="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.JobsApi;

import java.io.File;
import java.util.*;

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | The ID of the job to be edited.
        NewComment newComment = {"newComment":"Some explanation about the job execution."}; // NewComment | 
        String locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.
        try {
            apiInstance.jobsHistoryJobIdCommentPut(jobId, newComment, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsHistoryJobIdCommentPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        String jobId = jobId_example; // String | The ID of the job to be edited.
        NewComment newComment = {"newComment":"Some explanation about the job execution."}; // NewComment | 
        String locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.
        try {
            apiInstance.jobsHistoryJobIdCommentPut(jobId, newComment, locale);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobsHistoryJobIdCommentPut");
            e.printStackTrace();
        }
    }
}
String *jobId = jobId_example; // The ID of the job to be edited. (default to null)
NewComment *newComment = {"newComment":"Some explanation about the job execution."}; // 
String *locale = locale_example; // The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional) (default to null)

JobsApi *apiInstance = [[JobsApi alloc] init];

// Changes a job comment.
[apiInstance jobsHistoryJobIdCommentPutWith:jobId
    newComment:newComment
    locale:locale
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var JobHistoryService = require('job_history_service');

var api = new JobHistoryService.JobsApi()
var jobId = jobId_example; // {String} The ID of the job to be edited.
var newComment = {"newComment":"Some explanation about the job execution."}; // {NewComment} 
var opts = {
  'locale': locale_example // {String} The locale adopted for internationalization. When provided, this locale defines the language for message responses.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.jobsHistoryJobIdCommentPut(jobId, newComment, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class jobsHistoryJobIdCommentPutExample
    {
        public void main()
        {
            
            var apiInstance = new JobsApi();
            var jobId = jobId_example;  // String | The ID of the job to be edited. (default to null)
            var newComment = new NewComment(); // NewComment | 
            var locale = locale_example;  // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional)  (default to null)

            try
            {
                // Changes a job comment.
                apiInstance.jobsHistoryJobIdCommentPut(jobId, newComment, locale);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.jobsHistoryJobIdCommentPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new OpenAPITools\Client\Api\JobsApi();
$jobId = jobId_example; // String | The ID of the job to be edited.
$newComment = {"newComment":"Some explanation about the job execution."}; // NewComment | 
$locale = locale_example; // String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.

try {
    $api_instance->jobsHistoryJobIdCommentPut($jobId, $newComment, $locale);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobsHistoryJobIdCommentPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::JobsApi;

my $api_instance = WWW::OPenAPIClient::JobsApi->new();
my $jobId = jobId_example; # String | The ID of the job to be edited.
my $newComment = WWW::OPenAPIClient::Object::NewComment->new(); # NewComment | 
my $locale = locale_example; # String | The locale adopted for internationalization. When provided, this locale defines the language for message responses.

eval { 
    $api_instance->jobsHistoryJobIdCommentPut(jobId => $jobId, newComment => $newComment, locale => $locale);
};
if ($@) {
    warn "Exception when calling JobsApi->jobsHistoryJobIdCommentPut: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = openapi_client.JobsApi()
jobId = jobId_example # String | The ID of the job to be edited. (default to null)
newComment = {"newComment":"Some explanation about the job execution."} # NewComment | 
locale = locale_example # String | The locale adopted for internationalization. When provided, this locale defines the language for message responses. (optional) (default to null)

try: 
    # Changes a job comment.
    api_instance.jobs_history_job_id_comment_put(jobId, newComment, locale=locale)
except ApiException as e:
    print("Exception when calling JobsApi->jobsHistoryJobIdCommentPut: %s\n" % e)
extern crate JobsApi;

pub fn main() {
    let jobId = jobId_example; // String
    let newComment = {"newComment":"Some explanation about the job execution."}; // NewComment
    let locale = locale_example; // String

    let mut context = JobsApi::Context::default();
    let result = client.jobsHistoryJobIdCommentPut(jobId, newComment, locale, &context).wait();
    println!("{:?}", result);

}

Scopes

Parameters

Path parameters
Name Description
jobId*
String
The ID of the job to be edited.
Required
Body parameters
Name Description
newComment *

The comment to be added to the job.

Query parameters
Name Description
locale
String
The locale adopted for internationalization. When provided, this locale defines the language for message responses.

Responses