Utilizando o protocolo HTTP (Hypertext Transfer Protocol) com o método de requisição GET, exemplo: Fazendo uma chamada REST utilizando a URL (Exemplo: http://app.bimachine.com.br/api/origins/schedulings/"ID agendamento"/status?key=" Chave da Api" ) usando a requisição GET; - " 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. Caminho: /api/origins/schedulins/ Método de Requisição: GET Parâmetros:
Para gerar a consulta de agendamento via API faça as seguintes aplicações: Passo 1 : Utilizando o método de requisição GET faça a chamada REST para "url": http://app.bimachine.com.br/api/origins/schedulings/1281/status?key=e71b35e5b236d5308349c1577a74e92d Ex: http://app.bimachine.com.br/api/origins/schedulings/1281/status?key=e71b35e5b236d5308349c1577a74e92d Chave de API: e71b35e5b236d5308349c1577a74e92d Passo 2: Resultados esperados ao executar a chamada: Código 200: Retorno de um objeto de autenticação criado no BIMachine; Conteúdo de 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. Para criar um agendamento via API faça as seguintes aplicações: Passo 1 : Utilizando o método de requisição GET faça a chamada REST para "url". Ex: http://app.bimachine.com.br/api/origins/schedulings/1210/execute?key=e71b35e5b236d5308349c1577a74e92d; Chave de API: e71b35e5b236d5308349c1577a74e92d; Código da carga criado: 1210. Passo 2: Resultados esperados ao executar a chamada: Código 201: Retorno de um objeto de autenticação criado no BIMachine; Conteúdo de Resposta: { "id": 1484 } |
13 - API >