Web Service Details: CasJobs

Seekda Community Feedback

• CasJobsHttpGet (Protocol: HTTP_GET)

  • CancelJob
    Schedules a job for cancellation. Only works for non-short queue jobs.
    Input: jobId, wsId
    Output:
  • CheckSyntax
    Returns error-as-string if syntax error is found, null if no errors.
    Input: wsId, qry
    Output: string
  • FindJob
    Same as FindJobDataSet, but returns in Job format
    Input: predicate, wsId
    Output: ArrayOfJob
  • FindJobDataSet
    Searches a usr's jobs with parameters given in predicate. Predicate is of where clause form, ex. 'taskname="some_name" and rows=some_number
    Input: wsId, predicate
    Output: DataSet
  • FindJobWithStatusDataSet
    A join of jobs and status, where j is jobs and s is status. setSize is the number of jobs to return. Position is a multiplier on setSize, ie top 20, or next 20, etc. User can append select and/or where. justCount set to true returns a dataset with the total # of jobs for the specified conditions. Set size is how many jobs to return, position is the nth set of the specified size. So if you had 10 jobs, setSize was 2 and position was 1, it would return jobs 3&4. maxChars is the maximum # of characters to return for any single textfield. Setting this to -1 will return everything.
    Input: setSize, position, where, wsId, select, maxChars, justCount
    Output: DataSet
  • GetFailedOutputAsJobs
    Lists failed output jobs
    Input: wsid
    Output: ArrayOfJob
  • GetOutputDownloadsAsJobs
    Lists available output downloads
    Input: wsid
    Output: ArrayOfJob
  • GetPendingOutputAsJobs
    Lists pending output
    Input: wsid
    Output: ArrayOfJob
  • GetPlan
    Returns a sql-server plan based on target and qry.
    Input: target, qry, wsid
    Output: DataSet
  • getStatusHTML
    Return an html representation of the job status.
    Input: status, wsid
    Output: string
  • Heartbeat
    Submits a heartbeat job to JobsService
    Input: target, queue, wsid
    Output: long
  • ListServers
    List available targets and queues.
    Input: wsid
    Output: ArrayOfServer
  • StatusJob
    Returns a job's current status. This is an int, where 0=ready,1=started,2=cancelling,3=cancelled,4=failed,5=finished
    Input: wsId, jobId
    Output: int
  • SubmitJob
    Creates new job entry and schedules a query for later completion. Returns the jobid of the created job. This method is only necessary for long jobs. Autocomplete is disabled (param does nothing)
    Input: estimate, taskname, autocomplete, qry, target, wsid
    Output: long
  • SubmitShortJob
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: target, wsid, taskname, autocomplete, qry
    Output: DataSet
  • SubmitShortJobObject
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: target, wsid, taskname, autocomplete, qry
    Output: ArrayOfArrayOfAnyType
  • SubmitShortJobVOTABLE
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: taskname, wsid, autocomplete, qry, target
    Output: VOTABLE

• CasJobsSoap (Protocol: SOAP11_HTTP)

  • CancelJob
    Schedules a job for cancellation. Only works for non-short queue jobs.
    Input: CancelJob
    Output: CancelJobResponse
  • CheckSyntax
    Returns error-as-string if syntax error is found, null if no errors.
    Input: CheckSyntax
    Output: CheckSyntaxResponse
  • FindJob
    Same as FindJobDataSet, but returns in Job format
    Input: FindJob
    Output: FindJobResponse
  • FindJobDataSet
    Searches a usr's jobs with parameters given in predicate. Predicate is of where clause form, ex. 'taskname="some_name" and rows=some_number
    Input: FindJobDataSet
    Output: FindJobDataSetResponse
  • FindJobWithStatusDataSet
    A join of jobs and status, where j is jobs and s is status. setSize is the number of jobs to return. Position is a multiplier on setSize, ie top 20, or next 20, etc. User can append select and/or where. justCount set to true returns a dataset with the total # of jobs for the specified conditions. Set size is how many jobs to return, position is the nth set of the specified size. So if you had 10 jobs, setSize was 2 and position was 1, it would return jobs 3&4. maxChars is the maximum # of characters to return for any single textfield. Setting this to -1 will return everything.
    Input: FindJobWithStatusDataSet
    Output: FindJobWithStatusDataSetResponse
  • GetFailedOutputAsJobs
    Lists failed output jobs
    Input: GetFailedOutputAsJobs
    Output: GetFailedOutputAsJobsResponse
  • GetOutputDownloadsAsJobs
    Lists available output downloads
    Input: GetOutputDownloadsAsJobs
    Output: GetOutputDownloadsAsJobsResponse
  • GetPendingOutputAsJobs
    Lists pending output
    Input: GetPendingOutputAsJobs
    Output: GetPendingOutputAsJobsResponse
  • GetPlan
    Returns a sql-server plan based on target and qry.
    Input: GetPlan
    Output: GetPlanResponse
  • getStatusHTML
    Return an html representation of the job status.
    Input: getStatusHTML
    Output: getStatusHTMLResponse
  • Heartbeat
    Submits a heartbeat job to JobsService
    Input: Heartbeat
    Output: HeartbeatResponse
  • ListServers
    List available targets and queues.
    Input: ListServers
    Output: ListServersResponse
  • StatusJob
    Returns a job's current status. This is an int, where 0=ready,1=started,2=cancelling,3=cancelled,4=failed,5=finished
    Input: StatusJob
    Output: StatusJobResponse
  • SubmitJob
    Creates new job entry and schedules a query for later completion. Returns the jobid of the created job. This method is only necessary for long jobs. Autocomplete is disabled (param does nothing)
    Input: SubmitJob
    Output: SubmitJobResponse
  • SubmitShortJob
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: SubmitShortJob
    Output: SubmitShortJobResponse
  • SubmitShortJobObject
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: SubmitShortJobObject
    Output: SubmitShortJobObjectResponse
  • SubmitShortJobVOTABLE
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: SubmitShortJobVOTABLE
    Output: SubmitShortJobVOTABLEResponse

• CasJobsHttpPost (Protocol: HTTP_POST)

  • CancelJob
    Schedules a job for cancellation. Only works for non-short queue jobs.
    Input: jobId, wsId
    Output:
  • CheckSyntax
    Returns error-as-string if syntax error is found, null if no errors.
    Input: wsId, qry
    Output: string
  • FindJob
    Same as FindJobDataSet, but returns in Job format
    Input: predicate, wsId
    Output: ArrayOfJob
  • FindJobDataSet
    Searches a usr's jobs with parameters given in predicate. Predicate is of where clause form, ex. 'taskname="some_name" and rows=some_number
    Input: wsId, predicate
    Output: DataSet
  • FindJobWithStatusDataSet
    A join of jobs and status, where j is jobs and s is status. setSize is the number of jobs to return. Position is a multiplier on setSize, ie top 20, or next 20, etc. User can append select and/or where. justCount set to true returns a dataset with the total # of jobs for the specified conditions. Set size is how many jobs to return, position is the nth set of the specified size. So if you had 10 jobs, setSize was 2 and position was 1, it would return jobs 3&4. maxChars is the maximum # of characters to return for any single textfield. Setting this to -1 will return everything.
    Input: setSize, position, where, wsId, select, maxChars, justCount
    Output: DataSet
  • GetFailedOutputAsJobs
    Lists failed output jobs
    Input: wsid
    Output: ArrayOfJob
  • GetOutputDownloadsAsJobs
    Lists available output downloads
    Input: wsid
    Output: ArrayOfJob
  • GetPendingOutputAsJobs
    Lists pending output
    Input: wsid
    Output: ArrayOfJob
  • GetPlan
    Returns a sql-server plan based on target and qry.
    Input: target, qry, wsid
    Output: DataSet
  • getStatusHTML
    Return an html representation of the job status.
    Input: status, wsid
    Output: string
  • Heartbeat
    Submits a heartbeat job to JobsService
    Input: target, queue, wsid
    Output: long
  • ListServers
    List available targets and queues.
    Input: wsid
    Output: ArrayOfServer
  • StatusJob
    Returns a job's current status. This is an int, where 0=ready,1=started,2=cancelling,3=cancelled,4=failed,5=finished
    Input: wsId, jobId
    Output: int
  • SubmitJob
    Creates new job entry and schedules a query for later completion. Returns the jobid of the created job. This method is only necessary for long jobs. Autocomplete is disabled (param does nothing)
    Input: estimate, taskname, autocomplete, qry, target, wsid
    Output: long
  • SubmitShortJob
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: target, wsid, taskname, autocomplete, qry
    Output: DataSet
  • SubmitShortJobObject
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: target, wsid, taskname, autocomplete, qry
    Output: ArrayOfArrayOfAnyType
  • SubmitShortJobVOTABLE
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: taskname, wsid, autocomplete, qry, target
    Output: VOTABLE

• CasJobsSoap (Protocol: SOAP12_HTTP)

  • CancelJob
    Schedules a job for cancellation. Only works for non-short queue jobs.
    Input: CancelJob
    Output: CancelJobResponse
  • CheckSyntax
    Returns error-as-string if syntax error is found, null if no errors.
    Input: CheckSyntax
    Output: CheckSyntaxResponse
  • FindJob
    Same as FindJobDataSet, but returns in Job format
    Input: FindJob
    Output: FindJobResponse
  • FindJobDataSet
    Searches a usr's jobs with parameters given in predicate. Predicate is of where clause form, ex. 'taskname="some_name" and rows=some_number
    Input: FindJobDataSet
    Output: FindJobDataSetResponse
  • FindJobWithStatusDataSet
    A join of jobs and status, where j is jobs and s is status. setSize is the number of jobs to return. Position is a multiplier on setSize, ie top 20, or next 20, etc. User can append select and/or where. justCount set to true returns a dataset with the total # of jobs for the specified conditions. Set size is how many jobs to return, position is the nth set of the specified size. So if you had 10 jobs, setSize was 2 and position was 1, it would return jobs 3&4. maxChars is the maximum # of characters to return for any single textfield. Setting this to -1 will return everything.
    Input: FindJobWithStatusDataSet
    Output: FindJobWithStatusDataSetResponse
  • GetFailedOutputAsJobs
    Lists failed output jobs
    Input: GetFailedOutputAsJobs
    Output: GetFailedOutputAsJobsResponse
  • GetOutputDownloadsAsJobs
    Lists available output downloads
    Input: GetOutputDownloadsAsJobs
    Output: GetOutputDownloadsAsJobsResponse
  • GetPendingOutputAsJobs
    Lists pending output
    Input: GetPendingOutputAsJobs
    Output: GetPendingOutputAsJobsResponse
  • GetPlan
    Returns a sql-server plan based on target and qry.
    Input: GetPlan
    Output: GetPlanResponse
  • getStatusHTML
    Return an html representation of the job status.
    Input: getStatusHTML
    Output: getStatusHTMLResponse
  • Heartbeat
    Submits a heartbeat job to JobsService
    Input: Heartbeat
    Output: HeartbeatResponse
  • ListServers
    List available targets and queues.
    Input: ListServers
    Output: ListServersResponse
  • StatusJob
    Returns a job's current status. This is an int, where 0=ready,1=started,2=cancelling,3=cancelled,4=failed,5=finished
    Input: StatusJob
    Output: StatusJobResponse
  • SubmitJob
    Creates new job entry and schedules a query for later completion. Returns the jobid of the created job. This method is only necessary for long jobs. Autocomplete is disabled (param does nothing)
    Input: SubmitJob
    Output: SubmitJobResponse
  • SubmitShortJob
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: SubmitShortJob
    Output: SubmitShortJobResponse
  • SubmitShortJobObject
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: SubmitShortJobObject
    Output: SubmitShortJobObjectResponse
  • SubmitShortJobVOTABLE
    Submits a short job. Returns an exception if job takes too long, Dataset if job did not. Autocomplete is currently disabled; the param does nothing.
    Input: SubmitShortJobVOTABLE
    Output: SubmitShortJobVOTABLEResponse