> For the complete documentation index, see [llms.txt](https://docs.hotwax.co/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hotwax.co/documents/integrate-with-hotwax/components/admin/data-manager.md).

# Data Manager

Data Manager Management

## GET /dataManager

> list DataManagerConfig

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.datamanager.DataManagerConfig":{"title":"Data Manager Config","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerConfig"},"configId":{"type":"string"},"exportContentId":{"type":"string"},"importServiceName":{"type":"string"},"exportServiceName":{"type":"string"},"exportServiceScreenName":{"type":"string"},"exportServiceScreenLocation":{"type":"string"},"description":{"type":"string"},"scriptTitle":{"type":"string"},"delimiter":{"type":"string"},"fileNamePattern":{"type":"string"},"executionModeId":{"type":"string","enum":["DMC_ASYNC","DMC_QUEUE","DMC_SYNC"]},"multiThreading":{"type":"string"},"importPath":{"type":"string"},"exportPath":{"type":"string"},"priority":{"type":"number","format":"int64"},"enableDataFeed":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/dataManager":{"get":{"tags":["dataManager"],"summary":"list DataManagerConfig","description":null,"parameters":[{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"configId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"exportContentId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"importServiceName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"exportServiceName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"exportServiceScreenName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"exportServiceScreenLocation","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"scriptTitle","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"delimiter","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"fileNamePattern","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"executionModeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"multiThreading","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"importPath","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"exportPath","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"priority","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"enableDataFeed","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"createdStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## POST /dataManager

> create DataManagerConfig

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.datamanager.DataManagerConfig.PK":{"title":"Data Manager Config","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerConfig.PK"},"configId":{"type":"string"}}},"co.hotwax.datamanager.DataManagerConfig":{"title":"Data Manager Config","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerConfig"},"configId":{"type":"string"},"exportContentId":{"type":"string"},"importServiceName":{"type":"string"},"exportServiceName":{"type":"string"},"exportServiceScreenName":{"type":"string"},"exportServiceScreenLocation":{"type":"string"},"description":{"type":"string"},"scriptTitle":{"type":"string"},"delimiter":{"type":"string"},"fileNamePattern":{"type":"string"},"executionModeId":{"type":"string","enum":["DMC_ASYNC","DMC_QUEUE","DMC_SYNC"]},"multiThreading":{"type":"string"},"importPath":{"type":"string"},"exportPath":{"type":"string"},"priority":{"type":"number","format":"int64"},"enableDataFeed":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/dataManager":{"post":{"tags":["dataManager"],"summary":"create DataManagerConfig","description":null,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig"}}},"required":false}}}}}
```

## GET /dataManager/{configId}

> one DataManagerConfig

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.datamanager.DataManagerConfig":{"title":"Data Manager Config","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerConfig"},"configId":{"type":"string"},"exportContentId":{"type":"string"},"importServiceName":{"type":"string"},"exportServiceName":{"type":"string"},"exportServiceScreenName":{"type":"string"},"exportServiceScreenLocation":{"type":"string"},"description":{"type":"string"},"scriptTitle":{"type":"string"},"delimiter":{"type":"string"},"fileNamePattern":{"type":"string"},"executionModeId":{"type":"string","enum":["DMC_ASYNC","DMC_QUEUE","DMC_SYNC"]},"multiThreading":{"type":"string"},"importPath":{"type":"string"},"exportPath":{"type":"string"},"priority":{"type":"number","format":"int64"},"enableDataFeed":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/dataManager/{configId}":{"get":{"tags":["dataManager"],"summary":"one DataManagerConfig","description":null,"parameters":[{"schema":{"type":"string"},"name":"configId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## PUT /dataManager/{configId}

> update DataManagerConfig

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.datamanager.DataManagerConfig.PK":{"title":"Data Manager Config","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerConfig.PK"},"configId":{"type":"string"}}},"co.hotwax.datamanager.DataManagerConfig":{"title":"Data Manager Config","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerConfig"},"configId":{"type":"string"},"exportContentId":{"type":"string"},"importServiceName":{"type":"string"},"exportServiceName":{"type":"string"},"exportServiceScreenName":{"type":"string"},"exportServiceScreenLocation":{"type":"string"},"description":{"type":"string"},"scriptTitle":{"type":"string"},"delimiter":{"type":"string"},"fileNamePattern":{"type":"string"},"executionModeId":{"type":"string","enum":["DMC_ASYNC","DMC_QUEUE","DMC_SYNC"]},"multiThreading":{"type":"string"},"importPath":{"type":"string"},"exportPath":{"type":"string"},"priority":{"type":"number","format":"int64"},"enableDataFeed":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/dataManager/{configId}":{"put":{"tags":["dataManager"],"summary":"update DataManagerConfig","description":null,"parameters":[{"schema":{"type":"string"},"name":"configId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig"}}},"required":false}}}}}
```

## GET /dataManager/{configId}/downloadTemplate

> download Template

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}}},"paths":{"/dataManager/{configId}/downloadTemplate":{"get":{"tags":["dataManager"],"summary":"download Template","description":null,"parameters":[{"schema":{"type":"string"},"name":"configId","in":"path","required":true,"description":null}],"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## GET /dataManager/logs

> list DataManagerLogAndContent

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.datamanager.DataManagerLogAndContent":{"title":"Data Manager Log And Content","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerLogAndContent"},"logId":{"type":"string"},"parentLogId":{"type":"string"},"configId":{"type":"string"},"ownerPartyId":{"type":"string"},"logTypeEnumId":{"type":"string"},"createdByUserLogin":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"startDateTime":{"type":"string","format":"date-time"},"finishDateTime":{"type":"string","format":"date-time"},"cancelDateTime":{"type":"string","format":"date-time"},"statusId":{"type":"string"},"createdByJobId":{"type":"string"},"runByInstanceId":{"type":"string"},"runThread":{"type":"string"},"totalRecordCount":{"type":"number","format":"int64"},"failedRecordCount":{"type":"number","format":"int64"},"createdByJobRunId":{"type":"string"},"systemMessageId":{"type":"string"},"productStoreId":{"type":"string"},"logContentId":{"type":"string"},"fileName":{"type":"string"},"fileSize":{"type":"number","format":"int64"},"contentLocation":{"type":"string"},"logContentTypeEnumId":{"type":"string"},"description":{"type":"string"},"contentDate":{"type":"string","format":"date-time"},"userId":{"type":"string"}}}}},"paths":{"/dataManager/logs":{"get":{"tags":["dataManager"],"summary":"list DataManagerLogAndContent","description":null,"parameters":[{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"logId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"parentLogId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"configId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"ownerPartyId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"logTypeEnumId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"createdByUserLogin","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"createdDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"startDateTime","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"finishDateTime","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"cancelDateTime","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"statusId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"createdByJobId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"runByInstanceId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"runThread","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"totalRecordCount","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"failedRecordCount","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"createdByJobRunId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"systemMessageId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"productStoreId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"logContentId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"fileName","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"fileSize","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"contentLocation","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"logContentTypeEnumId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"contentDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"userId","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerLogAndContent"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## GET /dataManager/logs/{logId}

> one DataManagerLog (master: default)

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.datamanager.DataManagerLog.default":{"title":"Data Manager Log (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerLog"},"logId":{"type":"string"},"parentLogId":{"type":"string"},"configId":{"type":"string"},"ownerPartyId":{"type":"string"},"logTypeEnumId":{"type":"string","enum":["DmltExport","DmltImport"]},"createdByUserLogin":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"startDateTime":{"type":"string","format":"date-time"},"finishDateTime":{"type":"string","format":"date-time"},"cancelDateTime":{"type":"string","format":"date-time"},"statusId":{"type":"string","enum":["DmlsCancelled","DmlsCancelRequested","DmlsCrashed","DmlsFailed","DmlsFinished","DmlsPending","DmlsQueued","DmlsRunning"]},"createdByJobId":{"type":"string"},"runByInstanceId":{"type":"string"},"runThread":{"type":"string"},"totalRecordCount":{"type":"number","format":"int64"},"failedRecordCount":{"type":"number","format":"int64"},"createdByJobRunId":{"type":"string"},"systemMessageId":{"type":"string"},"productStoreId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"co.hotwax.datamanager.DataManagerConfig":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerConfig"},"co.hotwax.datamanager.DataManagerParameter":{"type":"array","items":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerParameter"}},"co.hotwax.datamanager.DataManagerContent":{"type":"array","items":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerContent"}}}},"co.hotwax.datamanager.DataManagerConfig":{"title":"Data Manager Config","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerConfig"},"configId":{"type":"string"},"exportContentId":{"type":"string"},"importServiceName":{"type":"string"},"exportServiceName":{"type":"string"},"exportServiceScreenName":{"type":"string"},"exportServiceScreenLocation":{"type":"string"},"description":{"type":"string"},"scriptTitle":{"type":"string"},"delimiter":{"type":"string"},"fileNamePattern":{"type":"string"},"executionModeId":{"type":"string","enum":["DMC_ASYNC","DMC_QUEUE","DMC_SYNC"]},"multiThreading":{"type":"string"},"importPath":{"type":"string"},"exportPath":{"type":"string"},"priority":{"type":"number","format":"int64"},"enableDataFeed":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}},"co.hotwax.datamanager.DataManagerParameter":{"title":"Data Manager Parameter","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerParameter"},"logId":{"type":"string"},"parameterName":{"type":"string"},"parameterValue":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}},"co.hotwax.datamanager.DataManagerContent":{"title":"Data Manager Content","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerContent"},"logContentId":{"type":"string"},"logId":{"type":"string"},"fileName":{"type":"string"},"fileSize":{"type":"number","format":"int64"},"contentLocation":{"type":"string"},"logContentTypeEnumId":{"type":"string","enum":["DmcntError","DmcntExported","DmcntImported","DmcntLog"]},"description":{"type":"string"},"contentDate":{"type":"string","format":"date-time"},"userId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/dataManager/logs/{logId}":{"get":{"tags":["dataManager"],"summary":"one DataManagerLog (master: default)","description":null,"parameters":[{"schema":{"type":"string"},"name":"logId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerLog.default"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## PUT /dataManager/logs/{logId}

> update DataManagerLog

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.datamanager.DataManagerLog.PK":{"title":"Data Manager Log","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerLog.PK"},"logId":{"type":"string"}}},"co.hotwax.datamanager.DataManagerLog":{"title":"Data Manager Log","type":"object","properties":{"_entity":{"type":"string","default":"co.hotwax.datamanager.DataManagerLog"},"logId":{"type":"string"},"parentLogId":{"type":"string"},"configId":{"type":"string"},"ownerPartyId":{"type":"string"},"logTypeEnumId":{"type":"string","enum":["DmltExport","DmltImport"]},"createdByUserLogin":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"startDateTime":{"type":"string","format":"date-time"},"finishDateTime":{"type":"string","format":"date-time"},"cancelDateTime":{"type":"string","format":"date-time"},"statusId":{"type":"string","enum":["DmlsCancelled","DmlsCancelRequested","DmlsCrashed","DmlsFailed","DmlsFinished","DmlsPending","DmlsQueued","DmlsRunning"]},"createdByJobId":{"type":"string"},"runByInstanceId":{"type":"string"},"runThread":{"type":"string"},"totalRecordCount":{"type":"number","format":"int64"},"failedRecordCount":{"type":"number","format":"int64"},"createdByJobRunId":{"type":"string"},"systemMessageId":{"type":"string"},"productStoreId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/dataManager/logs/{logId}":{"put":{"tags":["dataManager"],"summary":"update DataManagerLog","description":null,"parameters":[{"schema":{"type":"string"},"name":"logId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerLog.PK"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerLog"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.datamanager.DataManagerLog"}}},"required":false}}}}}
```

## DELETE /dataManager/logs/{logId}

> remove DataManagerLog

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}}},"paths":{"/dataManager/logs/{logId}":{"delete":{"tags":["dataManager"],"summary":"remove DataManagerLog","description":null,"parameters":[{"schema":{"type":"string"},"name":"logId","in":"path","required":true,"description":null}],"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## GET /dataManager/downloadDataManagerFile

> download DataManagerFile

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.util.UtilityServices.downloadDataManagerFile.Out":{"type":"object","properties":{"csvData":{"type":"string"}}}}},"paths":{"/dataManager/downloadDataManagerFile":{"get":{"tags":["dataManager"],"summary":"download DataManagerFile","description":null,"parameters":[{"schema":{"type":"string","format":""},"name":"logContentId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"configId","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.util.UtilityServices.downloadDataManagerFile.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## GET /dataManager/details

> get DataManagerLogDetails

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataManager","description":"Data Manager Management"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/admin"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"co.hotwax.util.UtilityServices.getDataManagerLogDetails.Out":{"type":"object","properties":{"dataManagerLogs":{"type":"array","items":{"type":"object"}},"dataManagerLogsCount":{"type":"integer","format":"int32"}}}}},"paths":{"/dataManager/details":{"get":{"tags":["dataManager"],"summary":"get DataManagerLogDetails","description":null,"parameters":[{"schema":{"type":"string","format":""},"name":"logId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"configId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"configId_op","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"statusId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"statusId_op","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"createdDate_from","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"createdDate_thru","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"logContentTypeEnumId","in":"query","required":false,"description":"The imported file's type: DmcntImported keeps only runs with an imported file. No other\n                    value matches; filter the error file with errorLogContentTypeEnumId."},{"schema":{"type":"string","format":""},"name":"errorLogContentTypeEnumId","in":"query","required":false,"description":"The error file's type: DmcntError keeps only runs with an error file."},{"schema":{"type":"string","format":""},"name":"priority","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"priority_op","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"systemMessageId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"systemMessageId_op","in":"query","required":false,"description":null},{"schema":{"type":"integer","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":null},{"schema":{"type":"integer","format":"int32"},"name":"pageSize","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.util.UtilityServices.getDataManagerLogDetails.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/admin/data-manager.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
