Operations

CheckConnect

Returns a reserved integer if a connection can be established, and the Switch Server is accepting SOAP calls. The HTTP username and password must not be set for this call.

SOAP method	CheckConnect
Parameters	None
Returns	Integer param-1: reserved

CheckUserNameAndPass

Returns a reserved integer if the username and password, set on the HTTP layer, correspond to an existing Switch user. The username must be set to the Switch username, a semi colon, and the code “EN”: "<username>;EN".

SOAP method	CheckUserNameAndPass
Parameters	None
Returns	Integer param-3: reserved

CloseConnection

Tells Switch that the information related to this client connection can be deleted.

SOAP method	CloseConnection
Parameters	None
Returns	Integer param-4: reserved

DownloadFile

Downloads a job (file or folder) from a checkpoint.

SOAP method	DownloadFile
Parameters	String flowId: the ID of the flow in which the job resides
	String checkPointId: the ID of the checkpoint in which the job resides
	String jobId: the ID of the job to download
Returns	Base64Binary inSubmitData: the zipped job

GetCheckPointName

Returns the name of the specified checkpoint.

SOAP method	GetCheckPointName
Parameters	String flowId: the ID of the flow
Parameters	String checkPointId: the ID of the checkpoint
Returns	String checkPointName: the name of the checkpoint

GetCheckPoints

Returns the list of checkpoint IDs for the specified flow.

SOAP method	GetCheckPoints
Parameters	String flowId: the ID of the flow from which to get the checkpoints
Returns	String list checkPoints: the list of checkpoints in the flow

GetCheckpointJobInfo

Returns information about a specific job. Only the information about jobs waiting in a checkpoint can be requested. See also GetCheckpointJobsInfo.

SOAP method	GetCheckpointJobInfo
Parameters	String flowId: the ID of the flow
	String checkPointId: the ID of the checkpoint
	String jobId: the ID of the job
Returns	JobStatus list jobInfo: a list with exactly one JobStatus element, containing the information for the job.

GetCheckpointJobs10

Returns the list of job IDs for the jobs waiting in the specified checkpoint.

SOAP method	GetCheckpointJobs10
Parameters	String flowId: the ID of the flow
Parameters	String checkPointId: the ID of the checkpoint
Returns	String list jobIds: the list of job IDs for jobs present in the checkpoint

GetCheckpointJobsCount

Returns the number of jobs waiting in the specified checkpoint.

SOAP method	GetCheckpointJobsCount
Parameters	String flowId: the ID of the flow
Parameters	String checkPointId: the ID of the checkpoint
Returns	Integer jobs: the number of jobs waiting in the checkpoint

GetCheckpointJobsInfo

Returns information about all the jobs waiting in a checkpoint. See also GetCheckpointJobInfo.

SOAP method	GetCheckpointJobsInfo
Parameters	String flowId: the ID of the flow
Parameters	String checkPointId: the ID of the checkpoint
Returns	JobIdStatus list jobInfos: a list with the information for each job in the checkpoint.

GetFlowList

Returns the flow IDs of all the flow on the Switch Server. This includes both active and inactive flows.

SOAP method	GetFlowList
Parameters	None
Returns	String list flowList: the IDs of the flows

GetFlowName

Returns the name of the flow with the given ID.

SOAP method	GetFlowName
Parameters	String flowId: the ID of the flow
Returns	String flowName: the name of the flow

GetFlowState

Returns the state of the specified flow.

SOAP method	GetFlowState
Parameters	String flowId: the ID of the flow
Returns	Integer flowState: the state of the flow. Possible values are: 1: the flow is stopped (inactive) 2: the flow is being started 3: the flow is running (active) 4: the flow is being stopped 5: the flow is invalid

GetJobLockStatus

Returns the name of the user who locked the job, or the empty string if the job is not locked.

SOAP method	GetJobLockStatus
Parameters	String flowId: the ID of the flow
	String checkPointId: the ID of the checkpoint
	String jobId: the ID of the job
Returns	String userName: the name of the user who locked the job, or an empty string

GetJobsAdditionalInfo

Returns the file type, size, modification date, and in the case of job folders the number of files for the specified job(s).

When using this function, you should always check the status member of the returned AdditionalInfo: if busy or failed, the data is not reliable.

SOAP method	GetJobsAdditionalInfo
Parameters	AdditionalInfoID list jobsId: the list of job IDs for which to get information
Returns	AdditionalInfo list jobsInfo: the information for each job

GetJobsHeavyInfo

Returns the thumbnail icon, number of pages and dimensions for the job.

When using this function, you should always check the status member of the returned HeavyInfo: if busy or failed, the data is not reliable.

The stamp member of the returned HeavyInfo is used to determine whether the heavy info should be refreshed: if calling this function more than once for the same job, you should set it to the value last returned by the Switch Server, to prevent unnecessary calculations.

SOAP method	GetJobsHeavyInfo
Parameters	HeavyInfoID list jobsId: a list of job IDs and information required to get the heavy info.
Returns	HeavyInfo list jobsInfo: the requested info per job.

GetJobsMetadataInfo

Returns the metadata for one or more specified jobs.

SOAP method	GetJobsMetadataInfo
Parameters	MetadataInfoID list jobsId: the list of job IDs for which to get the metadata
Returns	MetadataInfo list jobsInfo: the requested info per job

GetLogData10

Returns log messages from the Switch Server. Note that if there are a lot of log messages, this can take a long time. Because of that, lastTime should be chosen to minimize the number of messages to be returned.

SOAP method	GetLogData10
Parameters	String lastTime: the time of the earliest log that should be returned
Returns	LoggedRecord list logs: the list of log messages

GetProgressData

Returns progress data from the Switch Server.

SOAP method	GetProgressData
Parameters	Integer lastHours: progress data for this number of hours will be returned
Returns	ProgressRecord list logs: the progress data

GetStatus

Returns the status of the connection, and some information about the Switch Server.

SOAP method	GetStatus
Parameters	None
Returns	Status list res: a list with exactly one element of type Status

GetSubmitPointName

Returns information about the specified submit point.

SOAP method	GetSubmitPointName
Parameters	String flowId: the ID of the flow that contains the submit point
Parameters	String submitPointId: the ID of the submit point
Returns	SubmitPointData list submitPointData: a list with exactly one SubmitPointData item

GetSubmitPoints

Returns the list of submit points for a given flow.

SOAP method	GetSubmitPoints
Parameters	String flowId: the ID of the flow
Returns	String list submitPoints: the IDs of the submit points

GetUserJobs

Get information about jobs currently residing in the Switch Server.

SOAP method	GetUserJobs
Parameters	Integer hours: any jobs active within this last number of hours will be returned
Parameters	Integer flags: reserved
Returns	UserJob list userJobs: the list of jobs on the Switch Server

PushCheckpointJob

Pushes the specified job to one or more connections.

SOAP method	PushCheckpointJob
Parameters	String flowId: the ID of the flow
	String checkPointId: the ID of the checkpoint
	String jobId: the ID of the job
	PushJobStatus jobInfo: the necessary information to push the job to the connection(s)
Returns	Integer param-5: reserved

ReplaceFile

Replaces a job in a checkpoint, and pushes the result to one or more outgoing connection(s).

SOAP method	ReplaceFile
Parameters	ReplaceEntry inEntry: information about the job replacement
	Base64Binary inSubmitData: the job to submit; this must be a zip file containing either a single file or a single folder
	PushJobStatus jobInfo: the necessary information to push the (replaced) job to the connection(s)
Returns	Integer isReplaced: 1 if the job was replaced, 0 if not

SetJobLockStatus

Locks or unlocks a job.

SOAP method	SetJobLockStatus
Parameters	String flowId: the ID of the flow
	String checkPointId: the ID of the checkpoint
	String jobId: the ID of the job
	Integer lockStatus: one of the following values: 0: unlock 1: lock 2: solid unlock 3: solid lock
Returns	Integer isSet: 1 if set, 0 if not set

SubmitFile10

Submit a job to the specified submit point.

SOAP method	SubmitFile10
Parameters	SubmitEntry inEntry: information about the job to submit
	Base64Binary inSubmitData: the job to submit; this must be a zip file containing either a single file or a single folder
	MetadataToFillClass list metadata: the required metadata
Returns	String outJobId: reserved

DownloadReport

If a checkpoint has the Enable report viewing property set to Yes, this method can be used to download the dataset provided in the Report dataset name property. If Enable report viewing is off, or if the dataset doesn’t exist, this method will fail.

SOAP method	DownloadReport
Parameters	String flowId: the ID of the flow in which the job resides
	String checkPointId: the ID of the checkpoint in which the job resides
	String jobId: the ID of the job whose report you wish to download
Returns	Base64Binary inSubmitData: the requested report