GET status

Retrieves status and other information for submitted exporter wrapper jobs.

API Specification: Get Status for single job

Description Get status and additional information about submitted exporter task matching the supplied jobId
Authentication Required yes
URL https://<domain or IP>/SMARTSync/services/rs/exporters/v1/status/{jobId}
Method GET
Request
Headers 		Cookie: JSESSIONID={jsessionId}
Content-Type: application/json

Response
Headers

Content-Type: application/json

Success
Response

Code: 200 OK
Content : [Response Data]

Error
Response

Code: 401 Unauthorized

Error message:

{

"message": "Unauthorized",

"status": 401

}

 

Code: 404 Not Found

Error message:

{

"message": "Job id is not found",

"status": 401

}

Response Data

Response provides information about status and additional details for requested JobId:

jobId is a 32 length string 
status: can be WAITING, RUNNING, COMPLETED_SUCCESFULLY, FAILED, CANCELED
exporterType: name of exporter
lastStatusChange: dateTime in ISO format about last status change date
outputFormat: result output format value (JSON, PIPE or XML)
errorDetails: error information. Can be one of (Internal server error, Job was canceled by a user, Result set is too large, reduce date range and/or number of entities)
totalRecords: number of response records. Only available for job status COMPLETED_SUCCESFULLY
resultsSizeBytes: object which contains information about compressed and uncompressed response file size in bytes. Only available for COMPLETED_SUCCESFULLY job status
additionalDetails: rpt file content

Response Examples

Example for JSON

var(--codeSnippetCopyLabel) 
{
    "jobId": "a655e25d5b204b22b9a1b55b06524172",
    "status": "COMPLETED_SUCCESSFULLY",
    "exporterType": "agent-export",
    "outputFormat": "JSON",
    "lastStatusChange": "2024-02-20T20:23:29.650Z",
    "resultsSizeBytes": {
        "compressed": 525080,
        "uncompressed": 51757092
    },
    "totalRecords": 13440,
    "additionalDetails": "Running Export Engine for Date Range 01/01/2022 - 10/02/2023\n\nConfiguration file used:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/a655e25d5b204b22b9a1b55b06524172/Config.xml\nDate Format : Default Date Setting\nTime Format : Default Time Setting\nReport Headers : On\n\nProcessing entity list...\n - customer1\n    MU:  500 - MU_500\n\nRunning application:  exportAgent\n  Input File Name:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/a655e25d5b204b22b9a1b55b06524172/Advanced.xml\n  Output File Name:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/a655e25d5b204b22b9a1b55b06524172/Output.xml\nStarting Agent Export export...\nRecord Type: newAgent\nId Type: tvID\nCust: 1\nSchedPer: 5\n\nWARNING!  Cannot have both <name/> and <lastName/> in input xml file!\n          Default to using lastName, firstName (if requested) and nameSuffix (if requested).\nexportAgent successfully completed.\n"}

Example for PIPE

var(--codeSnippetCopyLabel) 
{
    "jobId": "452f0d842ead40899776526e5f55e4d7",
    "status": "COMPLETED_SUCCESSFULLY",
    "exporterType": "agent-vacation-summary",
    "outputFormat": "PIPE",
    "lastStatusChange": "2024-02-22T12:44:34.697Z",
    "resultsSizeBytes": {
        "compressed": 338,
        "uncompressed": 925
    },
    "totalRecords": 8,
    "additionalDetails": "Running Export Engine for Date Range 01/01/2022 - 03/01/2023\n\nConfiguration file used:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/452f0d842ead40899776526e5f55e4d7/Config.xml\nDate Format : ddmmyyyy\nTime Format : 12\nReport Headers : On\n\nProcessing entity list...\n - customer1\n    VG:  505 - TEST_TOG\n        VacYear:  Y_TOR\n        VacYear:  Y_TOR_1\n\nRunning application:  agentVacationSummary\n  Input File Name:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/452f0d842ead40899776526e5f55e4d7/Advanced.xml\n  Output File Name:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/452f0d842ead40899776526e5f55e4d7/Output.txt\n\nStarting Agent Vacation Summary export...\n/totalview/inst/tv4/prod/bin/exportTaken -x/totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/452f0d842ead40899776526e5f55e4d7/Output.txt.tmp -r/totalview/inst/tv4/run/customer1/work/dump/TOGR_lQmSD1a\n2024-02-22 14:44:32,766  WARN   main  [com.iex.tv.core.spring.BootstrapConfigurer] Could not load properties from class path resource [tvconfig/tv-remote.properties]: class path resource [tvconfig/tv-remote.properties] cannot be opened because it does not exist\n2024-02-22 14:44:32,770  WARN   main  [com.iex.tv.core.spring.BootstrapConfigurer] Could not load properties from class path resource [tvconfig/tv.properties]: class path resource [tvconfig/tv.properties] cannot be opened because it does not exist\n2024-02-22 14:44:32,916  WARN   main  [com.iex.tv.core.spring.TvHttpExecutor] Property tv.rcp.remoting.service.unavailable.sleep.time.millis not found, using default value (5000) instead.\nagentVacationSummary successfully completed.\n"}

Example for XML

var(--codeSnippetCopyLabel) 
{
    "jobId": "211cfdcf2a4841ee94ff3e90844a6e98",
    "status": "COMPLETED_SUCCESSFULLY",
    "exporterType": "agent-export",
    "outputFormat": "XML",
    "lastStatusChange": "2024-02-22T17:25:11.415Z",
    "resultsSizeBytes": {
        "compressed": 349255,
        "uncompressed": 35356788
    },
    "totalRecords": 7686,
    "additionalDetails": "Running Export Engine for Date Range 01/01/2023 - 01/01/2024\n\nConfiguration file used:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/211cfdcf2a4841ee94ff3e90844a6e98/Config.xml\nDate Format : Default Date Setting\nTime Format : Default Time Setting\nReport Headers : On\n\nProcessing entity list...\n - customer1\n    MU:  500 - MU_500\n\nRunning application:  exportAgent\n  Input File Name:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/211cfdcf2a4841ee94ff3e90844a6e98/Advanced.xml\n  Output File Name:  /totalview/inst/tv4/wfm_nodes/core/core01/temp/smartsync_wrapper/c1/211cfdcf2a4841ee94ff3e90844a6e98/Output.xml\nStarting Agent Export export...\nRecord Type: newAgent\nId Type: tvID\nCust: 1\nSchedPer: 5\n\nWARNING!  Cannot have both <name/> and <lastName/> in input xml file!\n          Default to using lastName, firstName (if requested) and nameSuffix (if requested).\nexportAgent successfully completed.\n"}

API Specification: Get Status for all jobs assigned to authenticated user:

Description

Get status and additional information about all submitted exporters tasks for authenticated user

Authentication
Required

yes

URL

https://<domain or IP>/SMARTSync/services/rs/exporters/v1/status

Method

GET

Request
Headers

Cookie: JSESSIONID={jsessionId}
Content-Type: application/json

Response
Headers

Content-Type: application/json

Success
Response

Code: 200 OK
Content : [Response Data]

Error
Response

Code: 401 Unauthorized

Error message:

{

"message": "Unauthorized",

"status": 401

}

Response Data

Response provides information about status and additional details for all existing jobs which are assigned to the authenticated user.

jobId is a 32 length string 
status: can be WAITING, RUNNING, COMPLETED_SUCCESFULLY, FAILED, CANCELED
exporterType: name of exporter
lastStatusChange: dateTime in ISO format about last status change date
outputFormat: result output format value (JSON, PIPE or XML)
totalRecords: number of response records. Only available for COMPLETED_SUCCESFULLY job status
lastStatusChange: dateTime in ISO format about last status change date
resultsSizeBytes: object which contains information about compressed and uncompressed response file size in bytes. Only available for COMPLETED_SUCCESFULLY job status

Response Example

var(--codeSnippetCopyLabel) 
[
    {
        "jobId": "b0defb14005a4e9fbddb96f57e296a3e",
        "status": "COMPLETED_SUCCESSFULLY",
        "exporterType": "mu-results",
        "outputFormat": "JSON",
        "lastStatusChange": "2024-02-20T20:23:29.650Z",
        "resultsSizeBytes": {
            "compressed": 525080,
            "uncompressed": 51757092
        },
        "totalRecords": 13440
    },
    {
        "jobId": "1bb6971062144c91b03ea50ef33f2238",
        "status": "COMPLETED_SUCCESSFULLY",
        "exporterType": "agent-export",
        "outputFormat": "JSON",
        "lastStatusChange": "2024-02-20T20:23:29.650Z",
        "resultsSizeBytes": {
            "compressed": 525080,
            "uncompressed": 51757092
        },
        "totalRecords": 13440
    },
    {
        "jobId": "b07b2e93b41d48049b22829228b407c4",
        "status": "COMPLETED_SUCCESSFULLY",
        "exporterType": "agent-info",
        "outputFormat": "PIPE",
        "lastStatusChange": "2024-02-22T12:42:20.562Z",
        "resultsSizeBytes": {
            "compressed": 59,
            "uncompressed": 13520
        },
        "totalRecords": 10920
    },
    {
        "jobId": "211cfdcf2a4841ee94ff3e90844a6e98",
        "status": "COMPLETED_SUCCESSFULLY",
        "exporterType": "agent-export",
        "outputFormat": "XML",
        "lastStatusChange": "2024-02-22T17:25:11.415Z",
        "resultsSizeBytes": {
            "compressed": 349255,
            "uncompressed": 35356788
        },
        "totalRecords": 7686
    }
]