Atualizar Importação

PUT https://.account-name.krzlabs.io/v1/imports/:id

Realiza a atualização de uma importação.


Path Params

id string required
ID do import.

Body Params

Field Type Description Optional Searchable
status enum Status da importação. required false
file_key string Chave do arquivo no armazenamento. required false
file_name string Nome do arquivo importado. required true
catalog_id ObjectId ID do catálogo relacionado. required false
category_id ObjectId ID da categoria relacionada. required false
file_header_row number Linha do cabeçalho no arquivo. required false
file_worksheet_id string ID da worksheet do arquivo. required false
headers array(object) Cabeçalhos do arquivo.
requer duas keys:
colmn: string - required.
label: string - required
required false
mapped_headers object Mapeamento dos cabeçalhos. required false
columns_count number Quantidade de colunas. required false
rows_count number Quantidade de linhas. required false
errors_count number Quantidade de erros. required false
proccess_count number Linhas processadas. required false
commit_count number Registros comitados. required false
template
object Template associado à importação. required false
from_template_id ObjectId ID do template de origem. required false
deleted boolean Indica se a importação foi deletada. required false
Field Value
CONFIG_CATALOG 'config_catalog'
UPLOAD_FILE 'upload_file'
CONFIG_FILE 'config_file'
MAPPING_FILE 'mapping_file'
MAPPED_FILE 'mapped_file'
IMPORTING_DOCUMENT 'importing_documents'
IMPORTED_DOCUMENTS 'imported_documents'
COMMITING_DOCUMENTS 'commiting_documents'
CORRECTING_DOCUMENTS 'correcting_documents'
COMPLETED_PROCCESS 'completed_proccess'

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description Optional Searchable
catalog_id ObjectId ID do catálogo relacionado. not required false
category_id ObjectId ID da categoria relacionada. not required false
status enum Status da importação. required false
file_name string Nome do arquivo importado. not required true
file_key string Chave do arquivo no armazenamento. not required false
file_header_row number Linha do cabeçalho no arquivo. not required false
file_worksheet_id string ID da worksheet do arquivo. not required false
file_worksheet_name string Nome da worksheet do arquivo. not required false
columns_count number Quantidade de colunas. not required false
rows_count number Quantidade de linhas. not required false
proccess_count number Linhas processadas. not required false
commit_count number Registros comitados. not required false
errors_count number Quantidade de erros. not required false
created_by_name string Nome do usuário criador. required false
worksheets array(object) Worksheets do arquivo.
requer duas keys:
id: string - required
name: string - required
not required false
headers array(object) Cabeçalhos do arquivo.
requer duas keys:
colmn: string - required.
label: string - required
not required false
mapped_headers object Mapeamento dos cabeçalhos. not required false
logs array(string) Logs da importação. not required false
template
object Template associado à importação. not required false
from_template_id ObjectId ID do template de origem. not required false

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved