Get Status

Description

This service gets status for specified file.


Request

Restrictions

Can only be called after a successful consumer login as it Requires an authenticated user

Endpoint

GET https://<server-url>/api/v4/import/status/{id}

Parameters

Parameter
Location
Required
Description

touchpoint

Query / Header

Yes

The authentication token for the API session. Use Thalamus-Token for the header.

token

Query / Header

Yes

The authentication token for the API session. Use Thalamus-Token for the header.

id

Query / Header

Yes

ID of the file to query

Full URL Example

https://<server-url>/api/v4/import/status/274?touchpoint=test&token=...

Request Body

This request does not have a body.


Response

✅ Successful Response: 200 Ok

  • HTTP Status Code: 200 Ok

  • Data from the consulted file

Example Response

JSON

{
    "id": 274,
    "creationDate": 1757507096000,
    "modificationDate": 1757507205000,
    "creationOperator": 4,
    "modificationOperator": 4,
    "name": "vantasHoySep",
    "fileName": "PARTNERSaleImporter_Hoy.xlsx",
    "fileType": "EXCEL",
    "owner": {
        "id": 265,
        "entityType": 25011
    },
    "relatedEntityType": null,
    "importDate": 1757507200000,
    "userId": 4,
    "partnerDatasourceId": null,
    "mediumContextData": {
        "touchpointId": 3,
        "touchpointCountryId": null,
        "communicationId": null,
        "activityId": null,
        "direction": null,
        "location": null,
        "asyncExcution": false,
        "tags": null,
        "source": null,
        "countriesIds": null,
        "mediumDate": null
    },
    "mediumContextDataJson": "<com.thalamus.aaa.MediumContextData>\n  <touchpointId>3</touchpointId>\n  <asyncExcution>false</asyncExcution>\n</com.thalamus.aaa.MediumContextData>",
    "rows": 576,
    "rowsOk": 576,
    "rowsWithErrors": 0,
    "rowsSkipped": 0,
    "rowsRollbacked": 0,
    "rowsRollbackedWithErrors": 0,
    "state": "CANCELED",
    "percentageProcessed": 0,
    "totalToProcess": 0,
    "url": "https://s3.amazonaws.com/thalamus-imports/mmorena/develop/vantasHoySep_d47e96d5a5e8ed0e176c2df8774266b9.xlsx",
    "fileImportType": null,
    "fileSize": 82,
    "analysisResult": null,
    "analysisResultJson": null,
    "stateInternationalizableKey": "Canceled",
    "internationalizedState": "Canceled"
}

❌ Unsuccessful Response: 400 Bad Request

  • HTTP Status Code: 400 Bad Request

  • Body: A JSON object containing details about the error.

Example Response

JSON

{
  "errors": {
    "partnerDataSource": "TouchpointCodeRequired",
    "partnerDataSource": "InvalidTouchpointCode"
  }
}

Last updated

Was this helpful?