> 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-documents.md).

# Data Documents

Data Documents

## GET /dataDocuments

> get DataDocuments

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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.getDataDocuments.Out":{"type":"object","properties":{"dataDocuments":{"type":"array","items":{"type":"object"}},"dataDocumentsCount":{"type":"integer","format":"int32"}}}}},"paths":{"/dataDocuments":{"get":{"tags":["dataDocuments"],"summary":"get DataDocuments","description":null,"parameters":[{"schema":{"type":"string","format":""},"name":"dataFeedId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"primaryEntityName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"queryString","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.getDataDocuments.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## POST /dataDocuments/{dataDocumentId}/fields

> create DataDocumentField

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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":{"org.moqui.impl.EntityServices.createDataDocumentField.In":{"type":"object","properties":{"dataDocumentId":{"type":"string"},"fieldPath":{"type":"string"},"fieldNameAlias":{"type":"string"},"fieldType":{"type":"string"},"sortable":{"type":"string"},"defaultDisplay":{"type":"string"},"functionName":{"type":"string"},"sequenceNum":{"type":"integer","format":"int64"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}},"required":["dataDocumentId"]}}},"paths":{"/dataDocuments/{dataDocumentId}/fields":{"post":{"tags":["dataDocuments"],"summary":"create DataDocumentField","description":null,"parameters":[{"schema":{"type":"string"},"name":"dataDocumentId","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"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.moqui.impl.EntityServices.createDataDocumentField.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/org.moqui.impl.EntityServices.createDataDocumentField.In"}}},"required":true}}}}}
```

## PUT /dataDocuments/{dataDocumentId}/fields/{fieldSeqId}

> update DataDocumentField

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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":{"org.moqui.impl.EntityServices.updateDataDocumentField.In":{"type":"object","properties":{"dataDocumentId":{"type":"string"},"fieldSeqId":{"type":"string"},"fieldPath":{"type":"string"},"fieldNameAlias":{"type":"string"},"fieldType":{"type":"string"},"sortable":{"type":"string"},"defaultDisplay":{"type":"string"},"functionName":{"type":"string"},"sequenceNum":{"type":"integer","format":"int64"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}},"required":["dataDocumentId"]}}},"paths":{"/dataDocuments/{dataDocumentId}/fields/{fieldSeqId}":{"put":{"tags":["dataDocuments"],"summary":"update DataDocumentField","description":null,"parameters":[{"schema":{"type":"string"},"name":"dataDocumentId","in":"path","required":true,"description":null},{"schema":{"type":"string"},"name":"fieldSeqId","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"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org.moqui.impl.EntityServices.updateDataDocumentField.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/org.moqui.impl.EntityServices.updateDataDocumentField.In"}}},"required":true}}}}}
```

## DELETE /dataDocuments/{dataDocumentId}/fields/{fieldSeqId}

> delete DataDocumentField

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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":{"/dataDocuments/{dataDocumentId}/fields/{fieldSeqId}":{"delete":{"tags":["dataDocuments"],"summary":"delete DataDocumentField","description":null,"parameters":[{"schema":{"type":"string"},"name":"dataDocumentId","in":"path","required":true,"description":null},{"schema":{"type":"string"},"name":"fieldSeqId","in":"path","required":true,"description":null}],"responses":{"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"}}}}}}
```

## create DataDocumentCondition

> This is a very simple sort of condition to constrain data document output.

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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":{"moqui.entity.document.DataDocumentCondition.PK":{"title":"Data Document Condition","type":"object","properties":{"_entity":{"type":"string","default":"moqui.entity.document.DataDocumentCondition.PK"},"dataDocumentId":{"type":"string"},"conditionSeqId":{"type":"string"}}},"moqui.entity.document.DataDocumentCondition":{"title":"Data Document Condition","type":"object","properties":{"_entity":{"type":"string","default":"moqui.entity.document.DataDocumentCondition"},"dataDocumentId":{"type":"string"},"conditionSeqId":{"type":"string"},"fieldNameAlias":{"type":"string"},"operator":{"type":"string"},"fieldValue":{"type":"string"},"toFieldNameAlias":{"type":"string"},"postQuery":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/dataDocuments/{dataDocumentId}/conditions":{"post":{"tags":["dataDocuments"],"summary":"create DataDocumentCondition","description":"This is a very simple sort of condition to constrain data document output.","parameters":[{"schema":{"type":"string"},"name":"dataDocumentId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/moqui.entity.document.DataDocumentCondition.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/moqui.entity.document.DataDocumentCondition"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/moqui.entity.document.DataDocumentCondition"}}},"required":false}}}}}
```

## update DataDocumentCondition

> This is a very simple sort of condition to constrain data document output.

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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":{"moqui.entity.document.DataDocumentCondition.PK":{"title":"Data Document Condition","type":"object","properties":{"_entity":{"type":"string","default":"moqui.entity.document.DataDocumentCondition.PK"},"dataDocumentId":{"type":"string"},"conditionSeqId":{"type":"string"}}},"moqui.entity.document.DataDocumentCondition":{"title":"Data Document Condition","type":"object","properties":{"_entity":{"type":"string","default":"moqui.entity.document.DataDocumentCondition"},"dataDocumentId":{"type":"string"},"conditionSeqId":{"type":"string"},"fieldNameAlias":{"type":"string"},"operator":{"type":"string"},"fieldValue":{"type":"string"},"toFieldNameAlias":{"type":"string"},"postQuery":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/dataDocuments/{dataDocumentId}/conditions/{conditionSeqId}":{"put":{"tags":["dataDocuments"],"summary":"update DataDocumentCondition","description":"This is a very simple sort of condition to constrain data document output.","parameters":[{"schema":{"type":"string"},"name":"dataDocumentId","in":"path","required":true,"description":null},{"schema":{"type":"string"},"name":"conditionSeqId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/moqui.entity.document.DataDocumentCondition.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/moqui.entity.document.DataDocumentCondition"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/moqui.entity.document.DataDocumentCondition"}}},"required":false}}}}}
```

## delete DataDocumentCondition

> This is a very simple sort of condition to constrain data document output.

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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":{"/dataDocuments/{dataDocumentId}/conditions/{conditionSeqId}":{"delete":{"tags":["dataDocuments"],"summary":"delete DataDocumentCondition","description":"This is a very simple sort of condition to constrain data document output.","parameters":[{"schema":{"type":"string"},"name":"dataDocumentId","in":"path","required":true,"description":null},{"schema":{"type":"string"},"name":"conditionSeqId","in":"path","required":true,"description":null}],"responses":{"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 DataDocumentRelatedEntities

> Get related entities for a Data Document given a relationship path

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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.getDataDocumentRelatedEntities.Out":{"type":"object","properties":{"relationships":{"type":"array","items":{"type":"object"}}}}}},"paths":{"/dataDocuments/{dataDocumentId}/relatedEntities":{"get":{"tags":["dataDocuments"],"summary":"get DataDocumentRelatedEntities","description":"Get related entities for a Data Document given a relationship path","parameters":[{"schema":{"type":"string"},"name":"dataDocumentId","in":"path","required":true,"description":null},{"schema":{"type":"string","format":""},"name":"relationshipPath","in":"query","required":false,"description":"Colon separated path of relationship names, e.g. 'OrderPart:OrderItem'"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.util.UtilityServices.getDataDocumentRelatedEntities.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## get DataDocumentData

> Get data for a given Data Document

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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.getDataDocumentData.Out":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object"}},"documentData":{"type":"array","items":{"type":"object"}},"documentDataCount":{"type":"integer","format":"int32"}}}}},"paths":{"/dataDocuments/{dataDocumentId}/data":{"get":{"tags":["dataDocuments"],"summary":"get DataDocumentData","description":"Get data for a given Data Document","parameters":[{"schema":{"type":"string"},"name":"dataDocumentId","in":"path","required":true,"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},{"schema":{"type":"string","format":""},"name":"orderByField","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.util.UtilityServices.getDataDocumentData.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## POST /dataDocuments/export

> queue DocumentDataToExport

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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.queueDocumentDataToExport.In":{"type":"object","properties":{"dataDocumentId":{"type":"string"},"pageIndex":{"type":"integer","format":"int32","default":"{0}"},"pageSize":{"type":"integer","format":"int32","default":"{10000}"},"orderByField":{"type":"string"}},"required":["dataDocumentId"]}}},"paths":{"/dataDocuments/export":{"post":{"tags":["dataDocuments"],"summary":"queue DocumentDataToExport","description":null,"responses":{"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.util.UtilityServices.queueDocumentDataToExport.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.util.UtilityServices.queueDocumentDataToExport.In"}}},"required":true}}}}}
```

## GET /dataDocuments/export/{systemMessageId}

> get ExportedDocumentData

```json
{"openapi":"3.1.1","info":{"title":"Commerce Admin REST API","version":"4.0.0"},"tags":[{"name":"dataDocuments","description":"Data Documents"}],"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.getExportedDocumentData.Out":{"type":"object","properties":{"csvData":{"type":"string"}}}}},"paths":{"/dataDocuments/export/{systemMessageId}":{"get":{"tags":["dataDocuments"],"summary":"get ExportedDocumentData","description":null,"parameters":[{"schema":{"type":"string"},"name":"systemMessageId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.util.UtilityServices.getExportedDocumentData.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-documents.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.
