@Path(value="/scheduler/")
public interface SchedulerRestInterface
| Modifier and Type | Field and Description |
|---|---|
static String |
defaultStatusFilter |
| Modifier and Type | Method and Description |
|---|---|
void |
addExternalEndpointUrl(String sessionId,
String jobId,
String endpointName,
String externalEndpointUrl,
String endpointIconUri)
Add an external endpoint url to a job.
|
Set<String> |
addJobSignal(String sessionId,
String signal,
String jobId)
Add a signal to the list of signals used by the considered job
|
Set<String> |
addJobSignalWithVariables(String sessionId,
String signal,
String jobId,
Map<String,String> updatedVariables)
Add a signal to the list of signals used by the considered job
|
boolean |
changeStartAt(String sessionId,
String jobId,
String startAt)
Change the START_AT generic information at job level and reset the
scheduledAt at task level
|
boolean |
changeStartAtMultiple(String sessionId,
String startAt,
List<String> jobIdList)
Change the START_AT generic information for multiple jobs and reset the
scheduledAt at task level
|
boolean |
checkJobPermissionMethod(String sessionId,
String method,
String jobId)
Check if the user has the permission to execute the method passed as argument
|
List<String> |
checkJobsPermissionMethod(String sessionId,
String method,
List<String> jobsId)
Check if the user has the permission to execute the method passed as argument
|
Map<String,Map<String,Boolean>> |
checkJobsPermissionMethods(String sessionId,
PermissionForm multipart)
Check if the user has the permission to execute the methods passed as argument for each the given job ids
|
boolean |
checkPermissionMethod(String sessionId,
String method)
Check if the user has the permission to execute the method passed as argument
|
List<JobLabelInfoData> |
createLabels(String sessionId,
List<String> labels)
Creates new labels
|
boolean |
deleteFile(String sessionId,
String spaceName,
String filePath)
Deletes a file or recursively delete a directory from the given DataSpace
|
void |
deleteLabel(String sessionId,
String labelId)
Remove the given label
|
boolean |
deleteLiveLogJob(String sessionId,
String jobId)
remove the live log object.
|
void |
detachService(String sessionId,
String jobId,
int serviceid)
Detach a cloud automation service previously associated with a job.
|
void |
disconnect(String sessionId)
terminates the session id
sessionId |
javax.ws.rs.core.Response |
downloadTaskResult(String sessionId,
String jobId,
String taskname,
String destination,
String sessionToken)
Returns the value of the task result of the task
taskName of
the job jobId This method returns the result as a byte stream. |
void |
enableRemoteVisualization(String sessionId,
String jobid,
String taskname,
String connectionString)
Enable Remote Visualization for a task
|
boolean |
finishInErrorTask(String sessionId,
String jobid,
String taskname)
Finish a task, which is in InError state inside a job.
|
boolean |
freezeScheduler(String sessionId)
freezes the scheduler
|
CompletedJobsCountData |
getCompletedJobs(String sessionId,
boolean myJobs,
String workflowName,
String bucketName,
long startDate,
long endDate,
int numberOfIntervals)
Returns an object containing a map of number of finished jobs with issues by time interval and a map of number of finished jobs without issues by time interval
|
CompletedTasksCountData |
getCompletedTasks(String sessionId,
boolean myTasks,
String taskName,
long startDate,
long endDate,
int numberOfIntervals)
Returns an object containing a map of number of completed tasks with issues by time interval and a map of number of finished tasks without issues by time interval
|
byte[] |
getCreateCredential(LoginForm multipart)
generates a credential file from user provided credentials
|
WorkflowDescription |
getDescription(String sessionId,
String jobId)
Get workflow description from a submitted job
|
List<String> |
getDomains()
Returns the domains configured on the scheduler server.
|
FilteredStatisticsData |
getFilteredStatistics(String sessionId,
long startDate,
long endDate,
boolean myJobs,
String workflowName,
String bucketName)
Returns an object containing jobs count-by-state and statistics based on the given filters
|
String |
getJobContent(String sessionId,
String jobId) |
String |
getJobHtml(String sessionId,
String jobId)
Returns a base64 utf-8 encoded html visualization corresponding to the
jobid.
|
RestPage<String> |
getJobTasksIdsByTag(String sessionId,
String jobId,
String taskTag)
Returns a list of the name of the tasks belonging to job
jobId |
RestPage<String> |
getJobTasksIdsByTagPaginated(String sessionId,
String jobId,
String taskTag,
int offset,
int limit)
Returns a list of the name of the tasks belonging to job
jobId (with pagination) |
RestPage<TaskStateData> |
getJobTaskStates(String sessionId,
String jobId)
Returns a list of taskState
|
RestPage<TaskStateSummaryData> |
getJobTaskStatesAggregated(String sessionId,
String jobId)
Returns a list of task states aggregated for displaying the workflow live graph
task states are aggregated according to replications or iterations blocks
|
RestPage<TaskStateData> |
getJobTaskStatesByTag(String sessionId,
String jobId,
String taskTag)
Returns a list of taskState of the tasks filtered by a given tag.
|
RestPage<TaskStateData> |
getJobTaskStatesByTagByStatusPaginated(String sessionId,
String jobId,
int offset,
int limit,
String taskTag,
javax.ws.rs.core.PathSegment statusFilter) |
RestPage<TaskStateData> |
getJobTaskStatesByTagPaginated(String sessionId,
String jobId,
String taskTag,
int offset,
int limit)
Returns a list of taskState of the tasks filtered by a given tag and
paginated.
|
RestPage<TaskStateData> |
getJobTaskStatesFilteredPaginated(String sessionId,
String jobId,
int offset,
int limit,
String statusFilter) |
RestPage<TaskStateData> |
getJobTaskStatesPaginated(String sessionId,
String jobId,
int offset,
int limit)
Returns a list of taskState with pagination
|
List<TaskStateData> |
getJobTaskStatesWithVisualization(String sessionId,
String jobId)
Returns a list of taskStates, only tasks with visualization activated
|
List<String> |
getJobTaskTags(String sessionId,
String jobId)
Returns a list of the tags of the tasks belonging to job
jobId |
List<String> |
getJobTaskTagsPrefix(String sessionId,
String jobId,
String prefix)
Returns a list of the tags of the tasks belonging to job
jobId and filtered by a prefix pattern |
List<JobLabelInfoData> |
getLabels(String sessionId)
Gets all labels.
|
String |
getLiveLogJob(String sessionId,
String jobId,
boolean allLogs)
Stream the output of job identified by the id
jobid only
stream currently available logs, call this method several times to get
the complete output. |
int |
getLiveLogJobAvailable(String sessionId,
String jobId)
number of available bytes in the stream or -1 if the stream does not
exist.
|
String |
getLoginFromSessionId(String sessionId)
Get the login string associated to the
sessionId if it exists
In case that the given sessionId doesn't have an associated login (session id expired, or invalid),
this endpoint will return an empty string |
Map<Object,Object> |
getPortalConfiguration(String sessionId)
Get portal configuration properties
|
List<String> |
getPreciousTaskName(String sessionId,
String jobId)
Returns the name of the tasks, which has precious result property set on,
and they all releated to the job with
jobId. |
Map<Long,List<String>> |
getPreciousTaskNames(String sessionId,
List<String> jobsId) |
Map<String,Object> |
getSchedulerPropertiesFromSessionId(String sessionId)
returns scheduler properties and web properties in a single map
|
SchedulerStatusData |
getSchedulerStatus(String sessionId)
returns the status of the scheduler
|
String |
getStatHistory(String sessionId,
String function)
Get the statistics history for the last 24 hours.
|
Map<String,String> |
getStatistics(String sessionId)
returns statistics about the scheduler
|
Map<String,String> |
getStatisticsOnMyAccount(String sessionId)
returns a string containing some data regarding the user's account
|
Map<String,Integer> |
getSubmissionModeCount(String sessionId,
long startDate,
long endDate,
boolean myJobs,
String workflowName,
String bucketName)
Returns a map containing the number of jobs submitted from each portal
|
Set<String> |
getSubmissionModeValues(String sessionId)
Returns all the submissionMode values stored in the database
|
RestPage<String> |
getTaskIds(String sessionId,
long from,
long to,
boolean mytasks,
String statusFilter,
int offset,
int limit)
Returns all tasks name regarding the given parameters (decoupled from the
associated jobs).
|
RestPage<String> |
getTaskIdsByTag(String sessionId,
String taskTag,
long from,
long to,
boolean mytasks,
String statusFilter,
int offset,
int limit)
Returns all tasks name regarding the given parameters (decoupled from the
associated jobs).
|
RestPage<String> |
getTasksNames(String sessionId,
String jobId)
Returns a list of the name of the tasks belonging to job
jobId |
RestPage<String> |
getTasksNamesPaginated(String sessionId,
String jobId,
int offset,
int limit)
Returns a list of the name of the tasks belonging to job
jobId with pagination |
RestPage<TaskStateData> |
getTaskStates(String sessionId,
long from,
long to,
boolean mytasks,
String statusFilter,
int offset,
int limit,
SortSpecifierContainer sortParams)
Returns a paginated list of
TaskStateData regarding the
given parameters (decoupled from the associated jobs). |
RestPage<TaskStateData> |
getTaskStatesByTag(String sessionId,
String taskTag,
long from,
long to,
boolean mytasks,
String statusFilter,
int offset,
int limit,
SortSpecifierContainer sortParams)
Returns a paginated list of
TaskStateData regarding the
given parameters (decoupled from the associated jobs). |
List<WorkflowDurationData> |
getTopExecutionTimeWorkflows(String sessionId,
int numberOfWorkflows,
long startDate,
long endDate,
boolean myJobs,
String workflowName,
String bucketName)
Returns an object containing the top workflows with the longest execution time based on the given filters
|
List<WorkflowDurationData> |
getTopPendingTimeWorkflows(String sessionId,
int numberOfWorkflows,
long startDate,
long endDate,
boolean myJobs,
String workflowName,
String bucketName)
Returns an object containing the top workflows with the longest pending time based on the given filters
|
List<FilteredTopWorkflowsCumulatedCoreTimeData> |
getTopWorkflowsCumulatedCoreTime(String sessionId,
int numberOfWorkflows,
long startDate,
long endDate,
boolean myJobs,
String workflowName,
String bucketName)
Returns an object containing the top workflows that consumes the most CPU
|
List<FilteredTopWorkflowsNumberOfNodesData> |
getTopWorkflowsNumberOfNodes(String sessionId,
int numberOfWorkflows,
long startDate,
long endDate,
boolean myJobs,
String workflowName,
String bucketName,
boolean inParallel)
Returns an object containing the top workflows that use most nodes
|
List<FilteredTopWorkflowData> |
getTopWorkflowsWithIssues(String sessionId,
int numberOfWorkflows,
long startDate,
long endDate,
boolean myJobs,
String workflowName,
String bucketName)
Returns an object containing the top workflows with issues based on the given filters
|
String |
getUrl()
Returns the url of the scheduler server.
|
List<JobUsageData> |
getUsageOnAccount(String sessionId,
String user,
Date startDate,
Date endDate)
Returns details on job and task execution times for the caller's
executions.
|
List<JobUsageData> |
getUsageOnMyAccount(String sessionId,
Date startDate,
Date endDate)
Returns details on job and task execution times for the caller's
executions.
|
UserData |
getUserDataFromSessionId(String sessionId)
Get a UserData object associated to the user connected with the
sessionId
In case that the given sessionId doesn't have an associated login (session id expired, or invalid),
this endpoint will return null |
List<SchedulerUserData> |
getUsers(String sessionId)
Users currently connected to the scheduler
|
List<SchedulerUserData> |
getUsersWithJobs(String sessionId)
Users having jobs in the scheduler
|
List<String> |
globalspaceURIs(String sessionId) |
boolean |
isConnected(String sessionId)
Tests whether or not the user is connected to the ProActive Scheduler
|
javax.ws.rs.core.Response |
jobFullLogs(String sessionId,
String jobId,
String session,
String destination)
Returns full logs generated by tasks in job.
|
JobInfoData |
jobInfo(String sessionId,
String jobId)
Returns the job info associated to the job referenced by the id
jobid |
String |
jobLogs(String sessionId,
String jobId)
Returns all the logs generated by the job (either stdout and stderr)
When tasks inside this jobs have several execution attempts, only last attempt logs with be contained in the job log.
|
JobResultData |
jobResult(String sessionId,
String jobId)
Returns the job result associated to the job referenced by the id
jobid |
Map<String,String> |
jobResultMap(String sessionId,
String jobId)
Returns the job results map associated to the job referenced by the id
jobid |
Map<Long,Map<String,String>> |
jobResultMaps(String sessionId,
List<String> jobsId) |
Map<String,String> |
jobResultValue(String sessionId,
String jobId)
Returns all the task results of this job as a map whose the key is the
name of the task and its task result.
If the result cannot be instantiated, the content is replaced by the string 'Unknown value type'. |
RestPage<String> |
jobs(String sessionId,
int index,
int limit)
Returns the ids of the current jobs under a list of string.
|
String |
jobServerLog(String sessionId,
String jobId)
Returns job server logs
|
RestPage<UserJobData> |
jobsInfo(String sessionId,
int index,
int limit)
Returns a subset of the scheduler state, including pending, running,
finished jobs (in this particular order).
|
List<UserJobData> |
jobsInfoList(String sessionId,
List<String> jobsId)
Returns a list of jobs info corresponding to the given job IDs (in the same order)
|
List<UserJobData> |
jobsInfoListPost(String sessionId,
List<String> jobsId)
Returns a list of jobs info corresponding to the given job IDs (in the same order)
|
TaskStateData |
jobTask(String sessionId,
String jobId,
String taskname)
Return the task state of the task
taskname of the job
jobId |
boolean |
killJob(String sessionId,
String jobId)
Kill the job represented by jobId.
|
boolean |
killJobs(String sessionId,
List<String> jobsId)
Kill multiple jobs
|
boolean |
killScheduler(String sessionId)
kills the scheduler
|
boolean |
killTask(String sessionId,
String jobid,
String taskname)
Kill a task within a job
|
boolean |
linkRm(String sessionId,
String rmURL)
Reconnect a new Resource Manager to the scheduler.
|
JobStateData |
listJobs(String sessionId,
String jobId)
Returns a JobState of the job identified by the id
jobid |
String |
login(String username,
String password)
login to the scheduler using an form containing 2 fields (username and
password)
|
String |
loginOrRenewSession(String sessionId,
LoginForm multipart)
Renew the session identified by the given
sessionId if it exists
or create a new session. |
String |
loginOrRenewSession(String sessionId,
String username,
String password)
Renew the session identified by the given
sessionId if it exists
or create a new session. |
String |
loginWithCredential(LoginForm multipart)
login to the scheduler using a multipart form can be used either by
submitting - 2 fields: username and password - a credential file with
field name 'credential'
|
Map<String,String> |
metadataOfTaskResult(String sessionId,
String jobId,
String taskname)
Returns the metadata of the task result of task
taskName of the
job jobId. |
Map<String,Map<String,String>> |
metadataOfTaskResultByTag(String sessionId,
String jobId,
String taskTag)
Returns the metadata of the task result of task
taskName of the
job jobIdfiltered by a given tag. |
List<JobIdDataAndError> |
multipleSubmitFromUrls(String sessionId,
List<WorkflowUrlData> jsonBody)
Submits a list of workflows to the scheduler from a list of workflow URLs
|
boolean |
pauseJob(String sessionId,
String jobId)
Pauses the job represented by jobid
|
boolean |
pauseScheduler(String sessionId)
pauses the scheduler
|
boolean |
preemptTask(String sessionId,
String jobid,
String taskname)
Preempt a task within a job
|
InputStream |
pullFile(String sessionId,
String spaceName,
String filePath)
Either Pulls a file from the given DataSpace to the local file system or
list the content of a directory if the path refers to a directory In the
case the path to a file is given, the content of this file will be
returns as an input stream In the case the path to a directory is given,
the input stream returned will be a text stream containing at each line
the content of the directory
|
boolean |
pushFile(String sessionId,
String spaceName,
String filePath,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
Pushes a file from the local file system into the given DataSpace
|
void |
putThirdPartyCredential(String sessionId,
String key,
String value) |
void |
registerService(String sessionId,
String jobId,
int serviceInstanceid,
boolean enableActions)
Register a PSA service associated with a job.
|
void |
removeExternalEndpointUrl(String sessionId,
String jobId,
String externalEndpointUrl)
Remove an external endpoint url from a job.
|
boolean |
removeJob(String sessionId,
String jobId)
Delete a job
|
void |
removeJobLabels(String sessionId,
List<String> jobIds)
Removes label from jobs
|
boolean |
removeJobs(String sessionId,
List<String> jobsId,
long olderThan)
Delete a list of jobs
Either jobsId or olderThen parameter can be used to select the list of jobs to remove
|
void |
removeThirdPartyCredential(String sessionId,
String key) |
boolean |
restartAllInErrorTasks(String sessionId,
String jobId)
Restart all tasks in error in the job represented by jobid
|
boolean |
restartInErrorTask(String sessionId,
String jobid,
String taskname)
Restart a pause on error task within a job
|
boolean |
restartTask(String sessionId,
String jobid,
String taskname)
Restart a task within a job
|
JobIdData |
reSubmit(String sessionId,
String jobId,
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jsonBody,
javax.ws.rs.core.UriInfo contextInfos)
Re-submit a job to the scheduler
|
JobIdData |
reSubmit(String sessionId,
String jobId,
javax.ws.rs.core.PathSegment pathSegment,
javax.ws.rs.core.UriInfo contextInfos)
Re-submit a job to the scheduler
|
List<JobIdData> |
reSubmitAll(String sessionId,
List<String> jobsId)
Re-submit a list of jobs to the scheduler
|
boolean |
resumeJob(String sessionId,
String jobId)
Resumes the job represented by jobid
|
boolean |
resumeScheduler(String sessionId)
resumes the scheduler
|
RestMapPage<Long,ArrayList<UserJobData>> |
revisionAndJobsInfo(String sessionId,
Long jobId,
int index,
int limit,
boolean myJobs,
boolean pending,
boolean running,
boolean finished,
boolean withIssuesOnly,
boolean childJobs,
String jobName,
String projectName,
String bucketName,
String submissionMode,
String label,
String userName,
String tenant,
Long parentId,
String sortParams,
String status,
long submittedTimeGreater,
long submittedTimeLessThan,
long startAtTimeGreater,
long startAtTimeLessThan)
Returns a map containing one entry with the revision id as key and the
list of UserJobData as value.
|
void |
schedulerChangeJobPriorityByName(String sessionId,
String jobId,
String priorityName)
changes the priority of a job
|
void |
schedulerChangeJobPriorityByValue(String sessionId,
String jobId,
String priorityValue)
changes the priority of a job
|
long |
schedulerStateRevision(String sessionId)
Returns the revision number of the scheduler state
|
byte[] |
serializedValueOfTaskResult(String sessionId,
String jobId,
String taskname)
Returns the value of the task result of the task
taskName of
the job jobId This method returns the result as a byte array
whatever the result is. |
Map<String,byte[]> |
serializedValueOfTaskResultByTag(String sessionId,
String jobId,
String taskTag)
Returns the values of a set of tasks of the job
jobId
filtered by a given tag. |
void |
setLabelOnJobs(String sessionId,
String labelId,
List<String> jobIds)
Sets label on jobs
|
List<JobLabelInfoData> |
setLabels(String sessionId,
List<String> labels)
Sets the list of labels.
|
boolean |
shutdownScheduler(String sessionId)
shutdown the scheduler
|
boolean |
startScheduler(String sessionId)
starts the scheduler
|
boolean |
stopScheduler(String sessionId)
stops the scheduler
|
JobIdData |
submit(String sessionId,
javax.ws.rs.core.PathSegment pathSegment,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart,
javax.ws.rs.core.UriInfo contextInfos)
Submits a job to the scheduler
|
JobIdData |
submitFlat(String sessionId,
String commandFileContent,
String jobName,
String selectionScriptContent,
String selectionScriptExtension)
Submit job using flat command file
|
JobIdData |
submitFromUrl(String sessionId,
String url,
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jsonBody,
javax.ws.rs.core.UriInfo contextInfos)
Submits a workflow to the scheduler from a workflow URL, creating hence a
new job resource.
|
JobIdData |
submitFromUrl(String sessionId,
String url,
javax.ws.rs.core.PathSegment pathSegment,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart,
javax.ws.rs.core.UriInfo contextInfos)
Submits a workflow to the scheduler from a workflow URL, creating hence a
new job resource.
|
JobIdData |
submitFromUrl(String sessionId,
String url,
javax.ws.rs.core.PathSegment pathSegment,
javax.ws.rs.core.UriInfo contextInfos)
Submits a workflow to the scheduler from a workflow URL, creating hence a
new job resource.
|
JobResultData |
submitFromUrlSync(String sessionId,
String url,
Long timeout,
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jsonBody,
javax.ws.rs.core.UriInfo contextInfos)
Submits a workflow synchronously to the scheduler from a workflow URL, creating hence a
new job resource.
|
String |
submitPlannings(String sessionId,
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jobContentXmlString)
submit a planned workflow
|
InputStream |
taskFullLogs(String sessionId,
String jobId,
String taskname,
String session)
Returns full logs generated by the task from user data spaces if task was
run using the precious logs option.
|
String |
taskLog(String sessionId,
String jobId,
String taskname)
Returns all the logs generated by the task (either stdout and stderr).
|
String |
taskLogByTag(String sessionId,
String jobId,
String taskTag)
Returns all the logs generated by a set of the tasks (either stdout and
stderr) filtered by a tag.
|
String |
taskLogErr(String sessionId,
String jobId,
String taskname)
Returns the standard error output (stderr) generated by the task
Multiple task execution attempts are included.
|
String |
taskLogErrByTag(String sessionId,
String jobId,
String taskTag)
Returns the list of standard error outputs (stderr) generated by a set of
tasks filtered by a given tag.
|
String |
taskLogout(String sessionId,
String jobId,
String taskname)
Returns the standard output (stdout) generated by the task
Multiple task execution attempts are included.
|
String |
taskLogoutByTag(String sessionId,
String jobId,
String taskTag)
Returns the standard output (stdout) generated by a set of tasks filtered
by a given tag.
|
TaskResultData |
taskResult(String sessionId,
String jobId,
String taskname)
Returns the task result of the task
taskName of the job
jobId |
List<TaskResultData> |
taskResultByTag(String sessionId,
String jobId,
String taskTag)
Returns the task results of the set of task filtered by a given tag and
owned by the job
jobId |
String |
taskServerLog(String sessionId,
String jobId,
String taskname)
Returns task server logs
|
String |
taskServerLogByTag(String sessionId,
String jobId,
String taskTag)
Returns server logs for a set of tasks filtered by a given tag.
|
Set<String> |
thirdPartyCredentialsKeySet(String sessionId) |
JobLabelInfoData |
updateLabel(String sessionId,
String labelId,
String newLabel)
Update the given label
|
List<String> |
userspaceURIs(String sessionId) |
JobValidationData |
validate(String sessionId,
javax.ws.rs.core.PathSegment pathSegment,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
Validates a job
|
JobValidationData |
validate(String sessionId,
String jobId,
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jsonBody,
javax.ws.rs.core.UriInfo contextInfos)
Validate job variables before resubmitting a job
|
JobValidationData |
validate(String sessionId,
String jobId,
javax.ws.rs.core.PathSegment pathSegment,
javax.ws.rs.core.UriInfo contextInfos)
Validate job variables before resubmitting a job
|
JobValidationData |
validateFromUrl(String sessionId,
String url,
Map<String,String> jsonBody,
javax.ws.rs.core.PathSegment pathSegment)
Validates a workflow taken from a given URL
|
JobValidationData |
validateFromUrl(String sessionId,
String url,
javax.ws.rs.core.PathSegment pathSegment)
Validates a workflow taken from a given URL
|
JobValidationData |
validateFromUrl(String sessionId,
String url,
javax.ws.rs.core.PathSegment pathSegment,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
Validates a workflow taken from a given URL
|
JobValidationData |
validateJobSignal(String sessionId,
String signal,
String jobId,
Map<String,String> updatedVariables)
Validate the signal's output values
|
String |
valueOfTaskResult(String sessionId,
String jobId,
String taskname)
Returns the value of the task result of task
taskName of the
job jobId the result is deserialized before sending
to the client, if the class is not found the content is replaced by the
string 'Unknown value type' . |
Map<String,String> |
valueOfTaskResultByTag(String sessionId,
String jobId,
String taskTag)
Returns the values of a set of tasks of the job
jobId
filtered by a given tag. |
static final String defaultStatusFilter
@GET @Path(value="url") @Produces(value="text/plain") String getUrl()
@GET @Path(value="domains") @Produces(value="application/json") List<String> getDomains()
@GET @Path(value="jobs") @Produces(value="application/json") RestPage<String> jobs(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="index") @DefaultValue(value="-1") int index, @QueryParam(value="limit") @DefaultValue(value="-1") int limit) throws RestException
sessionId - a valid session idindex - optional, if a sublist has to be returned the index of the
sublistlimit - optional, if a sublist has to be returned, the limit of the
sublistRestException@GET
@Path(value="jobsinfo")
@Produces(value={"application/json","application/xml"})
RestPage<UserJobData> jobsInfo(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="index") @DefaultValue(value="-1")
int index,
@QueryParam(value="limit") @DefaultValue(value="-1")
int limit)
throws RestException
index - optional, if a sublist has to be returned the index of the
sublistlimit - optional, if a sublist has to be returned, the limit of the
sublistsessionId - a valid session idRestException@GET
@Path(value="jobsinfolist")
@Produces(value={"application/json","application/xml"})
List<UserJobData> jobsInfoList(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="jobsid")
List<String> jobsId)
throws RestException
jobsId - the list of id of the jobs to return, in the same ordersessionId - a valid session idRestException@POST
@Path(value="jobsinfolist")
@Consumes(value="application/json")
@Produces(value={"application/json","application/xml"})
List<UserJobData> jobsInfoListPost(@HeaderParam(value="sessionid")
String sessionId,
List<String> jobsId)
throws RestException
jobsId - the list of id of the jobs to return, in the same ordersessionId - a valid session idRestException@GET
@Path(value="revisionjobsinfo")
@Produces(value={"application/json","application/xml"})
RestMapPage<Long,ArrayList<UserJobData>> revisionAndJobsInfo(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="jobId") @DefaultValue(value="-1")
Long jobId,
@QueryParam(value="index") @DefaultValue(value="-1")
int index,
@QueryParam(value="limit") @DefaultValue(value="-1")
int limit,
@QueryParam(value="myjobs") @DefaultValue(value="false")
boolean myJobs,
@QueryParam(value="pending") @DefaultValue(value="true")
boolean pending,
@QueryParam(value="running") @DefaultValue(value="true")
boolean running,
@QueryParam(value="finished") @DefaultValue(value="true")
boolean finished,
@QueryParam(value="withIssuesOnly") @DefaultValue(value="false")
boolean withIssuesOnly,
@QueryParam(value="childJobs") @DefaultValue(value="true")
boolean childJobs,
@QueryParam(value="jobName") @DefaultValue(value="")
String jobName,
@QueryParam(value="projectName") @DefaultValue(value="")
String projectName,
@QueryParam(value="bucketName") @DefaultValue(value="")
String bucketName,
@QueryParam(value="submissionMode") @DefaultValue(value="")
String submissionMode,
@QueryParam(value="label") @DefaultValue(value="")
String label,
@QueryParam(value="userName") @DefaultValue(value="")
String userName,
@QueryParam(value="tenant")
String tenant,
@QueryParam(value="parentId") @DefaultValue(value="-1")
Long parentId,
@QueryParam(value="sortParams")
String sortParams,
@QueryParam(value="status") @DefaultValue(value="")
String status,
@QueryParam(value="submittedTimeGreater") @DefaultValue(value="0")
long submittedTimeGreater,
@QueryParam(value="submittedTimeLessThan") @DefaultValue(value="0")
long submittedTimeLessThan,
@QueryParam(value="startAtTimeGreater") @DefaultValue(value="0")
long startAtTimeGreater,
@QueryParam(value="startAtTimeLessThan") @DefaultValue(value="0")
long startAtTimeLessThan)
throws RestException
sessionId - a valid session idjobId - Fetch the job having this jobIdindex - optional, if a sublist has to be returned the index of the
sublistlimit - optional, if a sublist has to be returned, the limit of the
sublistmyJobs - fetch only the jobs owned by the user making the requestpending - fetch pending jobsrunning - fetch running jobsfinished - fetch finished jobswithIssuesOnly - fetch only jobs with issueschildJobs - fetch childJobs (submitted by parent job(s))jobName - Include only jobs with a name that starts with jobName (case sensitive)projectName - Include only jobs with a project name that starts with projectName (case sensitive)bucketName - Include only jobs with a bucket name that starts with bucketName (case sensitive)submissionMode - Include only jobs with a submission mode that starts with submissionMode (case sensitive)label - Include only jobs with a label that starts with label (case sensitive)userName - Include only jobs with a user name that matches exactly with userName (case sensitive)parentId - Include only children jobs of the given parent job id. This parameter is ignored if childJobs is set to falsesortParams - string containing sort directives. It must contain a comma separated list of sort parameters.
A sort parameter can contain ID,STATE,OWNER,PRIORITY,NAME,SUBMIT_TIME,START_TIME,IN_ERROR_TIME,FINISH_TIME,TOTAL_TASKS,
PENDING_TASKS,RUNNING_TASKS,FINISHED_TASKS,FAILED_TASKS,FAULTY_TASKS,IN_ERROR_TASKS
Each parameter must end with _d for descending order or _a for ascending.
Default value is: "STATE_a,ID_d"status - Include only jobs with the given status (Pending, Running, Stalled, Finished, Paused, Canceled, Failed, Killed, In-Error)submittedTimeGreater - Include only jobs with a submittedTime after the given EPOCh timesubmittedTimeLessThan - Include only jobs with a submittedTime earlier than the given EPOCH timeRestException@GET
@Path(value="state/revision")
@Produces(value={"application/json","application/xml"})
long schedulerStateRevision(@HeaderParam(value="sessionid")
String sessionId)
throws NotConnectedRestException
sessionId - a valid session id.NotConnectedRestException@GET
@Path(value="jobs/{jobid}")
@Produces(value={"application/json","application/xml"})
JobStateData listJobs(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
jobidsessionId - a valid session idjobId - the id of the job to retrieveRestException@GET
@Path(value="jobs/{jobid}/result")
@Produces(value="application/json")
JobResultData jobResult(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
jobidsessionId - a valid session idRestException@GET
@Path(value="jobs/{jobid}/resultmap")
@Produces(value="application/json")
Map<String,String> jobResultMap(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
jobidsessionId - a valid session idRestException@GET @Path(value="jobs/resultmap") @Produces(value="application/json") Map<Long,Map<String,String>> jobResultMaps(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="jobsid") List<String> jobsId) throws RestException
sessionId - a valid session idjobsId - the list of job idsRestException@GET
@Path(value="jobs/{jobid}/info")
@Produces(value="application/json")
JobInfoData jobInfo(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
jobidsessionId - a valid session idRestException@GET
@Path(value="jobs/{jobid}/result/value")
@Produces(value="application/json")
Map<String,String> jobResultValue(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - a job idRestException@DELETE
@Path(value="jobs/{jobid}")
@Produces(value="application/json")
boolean removeJob(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the id of the job to deleteRestException@DELETE
@Path(value="jobs")
@Produces(value="application/json")
boolean removeJobs(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="jobsid")
List<String> jobsId,
@QueryParam(value="olderThan")
long olderThan)
throws RestException
jobsId - list of jobs id to removeolderThan - all jobs finished earlier than the given epoch time will be removedRestException@GET
@Path(value="jobs/{jobid}/log/server")
@Produces(value={"text/plain","application/json"})
String jobServerLog(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the id of the jobRestException@PUT
@Path(value="jobs/{jobid}/kill")
@Produces(value="application/json")
boolean killJob(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the job to kill.RestException@PUT
@Path(value="jobs/kill")
@Produces(value="application/json")
boolean killJobs(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="jobsid")
List<String> jobsId)
throws RestException
sessionId - a valid session idjobsId - job ids to killRestException@GET
@Path(value="jobs/{jobid}/tasks")
@Produces(value="application/json")
RestPage<String> getTasksNames(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
jobIdsessionId - a valid session idjobId - jobid one wants to list the tasks' nameRestException@GET
@Path(value="jobs/{jobid}/tasks/paginated")
@Produces(value="application/json")
RestPage<String> getTasksNamesPaginated(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@QueryParam(value="offset") @DefaultValue(value="0")
int offset,
@QueryParam(value="limit") @DefaultValue(value="-1")
int limit)
throws RestException
jobId with paginationsessionId - a valid session idjobId - jobid one wants to list the tasks' nameoffset - the number of the first task to fetchlimit - the number of the last task to fetch (non inclusive)RestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}")
@Produces(value="application/json")
RestPage<String> getJobTasksIdsByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
jobIdsessionId - a valid session idjobId - jobid one wants to list the tasks' nametaskTag - the tag used to filter the tasks.RestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/paginated")
@Produces(value="application/json")
RestPage<String> getJobTasksIdsByTagPaginated(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag,
@QueryParam(value="offset") @DefaultValue(value="0")
int offset,
@QueryParam(value="limit") @DefaultValue(value="-1")
int limit)
throws RestException
jobId (with pagination)sessionId - a valid session id.jobId - the job id.taskTag - the tag used to filter the tasks.offset - the number of the first task to fetchlimit - the number of the last task to fetch (non inclusive)RestException@GET @Path(value="tasks") @Produces(value="application/json") RestPage<String> getTaskIds(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="from") @DefaultValue(value="0") long from, @QueryParam(value="to") @DefaultValue(value="0") long to, @QueryParam(value="mytasks") @DefaultValue(value="false") boolean mytasks, @QueryParam(value="statusFilter") @DefaultValue(value="running;pending;finished") String statusFilter, @QueryParam(value="offset") @DefaultValue(value="0") int offset, @QueryParam(value="limit") @DefaultValue(value="-1") int limit) throws RestException
offset and limit parameters. If those
parameters are not specified, the following values will be used: [0,
DEFAULT_VALUE[ The DEFAULT_VALUE can be set in the scheduler config file
as the pa.scheduler.tasks.page.size parameter.sessionId - a valid session id.from - the scheduled date to which we start fetching tasks. The
format is in Epoch time.to - the end scheduled end date to stop fetching tasks. The format
is in Epoch time.mytasks - True if you want to fetch only the user's tasks.
Default value is False.statusFilter - String contains list of aggregated task statuses, like "Current", "Past", etc.
These values joined by semi colon.offset - the index of the first task to fetch (for pagination).limit - the index of the last (excluded) task to fetch (for
pagination).RestException@GET
@Path(value="tasks/tag/{tasktag}")
@Produces(value="application/json")
RestPage<String> getTaskIdsByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="tasktag")
String taskTag,
@QueryParam(value="from") @DefaultValue(value="0")
long from,
@QueryParam(value="to") @DefaultValue(value="0")
long to,
@QueryParam(value="mytasks") @DefaultValue(value="false")
boolean mytasks,
@QueryParam(value="statusFilter") @DefaultValue(value="running;pending;finished")
String statusFilter,
@QueryParam(value="offset") @DefaultValue(value="0")
int offset,
@QueryParam(value="limit") @DefaultValue(value="-1")
int limit)
throws RestException
offset and limit parameters. If those
parameters are not specified, the following values will be used: [0,
DEFAULT_VALUE[ The DEFAULT_VALUE can be set in the scheduler config file
as the pa.scheduler.tasks.page.size parameter.sessionId - a valid session id.taskTag - tag to filter the tasks. The tag should be complete as the
criteria is strict.from - the scheduled date to which we start fetching tasks. The
format is in Epoch time.to - the end scheduled end date to stop fetching tasks. The format
is in Epoch time.mytasks - True if you want to fetch only the user's tasks.
Default value is False.statusFilter - String contains list of aggregated task statuses, like "Current", "Past", etc.
These values joined by semi colon.offset - the index of the first task to fetch (for pagination).limit - the index of the last (excluded) task to fetch (for
pagination).RestException@GET
@Path(value="jobs/{jobid}/tasks/tags")
@Produces(value="application/json")
List<String> getJobTaskTags(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
jobIdsessionId - a valid session idjobId - jobid one wants to list the tasks' tagsRestException@GET
@Path(value="jobs/{jobid}/tasks/tags/startsWith/{prefix}")
@Produces(value="application/json")
List<String> getJobTaskTagsPrefix(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="prefix")
String prefix)
throws RestException
jobId and filtered by a prefix patternsessionId - a valid session idjobId - jobid one wants to list the tasks' tagsprefix - the prefix used to filter tagsRestException@GET
@Path(value="jobs/{jobid}/html")
@Produces(value="application/json;charset=utf-8")
String getJobHtml(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws IOException,
NotConnectedRestException,
UnknownJobRestException,
PermissionRestException
sessionId - a valid session idjobId - the job idIOException - when it is not possible to access to the archiveNotConnectedRestExceptionUnknownJobRestExceptionPermissionRestException@GET
@Path(value="jobs/{jobid}/xml")
@Produces(value={"application/xml","application/json"})
String getJobContent(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - job id which corresponds to already submitted jobUnknownJobRestException - if jobId does not correspond to any jobPermissionRestException - if current user does not have rights to access job with jobIdRestException@GET
@Path(value="jobs/{jobid}/taskstates")
@Produces(value="application/json")
RestPage<TaskStateData> getJobTaskStates(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the job idjobId and the
total numberRestException@GET
@Path(value="jobs/{jobid}/taskstates/aggregated")
@Produces(value="application/json")
RestPage<TaskStateSummaryData> getJobTaskStatesAggregated(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the job idjobIdRestException@GET
@Path(value="jobs/{jobid}/taskstates/visualization")
@Produces(value="application/json")
List<TaskStateData> getJobTaskStatesWithVisualization(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the job idRestException@GET
@Path(value="jobs/{jobid}/taskstates/paginated")
@Produces(value="application/json")
RestPage<TaskStateData> getJobTaskStatesPaginated(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@QueryParam(value="offset") @DefaultValue(value="0")
int offset,
@QueryParam(value="limit") @DefaultValue(value="50")
int limit)
throws RestException
sessionId - a valid session idjobId - the job idoffset - the index of the first TaskState to returnlimit - the index (non inclusive) of the last TaskState to returnjobId and the
total numberRestException@GET
@Path(value="jobs/{jobid}/taskstates/filtered/paginated")
@Produces(value="application/json")
RestPage<TaskStateData> getJobTaskStatesFilteredPaginated(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@QueryParam(value="offset") @DefaultValue(value="0")
int offset,
@QueryParam(value="limit") @DefaultValue(value="50")
int limit,
@QueryParam(value="statusFilter") @DefaultValue(value="")
String statusFilter)
throws RestException
RestException@GET
@Path(value="jobs/{jobid}/taskstates/{tasktag}")
@Produces(value="application/json")
RestPage<TaskStateData> getJobTaskStatesByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
sessionId - a valid session id.jobId - the job id.taskTag - the tag used to filter the tasks.jobId filtered by
a given tag and the total numberRestException@GET
@Path(value="jobs/{jobid}/taskstates/{tasktag}/paginated")
@Produces(value="application/json")
RestPage<TaskStateData> getJobTaskStatesByTagPaginated(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag,
@QueryParam(value="offset") @DefaultValue(value="0")
int offset,
@QueryParam(value="limit") @DefaultValue(value="50")
int limit)
throws RestException
sessionId - a valid session id.jobId - the job id.taskTag - the tag used to filter the tasks.offset - the number of the first task to fetchlimit - the number of the last task to fetch (non inclusive)jobId filtered by
a given tag, and the total numberRestException@GET
@Path(value="jobs/{jobid}/taskstates/{tasktag}/{statusFilter}/paginated")
@Produces(value="application/json")
RestPage<TaskStateData> getJobTaskStatesByTagByStatusPaginated(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@QueryParam(value="offset") @DefaultValue(value="0")
int offset,
@QueryParam(value="limit") @DefaultValue(value="50")
int limit,
@PathParam(value="tasktag")
String taskTag,
@PathParam(value="statusFilter")
javax.ws.rs.core.PathSegment statusFilter)
throws RestException
RestException@GET @Path(value="taskstates") @Produces(value="application/json") RestPage<TaskStateData> getTaskStates(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="from") @DefaultValue(value="0") long from, @QueryParam(value="to") @DefaultValue(value="0") long to, @QueryParam(value="mytasks") @DefaultValue(value="false") boolean mytasks, @QueryParam(value="statusFilter") @DefaultValue(value="running;pending;finished") String statusFilter, @QueryParam(value="offset") @DefaultValue(value="0") int offset, @QueryParam(value="limit") @DefaultValue(value="-1") int limit, @QueryParam(value="sortparameters") SortSpecifierContainer sortParams) throws RestException
TaskStateData regarding the
given parameters (decoupled from the associated jobs). The result is
paginated using the optional offset and limit
parameters. If those parameters are not specified, the following values
will be used: [0, DEFAULT_VALUE[ The DEFAULT_VALUE can be set in the
scheduler config file as the pa.scheduler.tasks.page.size
parameter.sessionId - a valid session id.from - the scheduled date to which we start fetching tasks. The
format is in Epoch time.to - the end scheduled end date to stop fetching tasks. The format
is in Epoch time.mytasks - True if you want to fetch only the user's tasks.
Default value is False.statusFilter - String contains list of aggregated task statuses, like "Current", "Past", etc.
These values joined by semi colon.offset - the index of the first task to fetch (for pagination).limit - the index of the last (excluded) task to fetch (for
pagination).TaskStateData and the total number of
them.RestException@GET
@Path(value="taskstates/tag/{tasktag}")
@Produces(value="application/json")
RestPage<TaskStateData> getTaskStatesByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="tasktag")
String taskTag,
@QueryParam(value="from") @DefaultValue(value="0")
long from,
@QueryParam(value="to") @DefaultValue(value="0")
long to,
@QueryParam(value="mytasks") @DefaultValue(value="false")
boolean mytasks,
@QueryParam(value="statusFilter") @DefaultValue(value="running;pending;finished")
String statusFilter,
@QueryParam(value="offset") @DefaultValue(value="0")
int offset,
@QueryParam(value="limit") @DefaultValue(value="-1")
int limit,
@QueryParam(value="sortparameters")
SortSpecifierContainer sortParams)
throws RestException
TaskStateData regarding the
given parameters (decoupled from the associated jobs). The result is
paginated using the optional offset and limit
parameters. If those parameters are not specified, the following values
will be used: [0, DEFAULT_VALUE[ The DEFAULT_VALUE can be set in the
scheduler config file as the pa.scheduler.tasks.page.size
parameter.sessionId - a valid session id.taskTag - tag to filter the tasks. The tag should be complete as the
criteria is strict.from - the scheduled date to which we start fetching tasks. The
format is in Epoch time.to - the end scheduled end date to stop fetching tasks. The format
is in Epoch time.mytasks - True if you want to fetch only the user's tasks.
False will fetch everything.statusFilter - String contains list of aggregated task statuses, like "Current", "Past", etc.
These values joined by semi colon.offset - the index of the first task to fetch (for pagination).limit - the index of the last (excluded) task to fetch (for
pagination).TaskStateData and the total number of
them.RestException@GET
@Path(value="jobs/{jobid}/log/full")
@Produces(value={"text/plain","application/json"})
javax.ws.rs.core.Response jobFullLogs(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@QueryParam(value="sessionid")
String session,
@QueryParam(value="destination")
String destination)
throws RestException,
IOException
sessionId - a valid session idjobId - the id of the jobsession - a valid session id as query parameterdestination - possible values "file" or "browser". In the first case,
Content-disposition and attachment will be included in the response.
Default is browserRestExceptionIOException@GET
@Path(value="jobs/{jobid}/result/log/all")
@Produces(value={"text/plain","application/json"})
String jobLogs(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the id of the jobRestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}")
@Produces(value="application/json")
TaskStateData jobTask(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
taskname of the job
jobIdsessionId - a valid session idjobId - the id of the jobtaskname - the name of the tasktaskname of the job
jobIdRestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result/value")
@Produces(value={"text/plain","application/json"})
String valueOfTaskResult(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
taskName of the
job jobId the result is deserialized before sending
to the client, if the class is not found the content is replaced by the
string 'Unknown value type' . To get the serialized form of a
given result, one has to call the following restful service
jobs/{jobid}/tasks/{taskname}/result/serializedvaluesessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskRestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/result/value")
@Produces(value="application/json")
Map<String,String> valueOfTaskResultByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
jobId
filtered by a given tag. The result is deserialized before
sending to the client, if the class is not found the content is replaced
by the string 'Unknown value type' . To get the serialized form
of a given result, one has to call the following restful service
jobs/{jobid}/tasks/tag/{tasktag}/result/serializedvaluesessionId - a valid session idjobId - the id of the jobtaskTag - the tag used to filter the tasks.RestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result/metadata")
@Produces(value="application/json")
Map<String,String> metadataOfTaskResult(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
taskName of the
job jobId.
Metadata is a map containing additional information associated with a result. For example a file name if the result represents a file.sessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskRestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/result/metadata")
@Produces(value="application/json")
Map<String,Map<String,String>> metadataOfTaskResultByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
taskName of the
job jobIdfiltered by a given tag.
Metadata is a map containing additional information associated with a result. For example a file name if the result represents a file.
sessionId - a valid session idjobId - the id of the jobtaskTag - the tag used to filter the tasks.RestException@GET
@Path(value="jobs/{jobid}/tasks/results/precious/metadata")
@Produces(value="application/json")
List<String> getPreciousTaskName(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
jobId.sessionId - a valid session idjobId - the id of the jobRestException@GET @Path(value="jobs/result/precious/metadata") @Produces(value="application/json") Map<Long,List<String>> getPreciousTaskNames(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="jobsid") List<String> jobsId) throws RestException
sessionId - a valid session idjobsId - the list of job idsRestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result/serializedvalue")
@Produces(value="*/*")
byte[] serializedValueOfTaskResult(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
taskName of
the job jobId This method returns the result as a byte array
whatever the result is.sessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskRestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result/download")
@Produces(value="*/*")
javax.ws.rs.core.Response downloadTaskResult(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname,
@QueryParam(value="destination")
String destination,
@QueryParam(value="sessionToken")
String sessionToken)
throws RestException
taskName of
the job jobId This method returns the result as a byte stream.
The response may include additional information such as Content-Type and Content-disposition
if the result is associated with the corresponding metadatasessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskdestination - possible values "file" or "browser". In the first case,
Content-disposition and attachment may be included in the response. In the second case, only Content-Type may be included.
Default is browsersessionToken - alternative way to pass the sessionid as a query parameterRestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/result/serializedvalue")
@Produces(value="application/json")
Map<String,byte[]> serializedValueOfTaskResultByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
jobId
filtered by a given tag. This method returns the result as a byte array
whatever the result is.sessionId - a valid session idjobId - the id of the jobtaskTag - the tag used to filter the tasks.RestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result")
@Produces(value="application/json")
TaskResultData taskResult(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
taskName of the job
jobIdsessionId - a valid session idjobId - the id of the jobtaskname - the name of the tasktaskNameRestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/result")
@Produces(value="application/json")
List<TaskResultData> taskResultByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
jobIdsessionId - a valid session idjobId - the id of the jobtaskTag - the tag used to filter the tasks.RestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result/log/all")
@Produces(value={"text/plain","application/json"})
String taskLog(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
sessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskRestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/result/log/all")
@Produces(value={"text/plain","application/json"})
String taskLogByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
sessionId - a valid session idjobId - the id of the jobtaskTag - the tag used to filter the tasks.RestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result/log/err")
@Produces(value={"text/plain","application/json"})
String taskLogErr(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
sessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskRestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/result/log/err")
@Produces(value={"text/plain","application/json"})
String taskLogErrByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
sessionId - a valid session idjobId - the id of the jobtaskTag - the tag used to filter the tasksRestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result/log/out")
@Produces(value={"text/plain","application/json"})
String taskLogout(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
sessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskRestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/result/log/out")
@Produces(value={"text/plain","application/json"})
String taskLogoutByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
sessionId - a valid session idjobId - the id of the jobtaskTag - the tag used to filter the tasks.RestException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/result/log/full")
@Produces(value={"text/plain","application/json"})
InputStream taskFullLogs(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname,
@QueryParam(value="sessionid")
String session)
throws RestException,
IOException
sessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskRestExceptionIOException@GET
@Path(value="jobs/{jobid}/tasks/{taskname}/log/server")
@Produces(value={"text/plain","application/json"})
String taskServerLog(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="taskname")
String taskname)
throws RestException
sessionId - a valid session idjobId - the id of the jobtaskname - the name of the taskRestException@GET
@Path(value="jobs/{jobid}/tasks/tag/{tasktag}/log/server")
@Produces(value={"text/plain","application/json"})
String taskServerLogByTag(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="tasktag")
String taskTag)
throws RestException
sessionId - a valid session idjobId - the id of the jobtaskTag - the tag used to filter the tasks in the job.RestException@PUT
@Path(value="jobs/{jobid}/pause")
@Produces(value="application/json")
boolean pauseJob(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the id of the jobRestException@PUT
@Path(value="jobs/{jobid}/restartAllInErrorTasks")
@Produces(value="application/json")
boolean restartAllInErrorTasks(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the id of the jobRestException@PUT
@Path(value="jobs/{jobid}/resume")
@Produces(value="application/json")
boolean resumeJob(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - a valid session idjobId - the id of the jobRestException@POST @Path(value="submitflat") @Produces(value="application/json") JobIdData submitFlat(@HeaderParam(value="sessionid") String sessionId, @FormParam(value="commandFileContent") String commandFileContent, @FormParam(value="jobName") String jobName, @FormParam(value="selectionScriptContent") String selectionScriptContent, @FormParam(value="selectionScriptExtension") String selectionScriptExtension) throws IOException, RestException
sessionId - valid session idcommandFileContent - content of a command file: line separated native commandsjobName - name of the job to createselectionScriptContent - content of a selection script, or nullselectionScriptExtension - extension of the selectionscript to determine script engine
("js", "py", "rb")IOExceptionRestException@POST
@Path(value="{path:submit}")
@Consumes(value="multipart/form-data")
@Produces(value="application/json")
JobIdData submit(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws JobCreationRestException,
NotConnectedRestException,
PermissionRestException,
SubmissionClosedRestException,
IOException
sessionId - a valid session idpathSegment - variables of the workflowmultipart - a form with the job file as form datacontextInfos - the context informations (generic parameters,..)jobid of the newly created jobJobCreationRestExceptionNotConnectedRestExceptionPermissionRestExceptionSubmissionClosedRestExceptionIOException@GET
@Path(value="jobs/{jobid}/{path:resubmit}")
@Produces(value="application/json")
JobIdData reSubmit(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws IOException,
RestException
sessionId - a valid session idjobId - job id of the already submitted jobpathSegment - variables of the workflowjobid of the newly created jobPermissionRestException - if user does not have rights to access job with jobIdIOExceptionRestException@POST
@Path(value="jobs/{jobid}/{path:resubmit/body}")
@Consumes(value="application/json")
@Produces(value="application/json")
JobIdData reSubmit(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jsonBody,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws IOException,
RestException
sessionId - a valid session idjobId - job id of the already submitted jobpathSegment - variables of the workflowjsonBody - a json with the variables of the workflowjobid of the newly created jobPermissionRestException - if user does not have rights to access job with jobIdIOExceptionRestException@POST
@Path(value="jobs/{jobid}/{path:validate/body}")
@Consumes(value="application/json")
@Produces(value="application/json")
JobValidationData validate(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jsonBody,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws IOException,
RestException
sessionId - a valid session idjobId - job id of the already submitted jobpathSegment - variables of the workflowjsonBody - a json with the variables of the workflowPermissionRestException - if user does not have rights to access job with jobIdIOExceptionRestException@POST
@Path(value="jobs/{jobid}/{path:validate}")
@Produces(value="application/json")
JobValidationData validate(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws IOException,
RestException
sessionId - a valid session idjobId - job id of the already submitted jobpathSegment - variables of the workflowPermissionRestException - if user does not have rights to access job with jobIdIOExceptionRestException@GET
@Path(value="jobs/{jobid}/description")
@Produces(value="application/json")
WorkflowDescription getDescription(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws IOException,
RestException
sessionId - a valid session idjobId - job id of the already submitted jobPermissionRestException - if user does not have rights to access job with jobIdIOExceptionRestException@POST @Path(value="jobs/resubmit") @Produces(value="application/json") List<JobIdData> reSubmitAll(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="jobsid") List<String> jobsId) throws RestException
sessionId - a valid session idjobsId - a list of job ids of already submitted jobsjobid of the newly created jobs. If a job submission fails, it will be discarded with a log message.RestException - thrown when not connected or similar errors.@Consumes(value="application/json")
@POST
@Path(value="{path:plannings}")
@Produces(value="application/json")
String submitPlannings(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jobContentXmlString)
throws JobCreationRestException,
NotConnectedRestException,
PermissionRestException,
SubmissionClosedRestException,
IOException
sessionId - user's session in the headerpathSegment - path param going to be transferred to the variablesjobContentXmlString - job content in xml stringJobCreationRestExceptionNotConnectedRestExceptionPermissionRestExceptionSubmissionClosedRestExceptionIOException@POST
@Path(value="{path:jobs}")
@Produces(value="application/json")
JobIdData submitFromUrl(@HeaderParam(value="sessionid")
String sessionId,
@HeaderParam(value="link")
String url,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws JobCreationRestException,
NotConnectedRestException,
PermissionRestException,
SubmissionClosedRestException,
IOException
sessionId - a valid session idurl - url to the workflow contentpathSegment - variables of the workflowcontextInfos - the context informations (generic parameters,..)jobid of the newly created jobJobCreationRestExceptionNotConnectedRestExceptionPermissionRestExceptionSubmissionClosedRestExceptionIOException@POST
@Path(value="{path:jobs}")
@Consumes(value="multipart/form-data")
@Produces(value="application/json")
JobIdData submitFromUrl(@HeaderParam(value="sessionid")
String sessionId,
@HeaderParam(value="link")
String url,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws JobCreationRestException,
NotConnectedRestException,
PermissionRestException,
SubmissionClosedRestException,
IOException
sessionId - a valid session idurl - url to the workflow contentpathSegment - variables of the workflowmultipart - a form with the variables of the workflowcontextInfos - the context informations (generic parameters,..)jobid of the newly created jobJobCreationRestExceptionNotConnectedRestExceptionPermissionRestExceptionSubmissionClosedRestExceptionIOException@POST
@Path(value="{path:jobs}/body")
@Consumes(value="application/json")
@Produces(value="application/json")
JobIdData submitFromUrl(@HeaderParam(value="sessionid")
String sessionId,
@HeaderParam(value="link")
String url,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jsonBody,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws JobCreationRestException,
NotConnectedRestException,
PermissionRestException,
SubmissionClosedRestException,
IOException
sessionId - a valid session idurl - url to the workflow contentpathSegment - variables of the workflowjsonBody - a json with the variables of the workflowcontextInfos - the context informations (generic parameters,..)jobid of the newly created jobJobCreationRestExceptionNotConnectedRestExceptionPermissionRestExceptionSubmissionClosedRestExceptionIOException@POST
@Path(value="{path:jobs}/body/sync")
@Consumes(value="application/json")
@Produces(value="application/json")
JobResultData submitFromUrlSync(@HeaderParam(value="sessionid")
String sessionId,
@HeaderParam(value="link")
String url,
@HeaderParam(value="timeout")
Long timeout,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
Map<String,String> jsonBody,
@Context
javax.ws.rs.core.UriInfo contextInfos)
throws RestException,
IOException
sessionId - a valid session idurl - url to the workflow contenttimeout - timeout in milleseconds to wait for job completionpathSegment - variables of the workflowjsonBody - a json with the variables of the workflowcontextInfos - the context informations (generic parameters,..)job result of the job after terminationRestExceptionIOException@POST
@Path(value="{path:jobs}/body/multi")
@Consumes(value="application/json")
@Produces(value="application/json")
List<JobIdDataAndError> multipleSubmitFromUrls(@HeaderParam(value="sessionid")
String sessionId,
List<WorkflowUrlData> jsonBody)
throws NotConnectedRestException
sessionId - a valid session idjsonBody - a list of workflows. Each element must contain an url, a set of variables and generic informationjobid if submission was successful, or the error description if an error occurred.NotConnectedRestException@POST
@Path(value="dataspace/{spaceName:[a-zA-Z][a-zA-Z_0-9]*}{filePath:.*}")
@Consumes(value="multipart/form-data")
@Produces(value="application/json")
boolean pushFile(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="spaceName")
String spaceName,
@PathParam(value="filePath")
String filePath,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
throws IOException,
NotConnectedRestException,
PermissionRestException
sessionId - a valid session idspaceName - the name of the DataSpacefilePath - the path inside the DataSpace where to put the file e.g.
"/myfolder"multipart - the form data containing : - fileName the name of the file
that will be created on the DataSpace - fileContent the
content of the fileIOExceptionNotConnectedRestExceptionPermissionRestException@GET
@Path(value="dataspace/{spaceName:[a-zA-Z][a-zA-Z_0-9]*}{filePath:.*}")
@Produces(value={"application/octet-stream","application/json"})
InputStream pullFile(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="spaceName")
String spaceName,
@PathParam(value="filePath")
String filePath)
throws IOException,
NotConnectedRestException,
PermissionRestException
sessionId - a valid session idspaceName - the name of the data space involved (GLOBAL or USER)filePath - the path to the file or directory whose content must be
receivedIOExceptionNotConnectedRestExceptionPermissionRestException@DELETE
@Path(value="dataspace/{spaceName:[a-zA-Z][a-zA-Z_0-9]*}{filePath:.*}")
@Produces(value="application/json")
boolean deleteFile(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="spaceName")
String spaceName,
@PathParam(value="filePath")
String filePath)
throws IOException,
NotConnectedRestException,
PermissionRestException
sessionId - a valid session idspaceName - the name of the data space involved (GLOBAL or USER)filePath - the path to the file or directory which must be deletedIOExceptionNotConnectedRestExceptionPermissionRestException@PUT
@Path(value="disconnect")
@Produces(value="application/json")
void disconnect(@HeaderParam(value="sessionid")
String sessionId)
throws RestException
sessionIdsessionId - a valid session idNotConnectedRestException - if the scheduler cannot be contactedPermissionRestException - if you are not authorized to perform the actionRestException@PUT
@Path(value="pause")
@Produces(value="application/json")
boolean pauseScheduler(@HeaderParam(value="sessionid")
String sessionId)
throws RestException
sessionId - a valid session idRestException@PUT
@Path(value="stop")
@Produces(value="application/json")
boolean stopScheduler(@HeaderParam(value="sessionid")
String sessionId)
throws RestException
sessionId - a valid session idRestException@PUT
@Path(value="resume")
@Produces(value="application/json")
boolean resumeScheduler(@HeaderParam(value="sessionid")
String sessionId)
throws RestException
sessionId - a valid session idRestException@PUT
@Path(value="jobs/{jobid}/priority/byname/{name}")
@Produces(value="application/json")
void schedulerChangeJobPriorityByName(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="name")
String priorityName)
throws RestException
sessionId - a valid session idjobId - the job idpriorityName - a string representing the name of the priorityRestException@PUT
@Path(value="jobs/{jobid}/priority/byvalue/{value}")
@Produces(value="application/json")
void schedulerChangeJobPriorityByValue(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="value")
String priorityValue)
throws RestException
sessionId - a valid session idjobId - the job idpriorityValue - a string representing the value of the priorityRestException@PUT
@Path(value="freeze")
@Produces(value="application/json")
boolean freezeScheduler(@HeaderParam(value="sessionid")
String sessionId)
throws RestException
sessionId - a valid session idRestException@GET @Path(value="status") @Produces(value="application/json") SchedulerStatusData getSchedulerStatus(@HeaderParam(value="sessionid") String sessionId) throws RestException
sessionId - a valid session idRestException@PUT
@Path(value="start")
@Produces(value="application/json")
boolean startScheduler(@HeaderParam(value="sessionid")
String sessionId)
throws RestException
sessionId - a valid session idRestException@PUT
@Path(value="kill")
@Produces(value="application/json")
boolean killScheduler(@HeaderParam(value="sessionid")
String sessionId)
throws RestException
sessionId - a valid session idRestException@PUT
@Path(value="shutdown")
@Produces(value="application/json")
boolean shutdownScheduler(@HeaderParam(value="sessionid")
String sessionId)
throws RestException
sessionId - a valid session idRestException@POST
@Path(value="linkrm")
@Produces(value="application/json")
boolean linkRm(@HeaderParam(value="sessionid")
String sessionId,
@FormParam(value="rmurl")
String rmURL)
throws RestException
sessionId - a valid session idrmURL - the url of the resource managerRestException@GET
@Path(value="isconnected")
@Produces(value="application/json")
boolean isConnected(@HeaderParam(value="sessionid")
String sessionId)
throws NotConnectedRestException
sessionId - the session to testNotConnectedRestException@POST
@Consumes(value="application/x-www-form-urlencoded")
@Path(value="login")
@Produces(value={"text/plain","application/json"})
String login(@FormParam(value="username")
String username,
@FormParam(value="password")
String password)
throws LoginException,
SchedulerRestException
username - usernamepassword - passwordLoginExceptionSchedulerRestException@PUT
@Path(value="session")
@Consumes(value="application/x-www-form-urlencoded")
@Produces(value={"text/plain","application/json"})
String loginOrRenewSession(@HeaderParam(value="sessionid")
String sessionId,
@FormParam(value="username")
String username,
@FormParam(value="password")
String password)
throws SchedulerRestException,
LoginException,
NotConnectedRestException
sessionId if it exists
or create a new session.username - usernamepassword - passwordsessionId - session id identifying a session to renew.SchedulerRestExceptionLoginExceptionNotConnectedRestException@PUT
@Path(value="session")
@Consumes(value="multipart/form-data")
@Produces(value={"text/plain","application/json"})
String loginOrRenewSession(@HeaderParam(value="sessionid")
String sessionId,
LoginForm multipart)
throws KeyException,
SchedulerRestException,
LoginException,
NotConnectedRestException
sessionId if it exists
or create a new session.
login to the scheduler using a multipart form can be used either by submitting - 2 fields: username and password - a credential file with field name 'credential'
multipart - passwordsessionId - session id identifying a session to renew.KeyExceptionSchedulerRestExceptionLoginExceptionNotConnectedRestException@GET
@Path(value="logins/sessionid/{sessionId}")
@Produces(value={"text/plain","application/json"})
String getLoginFromSessionId(@PathParam(value="sessionId")
String sessionId)
sessionId if it exists
In case that the given sessionId doesn't have an associated login (session id expired, or invalid),
this endpoint will return an empty stringsessionId - with which the endpoint is going to look for the login value@GET
@Path(value="logins/sessionid/{sessionId}/userdata")
@Produces(value="application/json")
UserData getUserDataFromSessionId(@PathParam(value="sessionId")
String sessionId)
sessionId
In case that the given sessionId doesn't have an associated login (session id expired, or invalid),
this endpoint will return nullsessionId - with which the endpoint is going to look for the login value@POST
@Consumes(value="multipart/form-data")
@Path(value="login")
@Produces(value={"text/plain","application/json"})
String loginWithCredential(LoginForm multipart)
throws KeyException,
LoginException,
SchedulerRestException
KeyExceptionLoginExceptionSchedulerRestException@GET @Path(value="users") @Produces(value="application/json") List<SchedulerUserData> getUsers(@HeaderParam(value="sessionid") String sessionId) throws RestException
sessionId - the session id associated to this new connectionRestException@GET @Path(value="userspace") @Produces(value="application/json") List<String> userspaceURIs(@HeaderParam(value="sessionid") String sessionId) throws RestException
RestException@GET @Path(value="globalspace") @Produces(value="application/json") List<String> globalspaceURIs(@HeaderParam(value="sessionid") String sessionId) throws RestException
RestException@GET @Path(value="userswithjobs") @Produces(value="application/json") List<SchedulerUserData> getUsersWithJobs(@HeaderParam(value="sessionid") String sessionId) throws RestException
sessionId - the session id associated to this new connectionRestException@GET @Path(value="stats") @Produces(value="application/json") Map<String,String> getStatistics(@HeaderParam(value="sessionid") String sessionId) throws NotConnectedRestException, PermissionRestException
sessionId - the session id associated to this new connectionNotConnectedRestExceptionPermissionRestException@GET @Path(value="stathistory") @Produces(value="application/json") String getStatHistory(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="function") String function) throws NotConnectedRestException
sessionId - current sessionfunction - function applying to statistics, one of: NotConnectedRestException@GET @Path(value="stats/myaccount") @Produces(value="application/json") Map<String,String> getStatisticsOnMyAccount(@HeaderParam(value="sessionid") String sessionId) throws RestException
sessionId - the session id associated to this new connectionRestException@POST @Consumes(value="multipart/form-data") @Path(value="createcredential") @Produces(value="*/*") byte[] getCreateCredential(LoginForm multipart) throws LoginException, SchedulerRestException
LoginExceptionSchedulerRestException@GET @Path(value="usage/myaccount") @Produces(value="application/json") List<JobUsageData> getUsageOnMyAccount(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="startdate") Date startDate, @QueryParam(value="enddate") Date endDate) throws RestException
Only the jobs finished between the start date and the end date will be
returned: i.e startDate <= job.finishedTime <= endDate.
sessionId - a valid session id to identify the callerstartDate - must not be null, inclusiveendDate - must not be null, inclusiveJobUsageData
objects where job finished times are between start date and end
dateNotConnectedRestException - if user not logger inPermissionRestException - if user has insufficient rightsRestException@GET @Path(value="stats/filters") @Produces(value="application/json") FilteredStatisticsData getFilteredStatistics(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="0") long endDate, @QueryParam(value="myjobs") @DefaultValue(value="false") boolean myJobs, @QueryParam(value="workflowName") @DefaultValue(value="null") String workflowName, @QueryParam(value="bucketName") @DefaultValue(value="null") String bucketName) throws RestException
sessionId - id of a sessionmyJobs - fetch only the jobs owned by the user making the requeststartDate - start date of the filtered jobsendDate - end date of the filtered jobsworkflowName - filter job by workflow name (or part of its name)bucketName - filter job by bucket name (or part of its name)FilteredStatisticsDataRestException - if an error occurs or the session is invalid@GET @Path(value="stats/topWorkflowsWithIssues") @Produces(value="application/json") List<FilteredTopWorkflowData> getTopWorkflowsWithIssues(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="numberOfWorkflows") int numberOfWorkflows, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="0") long endDate, @QueryParam(value="myjobs") @DefaultValue(value="false") boolean myJobs, @QueryParam(value="workflowName") @DefaultValue(value="null") String workflowName, @QueryParam(value="bucketName") @DefaultValue(value="null") String bucketName) throws RestException
sessionId - id of a sessionnumberOfWorkflows - number of workflows to showmyJobs - fetch only the jobs owned by the user making the requeststartDate - start date of the filtered jobsendDate - end date of the filtered jobsworkflowName - filter job by workflow name (or part of its name)bucketName - filter job by bucket name (or part of its name)FilteredTopWorkflowDataRestException - if an error occurs or the session is invalid@GET @Path(value="stats/topWorkflowsCumulatedCoreTime") @Produces(value="application/json") List<FilteredTopWorkflowsCumulatedCoreTimeData> getTopWorkflowsCumulatedCoreTime(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="numberOfWorkflows") int numberOfWorkflows, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="0") long endDate, @QueryParam(value="myjobs") @DefaultValue(value="false") boolean myJobs, @QueryParam(value="workflowName") @DefaultValue(value="null") String workflowName, @QueryParam(value="bucketName") @DefaultValue(value="null") String bucketName) throws RestException
sessionId - id of a sessionnumberOfWorkflows - number of workflows to showmyJobs - fetch only the jobs owned by the user making the requeststartDate - start date of the filtered jobsendDate - end date of the filtered jobsworkflowName - filter job by workflow name (or part of its name)bucketName - filter job by bucket name (or part of its name)FilteredTopWorkflowsCumulatedCoreTimeDataRestException - if an error occurs or the session is invalid@GET @Path(value="stats/topWorkflowsNumberOfNodes") @Produces(value="application/json") List<FilteredTopWorkflowsNumberOfNodesData> getTopWorkflowsNumberOfNodes(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="numberOfWorkflows") int numberOfWorkflows, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="0") long endDate, @QueryParam(value="myjobs") @DefaultValue(value="false") boolean myJobs, @QueryParam(value="workflowName") @DefaultValue(value="null") String workflowName, @QueryParam(value="bucketName") @DefaultValue(value="null") String bucketName, @QueryParam(value="inParallel") @DefaultValue(value="false") boolean inParallel) throws RestException
sessionId - id of a sessionnumberOfWorkflows - number of workflows to showmyJobs - fetch only the jobs owned by the user making the requeststartDate - start date of the filtered jobsendDate - end date of the filtered jobsworkflowName - filter job by workflow name (or part of its name)bucketName - filter job by bucket name (or part of its name)inParallel - if true, returns the maximum number of nodes used in parallel instead of the total number of nodesFilteredTopWorkflowsNumberOfNodesDataRestException - if an error occurs or the session is invalid@GET @Path(value="stats/topExecutionTimeWorkflows") @Produces(value="application/json") List<WorkflowDurationData> getTopExecutionTimeWorkflows(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="numberOfWorkflows") int numberOfWorkflows, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="0") long endDate, @QueryParam(value="myjobs") @DefaultValue(value="false") boolean myJobs, @QueryParam(value="workflowName") @DefaultValue(value="null") String workflowName, @QueryParam(value="bucketName") @DefaultValue(value="null") String bucketName) throws RestException
sessionId - id of a sessionnumberOfWorkflows - number of workflows to showmyJobs - fetch only the jobs owned by the user making the requeststartDate - start date of the filtered jobsendDate - end date of the filtered jobsworkflowName - filter job by workflow name (or part of its name)bucketName - filter job by bucket name (or part of its name)WorkflowDurationDataRestException - if an error occurs or the session is invalid@GET @Path(value="stats/topPendingTimeWorkflows") @Produces(value="application/json") List<WorkflowDurationData> getTopPendingTimeWorkflows(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="numberOfWorkflows") int numberOfWorkflows, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="0") long endDate, @QueryParam(value="myjobs") @DefaultValue(value="false") boolean myJobs, @QueryParam(value="workflowName") @DefaultValue(value="null") String workflowName, @QueryParam(value="bucketName") @DefaultValue(value="null") String bucketName) throws RestException
sessionId - id of a sessionnumberOfWorkflows - number of workflows to showmyJobs - fetch only the jobs owned by the user making the requeststartDate - start date of the filtered jobsendDate - end date of the filtered jobsworkflowName - filter job by workflow name (or part of its name)bucketName - filter job by bucket name (or part of its name)WorkflowDurationDataRestException - if an error occurs or the session is invalid@GET @Path(value="stats/submittedFromCount") @Produces(value="application/json") Map<String,Integer> getSubmissionModeCount(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="0") long endDate, @QueryParam(value="myjobs") @DefaultValue(value="false") boolean myJobs, @QueryParam(value="workflowName") @DefaultValue(value="null") String workflowName, @QueryParam(value="bucketName") @DefaultValue(value="null") String bucketName) throws RestException
sessionId - id of a sessionmyJobs - fetch only the jobs owned by the user making the requeststartDate - start date of the jobsendDate - end date of the jobsworkflowName - filter job by workflow name (or part of its name)bucketName - filter job by bucket name (or part of its name)RestException - if an error occurs or the session is invalid@GET @Path(value="stats/completedJobs") @Produces(value="application/json") CompletedJobsCountData getCompletedJobs(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="myjobs") @DefaultValue(value="false") boolean myJobs, @QueryParam(value="workflowName") @DefaultValue(value="null") String workflowName, @QueryParam(value="bucketName") @DefaultValue(value="null") String bucketName, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="-1") long endDate, @QueryParam(value="numberOfIntervals") @DefaultValue(value="1") int numberOfIntervals) throws RestException
sessionId - id of a sessionmyJobs - fetch only the jobs owned by the user making the requestworkflowName - filter job by workflow name (or part of its name)bucketName - filter job by bucket name (or part of its name)startDate - start date of the filtered jobsendDate - end date of the filtered jobs, default value represents the current datenumberOfIntervals - number of time intervalsCompletedJobsCountDataRestException - if an error occurs or the session is invalid@GET @Path(value="stats/completedTasks") @Produces(value="application/json") CompletedTasksCountData getCompletedTasks(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="myTasks") @DefaultValue(value="false") boolean myTasks, @QueryParam(value="taskName") @DefaultValue(value="null") String taskName, @QueryParam(value="startdate") @DefaultValue(value="0") long startDate, @QueryParam(value="enddate") @DefaultValue(value="-1") long endDate, @QueryParam(value="numberOfIntervals") @DefaultValue(value="1") int numberOfIntervals) throws RestException
sessionId - id of a sessionmyTasks - fetch only the tasks owned by the user making the requesttaskName - the task name of the filtered tasksstartDate - start date of the filtered tasksendDate - end date of the filtered tasks, default value represents the current datenumberOfIntervals - number of time intervalsCompletedTasksCountDataRestException - if an error occurs or the session is invalid@GET @Path(value="submissionModeValues") @Produces(value="application/json") Set<String> getSubmissionModeValues(@HeaderParam(value="sessionid") String sessionId) throws RestException
sessionId - id of a sessionRestException - if an error occurs or the session is invalid@GET @Path(value="usage/account") @Produces(value="application/json") List<JobUsageData> getUsageOnAccount(@HeaderParam(value="sessionid") String sessionId, @QueryParam(value="user") String user, @QueryParam(value="startdate") Date startDate, @QueryParam(value="enddate") Date endDate) throws RestException
Only the jobs finished between the start date and the end date will be
returned: i.e startDate <= job.finishedTime <= endDate.
sessionId - a valid session id to identify the calleruser - namestartDate - must not be null, inclusiveendDate - must not be null, inclusiveJobUsageData
objects where job finished times are between start date and end
dateNotConnectedRestException - if user not logger inPermissionRestException - if user has insufficient rightsRestException@GET
@Path(value="jobs/{jobid}/livelog")
@Produces(value={"text/plain","application/json"})
String getLiveLogJob(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@QueryParam(value="allLogs") @DefaultValue(value="false")
boolean allLogs)
throws NotConnectedRestException,
UnknownJobRestException,
PermissionRestException,
LogForwardingRestException,
IOException
jobid only
stream currently available logs, call this method several times to get
the complete output.
The optional query parameter allLogs allows to fetch all logs from the beginningsessionId - a valid session idjobId - the id of the job to retrieveallLogs - if true, fetch all logs since the beginningNotConnectedRestExceptionUnknownJobRestExceptionPermissionRestExceptionLogForwardingRestExceptionIOException@GET
@Path(value="jobs/{jobid}/livelog/available")
@Produces(value="application/json")
int getLiveLogJobAvailable(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws NotConnectedRestException
sessionId - a valid session idjobId - the id of the job to retrieveNotConnectedRestException@DELETE
@Path(value="jobs/{jobid}/livelog")
@Produces(value="application/json")
boolean deleteLiveLogJob(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId)
throws NotConnectedRestException
sessionId - a valid session idjobId - the id of the job to retrieveNotConnectedRestException@PUT
@Path(value="jobs/{jobid}/tasks/{taskname}/visu")
@Produces(value="application/json")
void enableRemoteVisualization(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobid,
@PathParam(value="taskname")
String taskname,
@QueryParam(value="connectionString")
String connectionString)
throws RestException
sessionId - current sessionjobid - id of the jobtaskname - name of the taskconnectionString - noVNC connection stringRestException@POST
@Path(value="jobs/{jobid}/services")
@Produces(value="application/json")
void registerService(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@QueryParam(value="serviceInstanceid")
int serviceInstanceid,
@QueryParam(value="enableActions")
boolean enableActions)
throws RestException
sessionId - a valid session idjobId - id of the jobserviceInstanceid - id of the PSA service instance to registerRestException@DELETE
@Path(value="jobs/{jobid}/services")
@Produces(value="application/json")
void detachService(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@QueryParam(value="serviceid")
int serviceid)
throws RestException
sessionId - a valid session idjobId - id of the jobserviceid - id of the cloud automation service to detachRestException@PUT
@Path(value="jobs/{jobid}/tasks/{taskname}/restart")
@Produces(value="application/json")
boolean restartTask(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobid,
@PathParam(value="taskname")
String taskname)
throws RestException
sessionId - current sessionjobid - id of the job containing the task to killtaskname - name of the task to killRestException@PUT
@Path(value="jobs/{jobid}/tasks/{taskname}/finishInErrorTask")
@Produces(value="application/json")
boolean finishInErrorTask(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobid,
@PathParam(value="taskname")
String taskname)
throws RestException
sessionId - current sessionjobid - id of the job containing the task to finish (only when InError state)taskname - name of the task to finish (only when InError state)RestException@PUT
@Path(value="jobs/{jobid}/tasks/{taskname}/restartInErrorTask")
@Produces(value="application/json")
boolean restartInErrorTask(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobid,
@PathParam(value="taskname")
String taskname)
throws RestException
sessionId - current sessionjobid - id of the job containing the task to killtaskname - name of the task to killRestException@PUT
@Path(value="jobs/{jobid}/tasks/{taskname}/preempt")
@Produces(value="application/json")
boolean preemptTask(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobid,
@PathParam(value="taskname")
String taskname)
throws RestException
The task will be stopped and restarted later
sessionId - current sessionjobid - id of the job containing the task to preempttaskname - name of the task to preemptRestException@PUT
@Path(value="jobs/{jobid}/tasks/{taskname}/kill")
@Produces(value="application/json")
boolean killTask(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobid,
@PathParam(value="taskname")
String taskname)
throws RestException
sessionId - current sessionjobid - id of the job containing the task to killtaskname - name of the task to killRestException@POST
@Path(value="{path:validate}")
@Consumes(value="multipart/form-data")
@Produces(value="application/json")
JobValidationData validate(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
throws NotConnectedRestException
sessionId - user session id used to connect to schedulerpathSegment - variables of the workflowmultipart - a HTTP multipart form which contains the job-descriptorNotConnectedRestException@POST
@Path(value="{path:validateurl}/body")
@Produces(value="application/json")
@Consumes(value="application/json")
JobValidationData validateFromUrl(@HeaderParam(value="sessionid")
String sessionId,
@HeaderParam(value="link")
String url,
Map<String,String> jsonBody,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment)
throws NotConnectedRestException
sessionId - a valid session idurl - url to the workflow contentpathSegment - variables of the workflowjsonBody - a json with the variables of the workflowNotConnectedRestException@POST
@Path(value="{path:validateurl}")
@Produces(value="application/json")
JobValidationData validateFromUrl(@HeaderParam(value="sessionid")
String sessionId,
@HeaderParam(value="link")
String url,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment)
throws NotConnectedRestException
sessionId - a valid session idurl - url to the workflow contentpathSegment - variables of the workflowNotConnectedRestException@POST
@Path(value="{path:validateurl}")
@Consumes(value="multipart/form-data")
@Produces(value="application/json")
JobValidationData validateFromUrl(@HeaderParam(value="sessionid")
String sessionId,
@HeaderParam(value="link")
String url,
@PathParam(value="path")
javax.ws.rs.core.PathSegment pathSegment,
org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput multipart)
throws NotConnectedRestException
sessionId - a valid session idurl - url to the workflow contentpathSegment - variables of the workflowmultipart - a form with the variables of the workflowNotConnectedRestException@POST
@Path(value="/credentials/")
@Produces(value="application/json")
void putThirdPartyCredential(@HeaderParam(value="sessionid")
String sessionId,
@FormParam(value="key")
String key,
@FormParam(value="value")
String value)
throws RestException
RestException@DELETE
@Path(value="/credentials/")
@Produces(value="application/json")
void removeThirdPartyCredential(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="key")
String key)
throws RestException
RestException@GET @Path(value="/credentials/") @Produces(value="application/json") Set<String> thirdPartyCredentialsKeySet(@HeaderParam(value="sessionid") String sessionId) throws RestException
RestException@PUT
@Path(value="jobs/{jobid}/startat/{startAt}")
@Produces(value="application/json")
boolean changeStartAt(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@PathParam(value="startAt")
String startAt)
throws RestException
sessionId - current sessionjobId - id of the job that needs to be updatedstartAt - its value should be ISO 8601 compliantRestException@PUT
@Path(value="jobs/startat/{startAt}")
@Consumes(value="application/json")
@Produces(value="application/json")
boolean changeStartAtMultiple(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="startAt")
String startAt,
List<String> jobIdList)
throws RestException
sessionId - current sessionstartAt - its value should be ISO 8601 compliantjobIdList - a list of job ids as JSON bodyRestException@GET @Path(value="configuration/portal") @Produces(value="application/json") Map<Object,Object> getPortalConfiguration(@HeaderParam(value="sessionid") String sessionId) throws RestException
RestException@GET @Path(value="properties") @Produces(value="application/json") Map<String,Object> getSchedulerPropertiesFromSessionId(@HeaderParam(value="sessionid") String sessionId) throws RestException
sessionId - the session id associated to this new connectionRestException@GET
@Path(value="/permission/{method}")
@Consumes(value="application/json")
@Produces(value="application/json")
boolean checkPermissionMethod(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="method")
String method)
throws RestException
sessionId - current sessionmethod - method name to checkRestException@GET
@Path(value="job/{jobid}/permission/{method}")
@Consumes(value="application/json")
@Produces(value="application/json")
boolean checkJobPermissionMethod(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="method")
String method,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - current sessionjobId - id of the jobmethod - method name to checkRestException@POST
@Path(value="jobs/permission/{method}")
@Consumes(value="application/json")
@Produces(value="application/json")
List<String> checkJobsPermissionMethod(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="method")
String method,
List<String> jobsId)
throws RestException
sessionId - current sessionjobsId - list of job idsmethod - method name to checkRestException@POST
@Path(value="job/{jobid}/signals")
@Consumes(value="application/octet-stream")
@Produces(value="application/json")
Set<String> addJobSignal(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="signal")
String signal,
@PathParam(value="jobid")
String jobId)
throws RestException
sessionId - current sessionjobId - id of the jobsignal - signal name to addRestException@POST
@Path(value="job/{jobid}/signals")
@Consumes(value="application/json")
@Produces(value="application/json")
Set<String> addJobSignalWithVariables(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="signal")
String signal,
@PathParam(value="jobid")
String jobId,
Map<String,String> updatedVariables)
throws RestException
sessionId - current sessionjobId - id of the jobsignal - signal name to addupdatedVariables - the update variables of the signalRestException@POST
@Path(value="job/{jobid}/signals/validate")
@Consumes(value="application/json")
@Produces(value="application/json")
JobValidationData validateJobSignal(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="signal")
String signal,
@PathParam(value="jobid")
String jobId,
Map<String,String> updatedVariables)
throws RestException
sessionId - current sessionjobId - id of the jobsignal - signal name to validateRestException@POST @Path(value="jobs/permission/methods") @Consumes(value="application/json") @Produces(value="application/json") Map<String,Map<String,Boolean>> checkJobsPermissionMethods(@HeaderParam(value="sessionid") String sessionId, PermissionForm multipart) throws RestException
sessionId - current sessionmultipart - a form with the jobIds list and methods list as form dataRestException@POST
@Path(value="jobs/{jobid}/externalendpointurl")
@Consumes(value="application/x-www-form-urlencoded")
@Produces(value="application/json")
void addExternalEndpointUrl(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
@FormParam(value="endpointName")
String endpointName,
@FormParam(value="externalEndpointUrl")
String externalEndpointUrl,
@FormParam(value="endpointIconUri")
String endpointIconUri)
throws RestException
sessionId - current sessionjobId - id of the jobendpointName - name of the endpointexternalEndpointUrl - the external endpoint url to add to the job endpoint listendpointIconUri - uri of the icon associated with the endpoint. If this parameter is null, the workflow icon will be used.RestException@DELETE
@Path(value="jobs/{jobid}/externalendpointurl")
@Consumes(value="application/json")
@Produces(value="application/json")
void removeExternalEndpointUrl(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="jobid")
String jobId,
String externalEndpointUrl)
throws RestException
sessionId - current sessionjobId - id of the jobexternalEndpointUrl - the external endpoint url to remove from the job endpoint listRestException@PUT
@Path(value="labels/jobs/setlabel")
@Consumes(value="application/json")
@Produces(value="application/json")
void setLabelOnJobs(@HeaderParam(value="sessionid")
String sessionId,
@QueryParam(value="labelId")
String labelId,
List<String> jobIds)
throws RestException
sessionId - current sessionlabelId - the id of the label to be setjobIds - the list of job idsRestException@PUT
@Path(value="labels/jobs/removelabel")
@Consumes(value="application/json")
@Produces(value="application/json")
void removeJobLabels(@HeaderParam(value="sessionid")
String sessionId,
List<String> jobIds)
throws RestException
sessionId - current sessionjobIds - the list of job idsRestException@GET @Path(value="labels") @Consumes(value="application/json") @Produces(value="application/json") List<JobLabelInfoData> getLabels(@HeaderParam(value="sessionid") String sessionId) throws RestException
sessionId - current sessionJobLabelInfoDataRestException@POST @Path(value="labels") @Consumes(value="application/json") @Produces(value="application/json") List<JobLabelInfoData> createLabels(@HeaderParam(value="sessionid") String sessionId, List<String> labels) throws RestException
sessionId - current sessionlabels - a list of labels to createJobLabelInfoData, representing the newly added labelsRestException@POST @Path(value="labels/set") @Consumes(value="application/json") @Produces(value="application/json") List<JobLabelInfoData> setLabels(@HeaderParam(value="sessionid") String sessionId, List<String> labels) throws RestException
sessionId - current sessionlabels - the list of labels to setJobLabelInfoData, representing the updated list of labelsRestException@PUT
@Path(value="labels/{labelId}")
@Consumes(value="application/json")
@Produces(value="application/json")
JobLabelInfoData updateLabel(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="labelId")
String labelId,
@QueryParam(value="newLabel")
String newLabel)
throws RestException
sessionId - current sessionnewLabel - the new label namelabelId - the id of the label to updateJobLabelInfoData, representing the updated labelRestException@DELETE
@Path(value="labels/{labelId}")
@Consumes(value="application/json")
@Produces(value="application/json")
void deleteLabel(@HeaderParam(value="sessionid")
String sessionId,
@PathParam(value="labelId")
String labelId)
throws RestException
sessionId - current sessionlabelId - the id of the label to removeRestException