Skip to main content
POST
/
onboarding
/
api
/
v1
/
datasets-package
Crie um Pacote de Datasets
curl --request POST \
  --url https://api-hml.valid.com/onboarding/api/v1/datasets-package \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "group": "<string>",
  "datasets": [
    {}
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "group": "<string>",
  "datasets": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

​
Request Body

​
name
string
required
Nome do pacote de datasetsExemplo: Pacote de datasets
​
group
string
required
Grupo do pacote de datasetsValores possíveis: pf, pjExemplo: pf
​
datasets
array
required
Lista de datasets do pacote (mínimo 1 item)Formato: Array de objetos com chave “dataset”Exemplo: [{ "dataset": "basic_data" }]

​
Response

​
id
string
ID do pacote de datasetsFormato: UUIDExemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5
​
name
string
Nome do pacote de datasetsExemplo: Pacote de datasets
​
group
string
Grupo do pacote de datasetsExemplo: pf
​
datasets
array
Lista de datasets do pacoteExemplo: [{ "dataset": "basic_data" }]
​
createdAt
string
Data de criaçãoExemplo: 2023-01-01T12:00:00Z
​
updatedAt
string
Data de atualizaçãoExemplo: 2023-01-01T12:00:00Z

​
Respostas de Erro

​
code
string
Código do erro que categoriza o tipo de erroExemplo: VALIDATION_ERROR
​
message
string
Mensagem de erroExemplo: The request is invalid
​
details
array
Lista contendo detalhes do erro (opcional)