SymetryML Documentation
Jobs

Get job status

Get the status of one job by id. Returns `202` while the job is still running and `200` once it has finished, with a job-type-specific result attached in `values` alongside `jobinfo` (e.g. `values.smlInfo` for a `dsUpdate` job).

GET
/{user}/jobs/{jobId}

Get the status of one job by id. Returns 202 while the job is still running and 200 once it has finished, with a job-type-specific result attached in values alongside jobinfo (e.g. values.smlInfo for a dsUpdate job).

Authorization

SymetryMLAuth
AuthorizationBearer <token>

HMAC-SHA256 signature-based authentication: requests are signed with your secret key and sent with the Customer-ID, Sym-date, Authorization, Content-MD5 and sym-version headers. See SymetryML REST API Security for the signature algorithm and a complete example.

In: header

Path Parameters

user*string

User/Customer identifier

jobId*string

The jobId returned when the job was started. Although this is a path string, it must represent an integer.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/c1/jobs/string"

{  "statusCode": 200,  "statusString": "Job is finished",  "values": {    "smlInfo": {      "pid": "prjAnova4",      "isDirty": true,      "modelsList": [],      "modelTypeList": [],      "attributeNames": [        "d1",        "d2",        "d3",        "d4"      ],      "attributeIndexes": [        0,        1,        2,        3      ],      "attributeTypes": [        "C",        "C",        "C",        "C"      ],      "modelAssessments": {},      "modelPredictions": {},      "params": {        "sml_project_power_ntot": "9",        "sml_project_is_freeze": "false"      },      "autoSave": true,      "hash": -1,      "categorySeparator": "$",      "type": "cpu",      "creationDate": 1756447887561,      "lastModificationDate": 1756447888956,      "loaded": true,      "persisted": true,      "histogramEnabled": false    }  }}

{  "statusCode": 202,  "statusString": "Job still running",  "values": {    "jobinfo": {      "jobId": 3,      "jobType": "reduce",      "owner": "c1",      "startingDate": 1784742220318,      "maximum": 5,      "current": 0,      "isOnBoundedExecutor": false,      "isStarted": true,      "isDone": false,      "details": {        "target_attrs": "2000",        "model_name": "c1-ReduceJobTest-reduce-mod",        "model_type": "mlr",        "delta": "0.001",        "optimizer_type": "default",        "reduce_count": "5.0",        "p_id": "c1-ReduceJobTest-prj",        "input_attrs": "0,1,2,3,4,..."      }    }  }}

{  "statusCode": 400,  "statusString": "Invalid Job id, it should be a number",  "values": {}}

{  "statusCode": 404,  "statusString": "No such job",  "values": {}}
{  "statusCode": 500,  "statusString": "Singular Matrix Error, please try again with SVD enabled or Model Reducer",  "values": {}}

Kill job DELETE

Send a running job a termination request and remove it from the scheduler.

Get survival frames GET

Returns every group's survival frame from the project's Kaplan-Meier online representation under `values.sdfResults`. Takes no request body. - **`sdfmap`**: keyed by group value (e.g. `"0"`, `"1"`, `"2"`) plus the aggregate `"Total"` group. - Each group's **`DataFrame`** has columns `time`, `at_risk`, `event`, `survival_func`, and the lower/upper confidence-interval bounds (`[0.025`, `0.975]` at the default 95% level). - A project that has a Kaplan-Meier representation but no built model returns an empty `sdfmap`.