Supported API calls

This section describes Connect API calls.
    Note:
  • Use the loginConnect and logoutConnect proxies with all Connect API calls.
  • Some Job.get calls return an entry for each job. Having to return a large amount of data could cause a large system to fail. To avoid returning unnecessarily large results, use selection criteria to extract only the necessary jobs and their required attributes. This filtering is more efficient because it is done on the server.

In this section:

  1. Job.create(string workflow {srcfile : spoolfile, ...})
    This call creates a new job and returns its Job ID. In addition, this call copies the source files into the spool directory and gives them spool file names. Use this call in combination with the Job.changeFirstState (jobID, None, “Creating”, string workflow) call to create a new job and move it through the correct workflow.
  2. Job.changeFirstState (jobID, None, “Creating”, string workflow)
    This call starts the job on its specified workflow. In addition, this call copies the source files into the spool directory and gives them spool file names. It helps move a job created with the Job.create(string workflow {srcfile : spoolfile, ...}) call through the right workflow.
  3. Job.get(string jobID)
    Use this call to see all the job attributes of the specified job.
  4. Job.get([jobAttr,...], string selectionCriteria)
    Use this call to see the specified attributes for the jobs that match the selection criteria.
  5. Job.getMessages(string jobId, “Job”)
    Use this call to see all the messages associated with the specified job.
  6. Document.get(string docID)
    Use this call to see all the document attributes of the specified document.
  7. Document.get([], string selectionCriteria, int skip, int maxCount)
    Use this call to see the core attributes of the documents that match the selection criteria.
  8. Document.get(None, string selectionCriteria, int skip, int maxCount)
    Use this call to see all the attributes of the documents that match the selection criteria. ;
  9. Document.getCurrentJob([ ], string docID)
    Use this call to see the attributes of the specified document and the job attributes of the job the document is associated with.
  10. Document.getDocumentCount(string selectionCriteria)
    Use this call to see the number of documents that match the selection criteria.

Related information:

Remote access basics
Parent topic: Using API calls through remote access