Scheduled Batch Screening
Use this API to run or schedule batch screening from outside of the Screener module. This call requires a valid Spectrum token to be passed for authentication. For details on obtaining web service authentication tokens, see Web Service Authentication in the Administration Guide and Getting a Token, and Using a Token in the API Guide .
HTTP Method
POST
URL
http://<spectrum-server>:<port>/managers/fccRuntime/job/execute
Where spectrum-server is the server name or IP address of your Spectrum™ Technology Platform server and port is the HTTP port. By default, the HTTP port is 8080.
Input Parameters
| Parameter | Description |
|---|---|
| jobName | It should be an already existing job created from the Screener user interface. Else, you receive error code 400 with appropriate message. |
| filePath | Path where the party data file is placed. It should be a valid and accessible path on the Spectrum server. Else, you receive error code 400. |
Result
When you successfully submit the request, a new version is created for the given screening job, with all configurations copied from the current version, the only difference being a new party data file (the path of which you passed as input). A new screening job is triggered for this new job definition version. You can verify it with the Screener user interface.