Criando cargas API
Ao criar um “Novo agendamento de carga” você será direcionado a essa página.
Esse agendamento de carga é disparado quando acionado o disparo imediato, ou pela URL com a requisição por POST fora executada.
Método de Requisição: POST
Método de Requisição: POST
![]("https://support.bimachine.com/wp-content/uploads/2023/05/)
Identificador da carga:
Situação da Carga
Verificando situação da carga.Metodo de requisição: GET
Caminho: /api/origins/schedulings/”Código agendamento“/status?appKey=” Chave da Api” )
– ” ID agendamento “: É o código gerado após a chamada via API do agendamento.
– ” Chave da Api“: Em seu perfil existe uma opção de gerar uma chave, que você utilizará junto ao código do agendamento criado.
Parâmetros:
|
Nome
|
Descrição
|
Tipo
|
|---|---|---|
|
key
|
chave da api
|
string
|
Resposta: Código 200
Conteúdo da Resposta:
{ “id”: 12453, “loadType”: “Incremental”, “status”: “ERROR”, “startDate”: 1458566160000, “endDate”: 1458566163000, “log”: “log da carga”}
Após executar a consulta terá alguns dados de retorno. Veja no exemplo:
Onde:
– id: identificador da requisição.
– loadType: É o tipo de carga.
– status: Status da carga no momento. (Status possíveis: SUCCESS, ERROR, RUNNING, NEW_DATA_NOT_FOUND, NOT_FINISHED, NOT_STARTED).
– startDate: Data de início do agendamento.
– endDate: Data fim do agendamento.
– log: Log do agendamento.
Disparando Carga
Disparando uma carga de um agendamento de carga por API.
Método de requisição: POST
Caminho: /api/origins/schedulings/“Código da carga”/execute?appKey=12345abcd.
Resposta: Código 201
Conteúdo da Resposta:
{ “id”: 1484}