GET /export/data
Função
Retorna dados da uMode filtrados por tipo e natureza.
A plataforma disponibiliza até 11 data classes para consulta:
DataClass | Function |
|---|---|
1 | Retorna dados de cadastro e registro de produtos |
2 | Retorna dados de aviamentos utilizados nos produtos |
3 | Retorna dados de matéria-prima |
4 | Retorna dados do processo de aprovação |
5 | Retorna dados de programação |
6 | Retorna dados de checklist de aprovação |
7 | Retorna dados de aprovação de estúdio |
8 | Campos customizados - (deprecated) |
9 | Retorna dados de aprovação customizada |
10 | Retorna dados de variantes customizadas |
11 | Retorna dados de produtos customizados |
Parâmetros Query
Param Name | Type | Mandatory | Description |
|---|---|---|---|
startDate | Date - YYYY-MM-DDTHH:mm:ss.sss | ! | Data inicial |
endDate | Date - YYYY-MM-DDTHH:mm:ss.sss | ! | Data final |
dataClass | int | ! | Sequencial dataClass |
page | int | ? | Página do report |
limit | int | ? | Número de itens na página |
itemRefSku | string | ? | Referência de item |
Informação: parâmetros ! são obrigatórios e parâmetros ? são opcionais.
Parâmetros de Header
Param Name | Mandatory | Description |
|---|---|---|
X-Api-Token | ! |
|
Informação: parâmetros ! são obrigatórios e parâmetros ? são opcionais.
Exemplo de Requisição - 200 OK
Requisição:
Headers:
Name | Value |
|---|---|
Origin | partnerAllowedClient |
X-Api-Token | validToken |
Content-type | application/json |
Retorno:
{
"metadata": {
"count": {
"total": 100,
"inCurrentPage": 10
},
"limit": 10,
"current": 1,
"lastPage": 10
},
"items": [
{
"partnerId": "string",
"createdAt": "2024-01-10T00:00:00.000Z",
"snapshopAt": "2024-01-10T00:00:00.000Z",
"dataClass": 1,
"partnerPlanningData": {}
}
]
}Exemplo de Requisição - Erro 400:
Requisição:
Headers:
Name | Value |
|---|---|
Origin | partner-registered-origin |
X-Api-Token | valid-token |
Content-type | application/json |
Retorno:
{
"message": "Required param must be valid, dataClass must be an integer number; startDate should not be empty, Required param must be valid; endDate should not be empty, Required param must be valid",
"error": "Bad Request",
"statusCode": 400
}Exemplo de Requisição - Erro 401:
Requisição:
Headers:
Name | Value |
|---|---|
X-Api-Token | validToken |
Content-type | application/json |
Retorno:
{
"message": "Origin is not allowed",
"error": "Unauthorized",
"statusCode": 401
}