{ "openapi": "3.1.0", "info": { "title": "INFLOR - ALLIANCES API", "version": "v2", "description": "API for partnership integrations with INFLOR.", "contact": { "name": "Alliances Department", "email": "alliances@inflor.com", "url": "https://inflor.com" } }, "servers": [ { "url": "https://api-alliances.inflor-qas.cloud/api/v2", "description": "Quality" }, { "url": "https://api-alliances.inflor.cloud/api/v2", "description": "Production" } ], "components": { "securitySchemes": { "API-Key": { "type": "apiKey", "description": "API Key used for access authentication. Send it on the request `header` as `Authorization: Token {{api-key}}`.", "name": "Authorization", "in": "header" }, "Client-Code": { "type": "apiKey", "description": "The code used to identify the client. Send it on the request `header` as `Client-Code: {{client-code}}`.", "name": "Client-Code", "in": "header" } }, "schemas": { "ApiResponseBaseSchema": { "type": "object", "properties": { "requestId": { "type": [ "string", "null" ] }, "status": { "type": "string", "description": "Request outcome. Open list: new values may be added; clients should tolerate unknown values.", "examples": [ "success" ], "enum": [ "success", "processing", "accepted", "bad_request", "unprocessable_entity", "error", "service_unavailable" ] }, "message": { "type": "string" }, "dados": { "type": [ "object", "array", "null" ] }, "errors": { "type": [ "object", "null" ], "description": "Validation or rejection errors, per field (field -> list of messages). The `$` key identifies a rejection not tied to a specific field. It is null on technical failures.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "GetUltimosBoletinsSchema": { "additionalProperties": false, "type": "object", "properties": { "refRegistroOrigem": { "type": "string" }, "statusImportacao": { "type": "string" }, "dcrErro": { "type": "string" }, "dataAtualizacao": { "type": "string" } } }, "ErrorMessageResponse": { "type": "object", "properties": { "error": { "type": "string" } }, "additionalProperties": false }, "CtlImportColheita": { "type": "object", "properties": { "CD_BOLETIM_IMP": { "type": "string" }, "CD_BOLETIM_PROD_IMP": { "type": "string" }, "CD_TALHAO_PRACA_IMP": { "type": "string" }, "CD_TURNO": { "type": "string" }, "DATA_HORA_FIM_OPERACAO_IMP": { "type": "string" }, "DATA_HORA_INI_OPERACAO_IMP": { "type": "string" }, "DCR_NUM_MATRICULA_IMP": { "type": "string" }, "FLAG_ENVIO_AGRUPADO_IMP": { "type": "string" }, "ID_EQUIPAMENTO_IMP": { "type": "string" }, "ID_OPERACAO_IMP": { "type": "string" }, "ID_PARADA_IMP": { "type": "string" }, "ID_PRODUTO_IMP": { "type": "string" }, "ID_PROJETO_IMP": { "type": "string" }, "ID_REGIAO_IMP": { "type": "string" }, "QTD_DURACAO_BOL_IMP": { "type": "number" }, "QTD_PRODUCAO_IMP": { "type": "string" }, "REF_REGISTRO_ORIGEM": { "type": "string" }, "VLR_DISTANCIA_PERCORRIDA_IMP": { "type": "string" }, "VLR_HODOMETRO_FIM_IMP": { "type": "string" }, "VLR_HODOMETRO_INI_IMP": { "type": "string" }, "VLR_HORIMETRO_FIM_IMP": { "type": "string" }, "VLR_HORIMETRO_INI_IMP": { "type": "string" }, "VLR_VOLUME_APONTADO_IMP": { "type": "string" } }, "additionalProperties": false }, "PostBoletimColheitaRequestSchema": { "type": "object", "additionalProperties": false, "properties": { "ManagementUnit": { "type": "integer", "format": "int32" }, "SerialNumber": { "type": "string" }, "UserCode": { "type": "integer", "format": "int32" }, "CTL_IMPORT_COLHEITA": { "type": "array", "items": { "$ref": "#/components/schemas/CtlImportColheita" } } }, "required": [ "CTL_IMPORT_COLHEITA", "ManagementUnit" ] }, "PostBoletimColheitaResponseSchema": { "additionalProperties": false, "type": "object", "properties": { "refRegistroOrigem": { "type": "integer" } } }, "GetTurnosResponseSchema": { "type": "object", "additionalProperties": false, "properties": { "cdTurno": { "type": "integer" }, "cdFornecedor": { "type": "integer" }, "dcrTurno": { "type": "string" }, "abrevTurno": { "type": "string" }, "horaInicio": { "type": "string" }, "horaFim": { "type": "string" } } }, "GetEquipamentosResponseSchema": { "type": "object", "properties": { "cdEquipamento": { "type": "integer" }, "cdClasseEquipamento": { "type": "integer" }, "cdFamiliaEquipamento": { "type": "integer" }, "idEquipamento": { "type": "string" }, "dcrEquipamento": { "type": "string" }, "abrevEquipamento": { "type": "string" }, "dcrNumSerie": { "type": "string" }, "vlrCapacidade": { "type": "string" }, "dcrFamiliaEquipamento": { "type": "string" }, "abrevFamiliaEquipamento": { "type": "string" }, "dcrClasseEquipamento": { "type": "string" }, "abrevClasseEquipamento": { "type": "string" } } }, "GetOperacoesResponseSchema": { "type": "object", "properties": { "cdOperacao": { "type": "integer" }, "idOperacao": { "type": "string" }, "dcrOperacao": { "type": "string" }, "abrevOperacao": { "type": "string" } } }, "GetParadasResponseSchema": { "type": "array", "items": { "type": "object", "properties": { "cdParada": { "type": "integer" }, "idParada": { "type": "string" }, "dcrParada": { "type": "string" }, "abrevParada": { "type": "string" }, "tipParada": { "type": "string" }, "dcrClasseParada": { "type": "string" } } } }, "GetOSTalhoesOperResponseSchema": { "type": "array", "items": { "type": "object", "properties": { "cdOrdemServico": { "type": "integer" }, "cdFornecedor": { "type": "integer" }, "cdFrenteOperacao": { "type": "integer" }, "cdUnidadeGestao": { "type": "integer" }, "cdRegiao": { "type": "integer" }, "cdProjeto": { "type": "integer" }, "cdUsoSolo": { "type": "integer" }, "cdTalhao": { "type": "string" }, "cdProcesso": { "type": "integer" }, "cdOperacao": { "type": "integer" }, "idRegiao": { "type": "string" }, "idProjeto": { "type": "string" }, "dcrOrdemServico": { "type": "string" }, "dataIniOS": { "type": "string" }, "dataFimOS": { "type": "string" }, "dcrUnidadeGestao": { "type": "string" }, "dcrRegiao": { "type": "string" }, "nomProjeto": { "type": "string" }, "vlrVolumeUnit": { "type": "number" }, "vlrVolTotal": { "type": "number" }, "flagProprioTerceiro": { "type": "string" }, "tipProcesso": { "type": "string" }, "dataAssocOs": { "type": "string" }, "vlrArea": { "type": "number" } } } }, "GetFrenteOperacaoResponseSchema": { "type": "array", "items": { "type": "object", "properties": { "cdFornecedor": { "type": "integer" }, "cdEquipamento": { "type": "integer" }, "cdFrenteOperacao": { "type": "integer" }, "cdFuncionario": { "type": "integer" }, "abrevFrenteOperacao": { "type": "string" }, "dcrFornecedor": { "type": "string" }, "dcrNomeFuncionario": { "type": "string" }, "dcrFrenteOperacao": { "type": "string" }, "dcrNumMatricula": { "type": "string" } } } }, "GetProdutosResponseSchema": { "type": "array", "items": { "type": "object", "properties": { "cdProduto": { "type": "integer" }, "idProduto": { "type": "string" }, "dcrProduto": { "type": "string" }, "abrevProduto": { "type": "string" }, "numComprimentoTora": { "type": "string" } } } }, "GetCtoTalhaoResponseSchema": { "type": "array", "items": { "type": "object", "properties": { "cdUsoSolo": { "type": "string" }, "idRegiao": { "type": "string" }, "idProjeto": { "type": "string" }, "cdTalhao": { "type": "string" }, "cdOperacao": { "type": "string" }, "dcrOperacao": { "type": "string" }, "idOperacao": { "type": "string" }, "dataCto": { "type": "string" }, "ctoIndicado": { "type": "string" }, "ctoExecutado": { "type": "string" }, "idProduto": { "type": "string" } } } }, "GetVolumeAjustadoResponseSchema": { "type": "object", "properties": { "refRegistroOrigem": { "type": "string" }, "volumeApontado": { "type": "string" }, "volumeAjustado": { "type": "string" } } }, "PostBoletimRequestSchema": { "type": "object", "properties": { "ManagementUnit": { "type": "integer" }, "SerialNumber": { "type": [ "string", "null" ] }, "UserCode": { "type": [ "string", "null" ] }, "CTL_IMPORT_SILVICULTURA": { "type": "array", "items": { "type": "object", "properties": { "CD_ESCALA_RENDIMENTO_BOL": { "type": [ "string", "null" ] }, "CD_PADRAO_RENDIMENTO_BOL": { "type": [ "string", "null" ] }, "CD_USUARIO_APONTADOR": { "type": [ "string", "null" ] }, "CD_FUNCIONARIO_ENCARREGADO": { "type": [ "string", "null" ] }, "CD_FUNCIONARIO_AJUDANTE": { "type": [ "string", "null" ] }, "FLAG_FECHAMENTO_TALHAO": { "type": [ "string", "null" ] }, "REF_BOLETIM_SILV_DISPOSITIVO": { "type": [ "string", "null" ] }, "CD_UNIDADE_BOL": { "type": [ "string", "null" ] }, "CD_MOTIVO_DESCARTE_MUDA": { "type": [ "string", "null" ] }, "CD_ESPACAMENTO": { "type": [ "string", "null" ] }, "CD_MATERIAL_GENETICO": { "type": [ "string", "null" ] }, "QTD_DESCARTE": { "type": [ "string", "null" ] }, "CD_TURNO": { "type": [ "string", "null" ] }, "CD_EQUIPE": { "type": [ "string", "null" ] }, "CD_OPERACAO_PROGRAMADA": { "type": [ "string", "null" ] }, "DATA_OPERACAO": { "type": [ "string", "null" ] }, "VLR_PRODUCAO": { "type": [ "string", "null" ] }, "DCR_OBSERVACAO": { "type": [ "string", "null" ] }, "CTL_IMPORT_RECURSO_SILV": { "type": "array", "items": { "type": "object", "properties": { "FLAG_DEFAULT_HORIMETRO": { "type": [ "string", "null" ] }, "CD_PARADA": { "type": [ "string", "null" ] }, "NUM_HORIMETRO_INI": { "type": [ "string", "null" ] }, "NUM_HORIMETRO_FIM": { "type": [ "string", "null" ] }, "CD_PADRAO_RENDIMENTO_REC": { "type": [ "string", "null" ] }, "CD_UNIDADE_REC": { "type": [ "string", "null" ] }, "NUM_TOTAL_HORIMETRO": { "type": [ "string", "null" ] }, "CD_ESCALA_RENDIMENTO_REC": { "type": [ "string", "null" ] }, "DCR_OBSERVACAO_REC": { "type": [ "string", "null" ] }, "CD_EQUIPAMENTO_IMPLEMENTO": { "type": [ "string", "null" ] }, "CD_CLASSE_RENDIMENTO_REC": { "type": [ "string", "null" ] }, "FLAG_TIPO_RECURSO": { "type": [ "string", "null" ] }, "CD_RECURSO": { "type": [ "string", "null" ] }, "QTD_PRODUCAO": { "type": [ "string", "null" ] }, "CD_EQUIPAMENTO": { "type": [ "string", "null" ] }, "DATA_HORA_INI": { "type": [ "string", "null" ] }, "DATA_HORA_FIM": { "type": [ "string", "null" ] }, "NUM_TOTAL_HORAS": { "type": [ "string", "null" ] } } } } } } } } }, "PostBoletimResponseSchema": { "type": "object", "properties": { "refRegistroOrigem": { "type": [ "integer", "null" ] } } }, "GetStatusBoletinsResponseSchema": { "type": "object", "properties": { "refRegistroOrigem": { "type": "string" }, "statusBoletim": { "type": "string" }, "logErro": { "type": "string" } } }, "GetEquipamentosResponseSchema-2": { "type": "object", "properties": { "cdEquipamento": { "type": "string" }, "idEquipamento": { "type": "string" }, "dcrEquipamento": { "type": "string" }, "abrevEquipamento": { "type": "string" }, "dcrFamiliaEquipamento": { "type": "string" }, "cdFamiliaEquipamento": { "type": "string" }, "dcrFornecedor": { "type": "string" } } }, "GetEquipesResponseSchema": { "type": "object", "properties": { "cdEquipe": { "type": "string" }, "dcrEquipe": { "type": "string" }, "cdUnidadeGestao": { "type": "string" }, "cdFornecedor": { "type": "string" }, "cdFuncionarioEncarregado": { "type": "string" }, "cdFuncionarioAjudante": { "type": "string" } } }, "GetFuncionarioEquipeResponseSchema": { "type": "object", "properties": { "cdFuncionario": { "type": "string" }, "cdEquipe": { "type": "string" }, "dcrEquipe": { "type": "string" }, "cdUnidadeGestao": { "type": "string" }, "cdFornecedor": { "type": "string" } } }, "GetFuncionariosResponseSchema": { "type": "object", "properties": { "cdFuncionario": { "type": "string" }, "dcrNomeFuncionario": { "type": "string" }, "dcrNumMatricula": { "type": "string" }, "cdFornecedor": { "type": "string" }, "flagEncarregado": { "type": [ "string", "null" ] }, "flagAjudante": { "type": [ "string", "null" ] }, "flagFavEncarregado": { "type": [ "string", "null" ] }, "flagFavAjudante": { "type": [ "string", "null" ] } } }, "GetInsumosResponseSchema": { "type": "object", "properties": { "cdMaterial": { "type": "string" }, "dcrIdMaterial": { "type": "string" }, "dcrMaterial": { "type": "string" } } }, "GetOperacoesResponseSchema-2": { "type": "object", "properties": { "cdOperacao": { "type": "string" }, "idOperacao": { "type": "string" }, "dcrOperacao": { "type": "string" }, "abrevOperacao": { "type": "string" }, "dcrAtividade": { "type": "string" } } }, "GetOrdensServicoResponseSchema": { "type": "object", "properties": { "cdOrdemServico": { "type": "string" }, "dcrOrdemServico": { "type": "string" }, "dcrResponsavel": { "type": "string" }, "dcrDataValidade": { "type": "string" }, "dcrContrato": { "type": "string" }, "dcrFornecedor": { "type": "string" }, "cdUnidade": { "type": "string" } } }, "GetParadasResponseSchema-2": { "type": "object", "properties": { "cdParada": { "type": "string" }, "idParada": { "type": "string" }, "dcrParada": { "type": "string" }, "abrevParada": { "type": "string" }, "dcrClasseParada": { "type": "string" }, "produtivo": { "type": "string" }, "tipParada": { "type": "string" }, "cdFamiliaEquipamento": { "type": "array", "items": { "type": "string" } } } }, "GetProgramacoesResponseSchema": { "type": "object", "properties": { "dadosProgramacaoOperacoes": { "type": "array", "items": { "properties": { "cdOrdemServico": { "type": [ "string", "null" ] }, "dcrOrdemServico": { "type": [ "string", "null" ] }, "cdOperacaoProgramada": { "type": [ "string", "null" ] }, "cdPadraoRendimento": { "type": [ "string", "null" ] }, "cdClasseRendimento": { "type": [ "string", "null" ] }, "cdEscalaRendimento": { "type": [ "string", "null" ] }, "cdFornecedor": { "type": [ "string", "null" ] }, "dcrFornecedor": { "type": [ "string", "null" ] }, "cdUnidadeGestao": { "type": [ "string", "null" ] }, "dcrUnidadeGestao": { "type": [ "string", "null" ] }, "dataIniOs": { "type": [ "string", "null" ] }, "dataFimOs": { "type": [ "string", "null" ] }, "cdOperacao": { "type": [ "string", "null" ] }, "cdRegiao": { "type": [ "string", "null" ] }, "dcrRegiao": { "type": [ "string", "null" ] }, "cdProjeto": { "type": [ "string", "null" ] }, "nomProjeto": { "type": [ "string", "null" ] }, "cdTalhao": { "type": [ "string", "null" ] }, "cdUsoSolo": { "type": [ "string", "null" ] }, "vlrProducaoPrevista": { "type": [ "string", "null" ] }, "vlrProducaoRealizada": { "type": [ "string", "null" ] }, "pctOperado": { "type": [ "string", "null" ] } } } }, "dadosProgramacaoMateriais": { "type": "array", "items": { "properties": { "cdOperacaoProgramada": { "type": [ "string", "null" ] }, "cdMaterial": { "type": [ "string", "null" ] }, "dcrMaterial": { "type": [ "string", "null" ] }, "dcrUnidadeMedida": { "type": [ "string", "null" ] }, "cdPadraoRendimento": { "type": [ "string", "null" ] }, "cdClasseRendimento": { "type": [ "string", "null" ] }, "vlrMedioClasseRendimento": { "type": [ "string", "null" ] }, "vlrMinClasseRendimento": { "type": [ "string", "null" ] }, "vlrMaxClasseRendimento": { "type": [ "string", "null" ] }, "cdEscalaRendimento": { "type": [ "string", "null" ] }, "dcrEscalaRendimento": { "type": [ "string", "null" ] } } } }, "dadosProgramacaoEquipamentos": { "type": "array", "items": { "properties": { "cdOperacaoProgramada": { "type": [ "string", "null" ] }, "cdFamiliaEquipamento": { "type": [ "string", "null" ] }, "dcrFamiliaEquipamento": { "type": [ "string", "null" ] }, "abrevUnidadeMedida": { "type": [ "string", "null" ] }, "cdPadraoRendimento": { "type": [ "string", "null" ] }, "cdClasseRendimento": { "type": [ "string", "null" ] }, "vlrMedioClasseRendimento": { "type": [ "string", "null" ] }, "vlrMinClasseRendimento": { "type": [ "string", "null" ] }, "vlrMaxClasseRendimento": { "type": [ "string", "null" ] }, "cdEscalaRendimento": { "type": [ "string", "null" ] }, "dcrEscalaRendimento": { "type": [ "string", "null" ] } } } } } }, "PostProgramacoesRequestSchema": { "type": "object", "properties": { "callbackUrl": { "type": "string" }, "credentials": { "type": "object", "properties": { "authorization": { "type": "string" } } } } }, "PostProgramacoesResponseSchema": { "type": "object", "properties": { "dados": { "type": "null" }, "statusUrl": { "type": "string" } } }, "GetTurnosResponseSchema-2": { "type": "object", "properties": { "cdTurno": { "type": "string" }, "dcrTurno": { "type": "string" }, "abrevTurno": { "type": "string" }, "horaInicio": { "type": "string" }, "horaFim": { "type": "string" }, "dcrUnidadeGestao": { "type": "string" } } }, "GetUsuariosResponseSchema": { "type": "object", "properties": { "cdUsuario": { "type": "string" }, "dcrUsuario": { "type": "string" }, "dcrLogin": { "type": "string" } } }, "GetTimeTypesResponseSchema": { "type": "object", "properties": { "cdParada": { "type": "string" }, "abrevParada": { "type": "string" }, "dcrParada": { "type": "string" }, "tipParada": { "type": "string" }, "produtivo": { "type": "boolean" } }, "example": { "cdParada": "00000101-0000-4000-8000-000000000101", "abrevParada": "MEC", "dcrParada": "Manutenção mecânica", "tipParada": "Mechanical", "produtivo": false } }, "GetBulletinStatusRequestSchema": { "type": "object", "required": [ "refBoletimSilvDispositivos" ], "properties": { "refBoletimSilvDispositivos": { "type": "array", "minItems": 1, "items": { "type": "string" } } }, "example": { "refBoletimSilvDispositivos": [ "REF-0001" ] } }, "GetBulletinStatusResponseSchema": { "type": "object", "properties": { "apontamentoId": { "type": "string" }, "status": { "type": "string", "enum": [ "Cancelado", "Erro", "Processado" ] }, "mensagem": { "type": [ "string", "null" ] }, "equipamentos": { "type": "array", "items": { "type": "object", "properties": { "apontamentoId": { "type": "string" }, "status": { "type": "string" }, "mensagem": { "type": [ "string", "null" ] }, "horaInício": { "type": "string" }, "horaTérmino": { "type": "string" }, "horas": { "type": "number" }, "equipamentoId": { "type": "string" } } } } }, "example": { "apontamentoId": "REF-0001", "status": "Processado", "mensagem": null, "equipamentos": [ { "apontamentoId": "REF-0001", "status": "Processado", "mensagem": null, "horaInício": "2026-10-01T07:00:00", "horaTérmino": "2026-10-01T11:00:00", "horas": 4.5, "equipamentoId": "EQ-01" } ] } }, "PostBulletinRequestSchema": { "type": "object", "required": [ "managementUnit", "ctlImportSilvicultura" ], "properties": { "managementUnit": { "type": [ "string", "null" ], "description": "Management unit the bulletin belongs to." }, "serialNumber": { "type": [ "string", "null" ], "description": "Device serial number. Defaults to the client metadata value when omitted." }, "userCode": { "type": [ "string", "null" ], "description": "User code. Defaults to the client metadata value when omitted." }, "fornecedor": { "type": [ "string", "null" ], "description": "Supplier code. Optional." }, "ctlImportSilvicultura": { "type": "array", "description": "Bulletins to send.", "items": { "type": "object", "required": [ "ctlImportRecursoSilv" ], "properties": { "cdEscalaRendimentoBol": { "type": [ "string", "null" ] }, "cdPadraoRendimentoBol": { "type": [ "string", "null" ] }, "cdUsuarioApontador": { "type": [ "string", "null" ] }, "cdFuncionarioEncarregado": { "type": [ "string", "null" ] }, "cdFuncionarioAjudante": { "type": [ "string", "null" ] }, "flagFechamentoTalhao": { "type": [ "string", "null" ] }, "refBoletimSilvDispositivo": { "type": [ "string", "null" ] }, "cdUnidadeBol": { "type": [ "string", "null" ] }, "dcrSerialDispositivoApontador": { "type": [ "string", "null" ] }, "cdMotivoDescarteMuda": { "type": [ "string", "null" ] }, "cdEspacamento": { "type": [ "string", "null" ] }, "cdMaterialGenetico": { "type": [ "string", "null" ] }, "cdTurno": { "type": [ "string", "null" ] }, "cdEquipe": { "type": [ "string", "null" ] }, "cdOperacaoProgramada": { "type": [ "string", "null" ] }, "dataOperacao": { "type": [ "string", "null" ] }, "vlrProducao": { "type": [ "string", "null" ] }, "dcrObservacao": { "type": [ "string", "null" ] }, "versionCode": { "type": [ "string", "null" ] }, "deviceName": { "type": [ "string", "null" ] }, "dataCancelamento": { "type": [ "string", "null" ] }, "ctlImportRecursoSilv": { "type": "array", "description": "Bulletin resources.", "items": { "type": "object", "properties": { "cdParada": { "type": [ "string", "null" ] }, "cdPadraoRendimentoRec": { "type": [ "string", "null" ] }, "cdUnidadeRec": { "type": [ "string", "null" ] }, "numTotalHorimetro": { "type": [ "string", "null" ] }, "cdEscalaRendimentoRec": { "type": [ "string", "null" ] }, "dcrObservacaoRec": { "type": [ "string", "null" ] }, "cdClasseRendimentoRec": { "type": [ "string", "null" ] }, "flagTipoRecurso": { "type": [ "string", "null" ] }, "cdRecurso": { "type": [ "string", "null" ] }, "qtdProducao": { "type": [ "string", "null" ] }, "cdEquipamento": { "type": [ "string", "null" ] }, "dataHoraIni": { "type": [ "string", "null" ] }, "dataHoraFim": { "type": [ "string", "null" ] }, "numTotalHoras": { "type": [ "string", "null" ] }, "cdMotorista": { "type": [ "string", "null" ] } } } }, "ctlImportUsoSolo": { "type": "array", "description": "Bulletin land uses.", "items": { "type": "object", "properties": { "cdUsoSolo": { "type": [ "string", "null" ] } } } } } } } }, "example": { "managementUnit": "a2da8fea-89ef-46c8-bb60-9642858fa596", "serialNumber": "SN-0001", "userCode": "2c809481-fe54-48a0-9004-cbf8b03f3586", "fornecedor": "FORN-01", "ctlImportSilvicultura": [ { "refBoletimSilvDispositivo": "REF-0001", "cdUnidadeBol": "U-01", "dataOperacao": "2026-10-01T00:00:00", "ctlImportRecursoSilv": [ { "cdRecurso": "R-01", "cdEquipamento": "EQ-01", "cdMotorista": "M-01", "dataHoraIni": "2026-10-01T07:00:00", "dataHoraFim": "2026-10-01T11:00:00" } ], "ctlImportUsoSolo": [ { "cdUsoSolo": "US-01" } ] } ] } }, "PostBulletinResponseSchema": { "type": "object", "properties": { "refBoletimSilvDispositivo": { "type": "string", "description": "Bulletin reference on the device." } }, "example": { "refBoletimSilvDispositivo": "REF-0001" } }, "GetUserResponseSchema": { "type": "object", "properties": { "userId": { "type": "string" } }, "example": { "userId": "00000001-0000-4000-8000-000000000001" } }, "GetShiftsResponseSchema": { "type": "object", "properties": { "cdTurno": { "type": "string" }, "abrevTurno": { "type": "string" }, "dcrTurno": { "type": "string" }, "cdUnidadeGestao": { "type": "string" }, "dcrUnidadeGestao": { "type": "string" }, "horaInicioTurno": { "type": "string" }, "horaFimTurno": { "type": "string" }, "numHorasTurno": { "type": "number" } }, "example": { "cdTurno": "00000011-0000-4000-8000-000000000011", "abrevTurno": "T1", "dcrTurno": "Turno 1", "cdUnidadeGestao": "00000012-0000-4000-8000-000000000012", "dcrUnidadeGestao": "Unidade Norte", "horaInicioTurno": "07:00", "horaFimTurno": "16:00", "numHorasTurno": 8 } }, "GetEquipmentsResponseSchema": { "type": "object", "properties": { "cdEquipamento": { "type": "string" }, "abrevEquipamento": { "type": "string" }, "dcrEquipamento": { "type": "string" }, "cdFamiliaEquipamento": { "type": "string" }, "abrevFamiliaEquipamento": { "type": "string" }, "dcrFamiliaEquipamento": { "type": "string" }, "cdFornecedor": { "type": "string" }, "dcrFornecedor": { "type": "string" } }, "example": { "cdEquipamento": "00000021-0000-4000-8000-000000000021", "abrevEquipamento": "ESC-01", "dcrEquipamento": "Escavadeira 01", "cdFamiliaEquipamento": "00000022-0000-4000-8000-000000000022", "abrevFamiliaEquipamento": "ESC", "dcrFamiliaEquipamento": "Escavadeira", "cdFornecedor": "00000023-0000-4000-8000-000000000023", "dcrFornecedor": "Fornecedor Exemplo" } }, "GetDriversResponseSchema": { "type": "object", "properties": { "cdFuncionarioMotorista": { "type": "string" }, "dcrFuncionarioMotorista": { "type": "string" }, "dcrMatricula": { "type": "string" }, "cdFornecedor": { "type": "string" }, "dcrFornecedor": { "type": "string" } }, "example": { "cdFuncionarioMotorista": "00000031-0000-4000-8000-000000000031", "dcrFuncionarioMotorista": "Motorista Exemplo", "dcrMatricula": "12345", "cdFornecedor": "00000032-0000-4000-8000-000000000032", "dcrFornecedor": "Fornecedor Exemplo" } }, "GetLandUnitPlantingsResponseSchema": { "type": "object", "properties": { "cdUsoSolo": { "type": "string" }, "cdTalhao": { "type": "string" }, "cdRegiao": { "type": "string" }, "dcrRegiao": { "type": "string" }, "cdProjeto": { "type": "string" }, "dcrProjeto": { "type": "string" }, "idProjeto": { "type": "string" } }, "example": { "cdUsoSolo": "00000041-0000-4000-8000-000000000041", "cdTalhao": "00000042-0000-4000-8000-000000000042", "cdRegiao": "00000043-0000-4000-8000-000000000043", "dcrRegiao": "Região Sul", "cdProjeto": "00000044-0000-4000-8000-000000000044", "dcrProjeto": "Projeto Exemplo", "idProjeto": "PRJ-001" } }, "GetServiceOrdersResponseSchema": { "type": "object", "properties": { "cdOrdemServico": { "type": "string" }, "idOrdemServico": { "type": "string" }, "dcrOrdemServico": { "type": "string" }, "dataInicio": { "type": "string" }, "dataFim": { "type": "string" }, "cdFornecedor": { "type": "string" }, "dcrFornecedor": { "type": "string" }, "cdUnidadeGestao": { "type": "string" }, "dcrUnidadeGestao": { "type": "string" }, "cdEquipe": { "type": "string" }, "dcrEquipe": { "type": "string" }, "cdUsuarioResponsavel": { "type": "string" }, "dcrUsuarioResponsavel": { "type": "string" }, "cdFuncionarioEncarregado": { "type": "string" }, "dcrFuncionarioEncarregado": { "type": "string" }, "cdFuncionarioAjudante": { "type": "string" }, "dcrFuncionarioAjudante": { "type": "string" } }, "example": { "cdOrdemServico": "00000051-0000-4000-8000-000000000051", "idOrdemServico": "OS-0001", "dcrOrdemServico": "Manutenção de estrada", "dataInicio": "2026-01-01T00:00:00", "dataFim": "2026-12-31T00:00:00", "cdFornecedor": "00000052-0000-4000-8000-000000000052", "dcrFornecedor": "Fornecedor Exemplo", "cdUnidadeGestao": "00000053-0000-4000-8000-000000000053", "dcrUnidadeGestao": "Unidade Norte", "cdEquipe": "00000054-0000-4000-8000-000000000054", "dcrEquipe": "Equipe 1", "cdUsuarioResponsavel": "00000055-0000-4000-8000-000000000055", "dcrUsuarioResponsavel": "Responsável Exemplo", "cdFuncionarioEncarregado": "00000056-0000-4000-8000-000000000056", "dcrFuncionarioEncarregado": "Encarregado Exemplo", "cdFuncionarioAjudante": "00000057-0000-4000-8000-000000000057", "dcrFuncionarioAjudante": "Ajudante Exemplo" } }, "GetOperationSchedulesResponseSchema": { "type": "object", "properties": { "cdOperacaoProgramada": { "type": "string" }, "cdOperacao": { "type": "string" }, "dcrOperacao": { "type": "string" }, "idOperacao": { "type": "string" }, "cdRegiao": { "type": "string" }, "dcrRegiao": { "type": "string" }, "cdProjeto": { "type": "string" }, "dcrProjeto": { "type": "string" }, "idProjeto": { "type": "string" }, "cdUsoSolo": { "type": "string" }, "cdTalhao": { "type": "string" }, "cdPadraoRendimentoBol": { "type": "string" }, "cdEscalaRendimentoBol": { "type": "string" }, "dcrEscalaRendimentoBol": { "type": "string" }, "cdClasseRendimentoBol": { "type": "string" }, "cdUnidadeBol": { "type": "string" }, "permiteAlterarEscalaRendBol": { "type": "boolean" }, "necessitaTalhaoPlantio": { "type": "boolean" }, "equipamentosProgramados": { "type": "array", "items": { "type": "object", "properties": { "cdEquipamentoProgramado": { "type": "string" }, "cdFamiliaEquipamento": { "type": "string" }, "abrevFamiliaEquipamento": { "type": "string" }, "dcrFamiliaEquipamento": { "type": "string" }, "cdUnidadeRec": { "type": "string" }, "cdPadraoRendimentoRec": { "type": "string" }, "cdClasseRendimentoRec": { "type": "string" }, "cdEscalaRendimentoRec": { "type": "string" }, "dcrEscalaRendimentoRec": { "type": "string" } } } } }, "example": { "cdOperacaoProgramada": "00000061-0000-4000-8000-000000000061", "cdOperacao": "00000062-0000-4000-8000-000000000062", "dcrOperacao": "Patrolamento", "idOperacao": "OP-01", "cdRegiao": "00000063-0000-4000-8000-000000000063", "dcrRegiao": "Região Sul", "cdProjeto": "00000064-0000-4000-8000-000000000064", "dcrProjeto": "Projeto Exemplo", "idProjeto": "PRJ-001", "cdUsoSolo": "00000065-0000-4000-8000-000000000065", "cdTalhao": "00000066-0000-4000-8000-000000000066", "cdPadraoRendimentoBol": "00000067-0000-4000-8000-000000000067", "cdEscalaRendimentoBol": "00000068-0000-4000-8000-000000000068", "dcrEscalaRendimentoBol": "Escala 1", "cdClasseRendimentoBol": "00000069-0000-4000-8000-000000000069", "cdUnidadeBol": "00000070-0000-4000-8000-000000000070", "permiteAlterarEscalaRendBol": true, "necessitaTalhaoPlantio": false, "equipamentosProgramados": [ { "cdEquipamentoProgramado": "00000071-0000-4000-8000-000000000071", "cdFamiliaEquipamento": "00000072-0000-4000-8000-000000000072", "abrevFamiliaEquipamento": "MOT", "dcrFamiliaEquipamento": "Motoniveladora", "cdUnidadeRec": "00000073-0000-4000-8000-000000000073", "cdPadraoRendimentoRec": "00000074-0000-4000-8000-000000000074", "cdClasseRendimentoRec": "00000075-0000-4000-8000-000000000075", "cdEscalaRendimentoRec": "00000076-0000-4000-8000-000000000076", "dcrEscalaRendimentoRec": "Escala 1" } ] } }, "GetProductivityOperationResponseSchema": { "type": "object", "properties": { "cdClasseRendimentoBol": { "type": "string" }, "cdEscalaRendimentoBol": { "type": "string" }, "dcrEscalaRendimentoBol": { "type": "string" } }, "example": { "cdClasseRendimentoBol": "00000081-0000-4000-8000-000000000081", "cdEscalaRendimentoBol": "00000082-0000-4000-8000-000000000082", "dcrEscalaRendimentoBol": "Escala 1" } }, "GetProductivityEquipmentModelResponseSchema": { "type": "object", "properties": { "cdClasseRendimentoRec": { "type": "string" }, "cdEscalaRendimentoRec": { "type": "string" }, "dcrEscalaRendimentoRec": { "type": "string" } }, "example": { "cdClasseRendimentoRec": "00000091-0000-4000-8000-000000000091", "cdEscalaRendimentoRec": "00000092-0000-4000-8000-000000000092", "dcrEscalaRendimentoRec": "Escala 1" } }, "GetDataCubesResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "additionalProperties": false }, "GetDataCubesDataResponse": { "type": "object", "properties": { "dataCube": { "type": "string" }, "client": { "type": "string" }, "clientAbbrev": { "type": "string" }, "dataRequestedOn": { "type": "string", "format": "date-time" }, "lastDataRefresh": { "type": "string", "format": "date-time" }, "totalRecords": { "type": "integer" }, "dataset": { "type": "array", "items": { "type": "object", "properties": { "client": { "type": "string" }, "fund": { "type": "string" }, "property": { "type": "string" }, "tractName": { "type": "string" }, "tractNumber": { "type": "string" }, "compartment": { "type": "string" }, "stand": { "type": "string" }, "standKey": { "type": "string" }, "cycle": { "type": "integer" }, "rotation": { "type": "integer" }, "country": { "type": "string" }, "region": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "gisArea": { "type": "number" }, "bookArea": { "type": "number" }, "exclusionLayer": { "type": "number" }, "netBookArea": { "type": "number" }, "netGisArea": { "type": "number" }, "areaUnit": { "type": "string" }, "propertyManager": { "type": "string" }, "assetManager": { "type": "string" }, "ownership": { "type": "string" }, "landUse": { "type": "string" }, "certification": { "type": "string" }, "origin": { "type": "string" }, "dominantSpecies": { "type": "string" }, "speciesLabel": { "type": "string" }, "secondarySpecies": { "type": "string" }, "secSpeciesLabel": { "type": "string" }, "yearEstablished": { "type": "integer" }, "standAge": { "type": "integer" }, "description": { "type": "string" }, "strata": { "type": "string" }, "siteType": { "type": "string" }, "siteTypeLabel": { "type": "string" }, "convertibility": { "type": "string" }, "operability": { "type": "string" }, "merchClass": { "type": "string" }, "sizeClass": { "type": "string" }, "stockingClass": { "type": "string" }, "volumeClass": { "type": "string" }, "heightClass": { "type": "string" }, "densityClass": { "type": "string" }, "basalAreaClass": { "type": "string" }, "forestTypeClass": { "type": "string" }, "siteClass": { "type": "string" }, "physiographicRegion": { "type": "string" }, "status": { "type": "string" }, "elevation": { "type": "string" }, "aspect": { "type": "string" }, "slope": { "type": "string" }, "soilType": { "type": "string" }, "baseAge": { "type": "number" }, "siteIndex": { "type": "number" }, "dominantHeight": { "type": "number" }, "volumeEffectiveDate": { "type": "string", "format": "date-time" }, "volUnitsPulp": { "type": "string" }, "volUnitsSolid": { "type": "string" }, "softwoodTpa": { "type": "number" }, "softwoodBa": { "type": "number" }, "softwoodPpw": { "type": "number" }, "softwoodCns": { "type": "number" }, "softwoodSaw": { "type": "number" }, "softwoodTop": { "type": "number" }, "softwoodPpwTotal": { "type": "number" }, "softwoodCnsTotal": { "type": "number" }, "softwoodSawTotal": { "type": "number" }, "softwoodTopTotal": { "type": "number" }, "hardwoodTpa": { "type": "number" }, "hardwoodBa": { "type": "number" }, "hardwoodPpw": { "type": "number" }, "hardwoodSaw": { "type": "number" }, "hardwoodTop": { "type": "number" }, "hardwoodPpwTotal": { "type": "number" }, "hardwoodSawTotal": { "type": "number" }, "hardwoodTopTotal": { "type": "number" }, "cruiseDate": { "type": "string", "format": "date-time" }, "cruiser": { "type": "string" }, "cruiseType": { "type": "string" }, "cruiseValue": { "type": "string" }, "plots": { "type": "string" }, "error": { "type": "string" }, "cv": { "type": "string" }, "seedlingSource": { "type": "string" }, "seedlingGeneration": { "type": "string" }, "seedlingDetails": { "type": "string" }, "regenMethod": { "type": "string" }, "thinType": { "type": "string" }, "thinYear": { "type": "integer" }, "fertilizationMethod": { "type": "string" }, "fertilizationYear": { "type": "integer" }, "sitePrepMethod": { "type": "string" }, "sitePrepYear": { "type": "integer" }, "releaseMethod": { "type": "string" }, "releaseYear": { "type": "integer" }, "preCommercialMethod": { "type": "string" }, "preCommercialYear": { "type": "integer" }, "areaType": { "type": "string" }, "standCenX": { "type": "number" }, "standCenY": { "type": "number" }, "databaseUpdateDate": { "type": "string", "format": "date-time" }, "creation": { "type": "string", "format": "date-time" }, "id": { "type": "integer" } } } } }, "additionalProperties": false }, "GetDataCubeReportsResponse": { "type": "object", "properties": { "dataRequestedOn": { "type": "string", "format": "date-time" }, "totalReports": { "type": "integer" }, "reports": { "type": "array", "items": { "type": "object", "properties": { "reportId": { "type": "integer" }, "reportName": { "type": "string" }, "observations": { "type": "string" } } } } }, "additionalProperties": false }, "PaginationMetadata": { "type": "object", "additionalProperties": false, "properties": { "count": { "type": "integer" }, "pageSize": { "type": "integer" }, "hasNextPage": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "previousCursor": { "type": [ "string", "null" ] }, "orderBy": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "columnName": { "type": "string" }, "direction": { "type": "string" } } } } } }, "GetDataCubeReportsDataResponse": { "type": "object", "properties": { "reportId": { "type": "integer" }, "dataRequestedOn": { "type": "string", "format": "date-time" }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" }, "data": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false }, "Position": { "title": "Position", "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 3 }, "Point": { "title": "Point", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "Point" ] }, "coordinates": { "$ref": "#/components/schemas/Position" } } }, "MultiPoint": { "title": "MultiPoint", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "MultiPoint" ] }, "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/Position" } } } }, "LineString": { "title": "LineString", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "LineString" ] }, "coordinates": { "type": "array", "minItems": 2, "items": { "$ref": "#/components/schemas/Position" } } } }, "MultiLineString": { "title": "MultiLineString", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "MultiLineString" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 2, "items": { "$ref": "#/components/schemas/Position" } } } } }, "Polygon": { "title": "Polygon", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "Polygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "minItems": 4, "items": { "$ref": "#/components/schemas/Position" } } } } }, "MultiPolygon": { "title": "MultiPolygon", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "MultiPolygon" ] }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "minItems": 4, "items": { "$ref": "#/components/schemas/Position" } } } } } }, "Feature": { "title": "Feature", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "Feature" ] }, "geometry": { "oneOf": [ { "$ref": "#/components/schemas/Point" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "type": "null" } ] }, "properties": { "type": [ "object", "null" ] }, "id": { "type": [ "string", "number" ] } } }, "FeatureCollection": { "title": "FeatureCollection", "type": "object", "required": [ "type", "features" ], "properties": { "type": { "type": "string", "enum": [ "FeatureCollection" ] }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" }, "minItems": 0 }, "properties": { "type": [ "object", "null" ] } } }, "GeometryCollection": { "title": "GeometryCollection", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "GeometryCollection" ] }, "geometries": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Point" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" } ] } } } }, "GeoJSON": { "title": "GeoJson", "discriminator": { "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/FeatureCollection" }, { "$ref": "#/components/schemas/Feature" }, { "$ref": "#/components/schemas/GeometryCollection" }, { "$ref": "#/components/schemas/Point" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" } ] }, "InflorModuleEnum": { "type": "string", "enum": [ "ANA", "COL", "EST", "GIS", "SIL", "TRA" ] }, "LogStatusEnum": { "type": "string", "enum": [ "Completed", "Pending" ] }, "LogItem": { "type": "object", "additionalProperties": false, "properties": { "clientName": { "type": "string" }, "requestId": { "type": "string" }, "responseId": { "type": [ "string", "null" ] }, "resource": { "type": "string" }, "requestAt": { "type": "string", "format": "date-time" }, "responseAt": { "type": "string", "format": "date-time" }, "module": { "$ref": "#/components/schemas/InflorModuleEnum" }, "errorMessage": { "type": [ "string", "null" ] }, "logStatus": { "$ref": "#/components/schemas/LogStatusEnum" }, "dataReady": { "type": "boolean" } } }, "DataSentLogs": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LogItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } } }, "LogReceivedItem": { "type": "object", "additionalProperties": false, "properties": { "sender": { "type": "string" }, "requestId": { "type": "string" }, "responseId": { "type": "string" }, "resource": { "type": "string" }, "requestAt": { "type": "string", "format": "date-time" }, "responseAt": { "type": "string", "format": "date-time" }, "module": { "$ref": "#/components/schemas/InflorModuleEnum" }, "errorMessage": { "type": [ "string", "null" ] }, "logStatus": { "$ref": "#/components/schemas/LogStatusEnum" }, "dataReady": { "type": "boolean" } } }, "DataReceivedLogs": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LogReceivedItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationMetadata" } } }, "LogData": { "type": "object", "additionalProperties": false, "properties": { "payload": { "type": "object" } } } }, "responses": { "GetUltimosBoletinsResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetUltimosBoletinsSchema" } } } } ] } } } }, "ApiProcessingResponse": { "description": "Your request is being processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseBaseSchema" } } } }, "ApiBadRequestResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseBaseSchema" } } } }, "InvalidToken": { "description": "Unauthorized. It happens when the API Key sent does not pass authentication.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessageResponse" } } } }, "UnauthorizedAccess": { "description": "Forbidden. It happens when the API Key sent does not have access to the specified client.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessageResponse" } } } }, "ApiInternalServerErrorResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseBaseSchema" } } } }, "PostBoletimColheitaResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/PostBoletimColheitaResponseSchema" } } } } ] } } } }, "GetTurnosResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetTurnosResponseSchema" } } } } ] } } } }, "GetEquipamentosResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetEquipamentosResponseSchema" } } } } ] } } } }, "GetOperacoesResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetOperacoesResponseSchema" } } } } ] } } } }, "GetParadasResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/GetParadasResponseSchema" } } } ] } } } }, "GetOSTalhoesOperResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/GetOSTalhoesOperResponseSchema" } } } ] } } } }, "GetFrenteOperacaoResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/GetFrenteOperacaoResponseSchema" } } } ] } } } }, "GetProdutosResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/GetProdutosResponseSchema" } } } ] } } } }, "GetCtoTalhaoResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/GetCtoTalhaoResponseSchema" } } } ] } } } }, "GetVolumeAjustadoResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetVolumeAjustadoResponseSchema" } } } } ] } } } }, "PostBoletimResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/PostBoletimResponseSchema" } } } } ] } } } }, "GetStatusBoletinsResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetStatusBoletinsResponseSchema" } } } } ] } } } }, "GetEquipamentosResponse-2": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetEquipamentosResponseSchema-2" } } } } ] } } } }, "GetEquipesResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetEquipesResponseSchema" } } } } ] } } } }, "GetFuncionarioEquipeResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetFuncionarioEquipeResponseSchema" } } } } ] } } } }, "GetFuncionariosResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetFuncionariosResponseSchema" } } } } ] } } } }, "GetInsumosResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetInsumosResponseSchema" } } } } ] } } } }, "GetOperacoesResponse-2": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetOperacoesResponseSchema-2" } } } } ] } } } }, "GetOrdensServicoResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetOrdensServicoResponseSchema" } } } } ] } } } }, "GetParadasResponse-2": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetParadasResponseSchema-2" } } } } ] } } } }, "GetProgramacoesResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetProgramacoesResponseSchema" } } } } ] } } } }, "PostProgramacoesResponse": { "description": "The request will be processes asynchronously and your result will be returned thought the informed Webhook.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "$ref": "#/components/schemas/PostProgramacoesResponseSchema" } ] } } } }, "GetTurnosResponse-2": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetTurnosResponseSchema-2" } } } } ] } } } }, "GetUsuariosResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetUsuariosResponseSchema" } } } } ] } } } }, "GetTimeTypesResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetTimeTypesResponseSchema" } } } } ] } } } }, "ApiUnprocessableEntityResponse": { "description": "The destination system rejected the request. The `errors` field details the reason per field; the `$` key indicates a rejection not tied to a specific field.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, "example": { "requestId": "01J9ZQ8K3X5N7M2V4B6C8D0F1G", "status": "unprocessable_entity", "message": "The request was rejected by the destination system.", "dados": null, "errors": { "$": [ "The bulletin list cannot be empty." ] } } } } }, "ApiBadGatewayResponse": { "description": "The destination system returned an invalid response or could not be reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, "example": { "requestId": "01J9ZQ8K3X5N7M2V4B6C8D0F1G", "status": "error", "message": "The destination system returned an invalid response or could not be reached.", "dados": null } } } }, "ApiServiceUnavailableResponse": { "description": "The destination system or the service is temporarily unavailable or at capacity. Retry after the interval indicated in the `Retry-After` header.", "headers": { "Retry-After": { "description": "Time to wait, in seconds, before retrying.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, "example": { "requestId": "01J9ZQ8K3X5N7M2V4B6C8D0F1G", "status": "service_unavailable", "message": "The destination system is unavailable. Retry after the interval indicated in the Retry-After header.", "dados": null } } } }, "ApiGatewayTimeoutResponse": { "description": "The destination system did not respond in time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, "example": { "requestId": "01J9ZQ8K3X5N7M2V4B6C8D0F1G", "status": "error", "message": "The destination system did not respond in time.", "dados": null } } } }, "GetBulletinStatusResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetBulletinStatusResponseSchema" } } } } ] } } } }, "PostBulletinResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/PostBulletinResponseSchema" } } } } ] } } } }, "GetUserResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetUserResponseSchema" } } } } ] } } } }, "GetShiftsResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetShiftsResponseSchema" } } } } ] } } } }, "GetEquipmentsResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetEquipmentsResponseSchema" } } } } ] } } } }, "GetDriversResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetDriversResponseSchema" } } } } ] } } } }, "GetLandUnitPlantingsResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetLandUnitPlantingsResponseSchema" } } } } ] } } } }, "GetServiceOrdersResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetServiceOrdersResponseSchema" } } } } ] } } } }, "GetOperationSchedulesResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetOperationSchedulesResponseSchema" } } } } ] } } } }, "GetProductivityOperationResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetProductivityOperationResponseSchema" } } } } ] } } } }, "GetProductivityEquipmentModelResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "type": "array", "items": { "$ref": "#/components/schemas/GetProductivityEquipmentModelResponseSchema" } } } } ] } } } }, "GetDataCubesResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/GetDataCubesResponse" } } } ] } } } }, "BadRequest": { "description": "Bad Request. It happens when the request is sent without the API Key or the Client Code on the correct `headers` or when the tokens sent are in invalid formats.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessageResponse" } } } }, "GetDataCubesReportsResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/GetDataCubeReportsResponse" } } } ] } } } }, "GetDataCubesReportDataResponse": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/GetDataCubeReportsDataResponse" } } } ] } } } }, "GisAgolGeojson200": { "description": "Success.\nReturns a GeoJSON object following the [RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946 \"The GeoJSON Format\") specification.", "content": { "application/json": { "schema": { "description": "Um objeto GeoJSON.", "$ref": "#/components/schemas/GeoJSON" } } } }, "ClientErrorResponse": { "description": "It happens when there is a request error.\nThe code will specify the type of error and the body of the response will contain a message indicating the reason for the error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessageResponse" } } } }, "GetLogs": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/DataSentLogs" } } } ] } } } }, "GetLogsReceived": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/DataReceivedLogs" } } } ] } } } }, "GetLogsDataSingle": { "description": "Success.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiResponseBaseSchema" }, { "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/LogData" } } } ] } } } } }, "parameters": { "ServiceId": { "name": "serviceId", "in": "path", "schema": { "type": "string" } }, "LayerId": { "name": "layerId", "in": "query", "schema": { "type": "integer", "default": 0, "minimum": 0 } }, "ClientCode": { "name": "clientCode", "in": "query", "schema": { "type": "string" } }, "InflorModule": { "name": "module", "in": "query", "schema": { "$ref": "#/components/schemas/InflorModuleEnum" } }, "Endpoint": { "name": "endpoint", "in": "query", "schema": { "type": "string" } }, "StartDateTime": { "name": "startDateTime", "in": "query", "schema": { "type": "string", "format": "date-time" } }, "EndDateTime": { "name": "endDateTime", "in": "query", "schema": { "type": "string", "format": "date-time" } }, "Cursor": { "name": "cursor", "in": "query", "schema": { "type": "string" } }, "HasError": { "name": "hasError", "in": "query", "schema": { "type": "boolean" } }, "LogStatus": { "name": "logStatus", "in": "query", "schema": { "$ref": "#/components/schemas/LogStatusEnum" } }, "DataReady": { "name": "dataReady", "in": "query", "schema": { "type": "boolean" } }, "Package": { "name": "package", "in": "query", "schema": { "type": "string", "enum": [ "Analytics", "Telemetry" ] } }, "Sender": { "name": "sender", "in": "query", "schema": { "type": "string" } } } }, "security": [ { "API-Key": [], "Client-Code": [] } ], "tags": [ { "name": "harvest", "description": "Endpoints that interface with INFLOR's SGF Harvesting module.", "x-displayName": "Harvest" }, { "name": "silviculture", "description": "Endpoints that interface with INFLOR's SGF Silviculture module.", "x-displayName": "Silviculture" }, { "name": "roads", "description": "Endpoints that interface with INFLOR's SGF Roads module. The returned data follows the scope of the integration user configured for the client: shifts, equipment and service orders are filtered by that user's management units, and only active entities are returned.", "x-displayName": "Roads" }, { "name": "analytics", "description": "Analytics endpoints for API usage monitoring.", "x-displayName": "Analytics" }, { "name": "logs", "description": "Endpoints for monitoring the processing and logging of requests.", "x-displayName": "Logs" } ], "paths": { "/colheita/boletins": { "get": { "operationId": "col-get-boletins", "tags": [ "harvest" ], "summary": "Get Reports", "parameters": [ { "name": "RefRegistroOrigem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagementUnit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetUltimosBoletinsResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } }, "post": { "operationId": "postColheitaBoletins", "tags": [ "harvest" ], "summary": "Register Report", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostBoletimColheitaRequestSchema" } } } }, "responses": { "200": { "$ref": "#/components/responses/PostBoletimColheitaResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/turnos": { "get": { "operationId": "col-get-turnos", "tags": [ "harvest" ], "summary": "Get Shifts", "parameters": [ { "name": "AbrevTurno", "in": "query", "schema": { "type": "string" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetTurnosResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/equipamentos": { "get": { "operationId": "col-get-equipamentos", "tags": [ "harvest" ], "summary": "Get Equipments", "parameters": [ { "name": "IdEquipamento", "in": "query", "schema": { "type": "string" } }, { "name": "CdFrenteOperacao", "in": "query", "schema": { "type": "string" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagementUnit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetEquipamentosResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/operacoes": { "get": { "operationId": "col-get-operacoes", "tags": [ "harvest" ], "summary": "Get Operations", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagementUnit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetOperacoesResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/paradas": { "get": { "operationId": "col-get-paradas", "tags": [ "harvest" ], "summary": "Get Stops", "parameters": [ { "name": "ClasseParada", "in": "query", "schema": { "type": "string" } }, { "name": "TipParada", "in": "query", "schema": { "type": "string" } }, { "name": "AbrevParada", "in": "query", "schema": { "type": "string" } }, { "name": "IdParada", "in": "query", "schema": { "type": "string" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagementUnit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetParadasResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/os-talhao-oper": { "get": { "operationId": "col-get-os-talhao-oper", "tags": [ "harvest" ], "summary": "Get Work Orders", "parameters": [ { "name": "TipProprioTerceiro", "in": "query", "schema": { "type": "string" } }, { "name": "CdOperacao", "in": "query", "schema": { "type": "string" } }, { "name": "CdTalhao", "in": "query", "schema": { "type": "string" } }, { "name": "IdProjeto", "in": "query", "schema": { "type": "string" } }, { "name": "IdRegiao", "in": "query", "schema": { "type": "string" } }, { "name": "CdUnidadeGestao", "in": "query", "schema": { "type": "string" } }, { "name": "CdFornecedor", "in": "query", "schema": { "type": "string" } }, { "name": "CdOrdemServico", "in": "query", "schema": { "type": "string" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagementUnit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetOSTalhoesOperResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/frentes-operacao": { "get": { "operationId": "col-get-frentes-operacao", "tags": [ "harvest" ], "summary": "Get Operation Fronts", "parameters": [ { "name": "CdEquipamento", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "DcrNumMatricula", "in": "query", "schema": { "type": "string" } }, { "name": "CdFornecedor", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "AbrevFrenteOper", "in": "query", "schema": { "type": "string" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagementUnit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetFrenteOperacaoResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/produtos": { "get": { "operationId": "col-get-produtos", "tags": [ "harvest" ], "summary": "Get Products", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetProdutosResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/cto-talhao": { "get": { "operationId": "col-get-cto-talhao", "tags": [ "harvest" ], "summary": "Get Stand Harvest Block Closure", "parameters": [ { "name": "IdRegiao", "in": "query", "schema": { "type": "string" } }, { "name": "IdProjeto", "in": "query", "schema": { "type": "string" } }, { "name": "CdTalhao", "in": "query", "schema": { "type": "string" } }, { "name": "CdOperacao", "in": "query", "schema": { "type": "string" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagementUnit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetCtoTalhaoResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/colheita/volume-ajustado": { "get": { "operationId": "col-get-volume-ajustado", "tags": [ "harvest" ], "summary": "Get Adjusted Volume", "parameters": [ { "name": "RefRegistrosOrigem", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagementUnit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "$ref": "#/components/responses/GetVolumeAjustadoResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/boletins": { "post": { "operationId": "sil-post-boletins", "tags": [ "silviculture" ], "summary": "Register Report", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostBoletimRequestSchema" } } } }, "responses": { "200": { "$ref": "#/components/responses/PostBoletimResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/boletins-supervisor": { "post": { "operationId": "sil-post-boletins-supervisor", "tags": [ "silviculture" ], "summary": "Register Supervisor Report", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostBoletimRequestSchema" } } } }, "responses": { "200": { "$ref": "#/components/responses/PostBoletimResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/status-boletins": { "get": { "operationId": "sil-get-status-boletins", "tags": [ "silviculture" ], "summary": "Get Report Status", "parameters": [ { "name": "RefRegistroOrigem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetStatusBoletinsResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/equipamentos": { "get": { "operationId": "sil-get-equipamentos", "tags": [ "silviculture" ], "summary": "Get Equipment", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetEquipamentosResponse-2" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/equipes": { "get": { "operationId": "sil-get-equipes", "tags": [ "silviculture" ], "summary": "Get Teams", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetEquipesResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/funcionario-equipe": { "get": { "operationId": "sil-get-funcionario-equipe", "tags": [ "silviculture" ], "summary": "Get Team Employee", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetFuncionarioEquipeResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/funcionarios": { "get": { "operationId": "sil-get-funcionarios", "tags": [ "silviculture" ], "summary": "Get Employees", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetFuncionariosResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/insumos": { "get": { "operationId": "sil-get-insumos", "tags": [ "silviculture" ], "summary": "Get Inputs", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetInsumosResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/operacoes": { "get": { "operationId": "sil-get-operacoes", "tags": [ "silviculture" ], "summary": "Get Operations", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetOperacoesResponse-2" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/ordens-servico": { "get": { "operationId": "sil-get-ordens-servico", "tags": [ "silviculture" ], "summary": "Get Work Orders", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetOrdensServicoResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/paradas": { "get": { "operationId": "sil-get-paradas", "tags": [ "silviculture" ], "summary": "Get Stops", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetParadasResponse-2" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/programacoes": { "get": { "operationId": "sil-get-programacoes", "tags": [ "silviculture" ], "summary": "Get Schedules", "parameters": [ { "name": "OSCode", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetProgramacoesResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/programacoes/webhook": { "post": { "operationId": "sil-post-programacoes", "tags": [ "silviculture" ], "summary": "Get Schedules (Webhook)", "parameters": [ { "name": "OSCode", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostProgramacoesRequestSchema" } } } }, "responses": { "202": { "$ref": "#/components/responses/PostProgramacoesResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/turnos": { "get": { "operationId": "sil-get-turnos", "tags": [ "silviculture" ], "summary": "Get Shifts", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetTurnosResponse-2" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/silvicultura/usuarios": { "get": { "operationId": "sil-get-usuarios", "tags": [ "silviculture" ], "summary": "Get Users", "parameters": [ { "name": "SerialNumber", "in": "query", "schema": { "type": "string" } }, { "name": "UserCode", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "$ref": "#/components/responses/GetUsuariosResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/roads/time-types": { "get": { "operationId": "roads-get-time-types", "tags": [ "roads" ], "summary": "Get Downtime Types", "description": "Lists the stop types.", "responses": { "200": { "$ref": "#/components/responses/GetTimeTypesResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/bulletin-status": { "post": { "operationId": "roads-post-bulletin-status", "tags": [ "roads" ], "summary": "Get Bulletin Status", "description": "Used to find out what happened to one or more bulletins, sent in the body by the bulletin reference on the device (`refBoletimSilvDispositivos`). If there is one, it also returns the status of the equipment linked to the bulletin.\nResend rule: entries with Erro status can be sent again while the import process is still in Erro. Cancelado entries can only be sent when the import process is Processado.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulletinStatusRequestSchema" } } } }, "responses": { "200": { "$ref": "#/components/responses/GetBulletinStatusResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/bulletins": { "post": { "operationId": "roads-post-bulletins", "tags": [ "roads" ], "summary": "Post Bulletin", "description": "Sends bulletins from the Roads module for import into the SGF.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostBulletinRequestSchema" } } } }, "responses": { "200": { "$ref": "#/components/responses/PostBulletinResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/user": { "get": { "operationId": "roads-get-user", "tags": [ "roads" ], "summary": "Get User", "description": "Lists the user associated with the provided token. This user defines the accessible management units, the scope of the returned data and the Roads process.", "responses": { "200": { "$ref": "#/components/responses/GetUserResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/shifts": { "get": { "operationId": "roads-get-shifts", "tags": [ "roads" ], "summary": "Get Shifts", "description": "Lists the shifts linked to the user's management unit.", "responses": { "200": { "$ref": "#/components/responses/GetShiftsResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/equipments": { "get": { "operationId": "roads-get-equipments", "tags": [ "roads" ], "summary": "Get Equipments", "description": "Lists the equipment linked to the user's management unit.", "responses": { "200": { "$ref": "#/components/responses/GetEquipmentsResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/drivers": { "get": { "operationId": "roads-get-drivers", "tags": [ "roads" ], "summary": "Get Drivers", "description": "Lists the employees registered as Driver in the system. Unlike the other Roads endpoints, the list is not restricted to the user's Roads process.", "responses": { "200": { "$ref": "#/components/responses/GetDriversResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/land-unit-plantings": { "get": { "operationId": "roads-get-land-unit-plantings", "tags": [ "roads" ], "summary": "Get Land Unit Plantings", "description": "Returns the information of the planting land units, scheduled only.", "responses": { "200": { "$ref": "#/components/responses/GetLandUnitPlantingsResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/service-orders": { "get": { "operationId": "roads-get-service-orders", "tags": [ "roads" ], "summary": "Get Service Orders", "description": "Lists the service orders linked to the user's management unit, scheduled only.", "responses": { "200": { "$ref": "#/components/responses/GetServiceOrdersResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/operation-schedules": { "get": { "operationId": "roads-get-operation-schedules", "tags": [ "roads" ], "summary": "Get Operation Schedules", "description": "Returns the scheduled operations and, if there are any, the equipment scheduled for that operation. Takes as parameter the service order Id (`serviceOrderId`), found in service-orders.", "parameters": [ { "name": "serviceOrderId", "in": "query", "required": true, "description": "Service order Id, found in service-orders.", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GetOperationSchedulesResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/productivity-operation": { "get": { "operationId": "roads-get-productivity-operation", "tags": [ "roads" ], "summary": "Get Productivity Operation", "description": "Used when the productivity scale of an operation needs to be changed. Takes as parameter the Bulletin Productivity Standard Id (`cdPadraoRendimentoBol`), found in operation-schedules.", "parameters": [ { "name": "cdPadraoRendimentoBol", "in": "query", "required": true, "description": "Bulletin Productivity Standard Id, found in operation-schedules.", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GetProductivityOperationResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/roads/productivity-equipment-model": { "get": { "operationId": "roads-get-productivity-equipment-model", "tags": [ "roads" ], "summary": "Get Productivity Equipment Model", "description": "Used when the productivity scale of an equipment family needs to be changed. Takes as parameter the Resource Productivity Standard Id (`cdPadraoRendimentoRec`), found in operation-schedules (`equipamentosProgramados[].cdPadraoRendimentoRec`).", "parameters": [ { "name": "cdPadraoRendimentoRec", "in": "query", "required": true, "description": "Resource Productivity Standard Id, found in operation-schedules (equipamentosProgramados[].cdPadraoRendimentoRec).", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GetProductivityEquipmentModelResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "422": { "$ref": "#/components/responses/ApiUnprocessableEntityResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" }, "502": { "$ref": "#/components/responses/ApiBadGatewayResponse" }, "503": { "$ref": "#/components/responses/ApiServiceUnavailableResponse" }, "504": { "$ref": "#/components/responses/ApiGatewayTimeoutResponse" } } } }, "/analytics/data-cubes": { "get": { "operationId": "ana-get-data-cubes", "tags": [ "analytics" ], "summary": "Get DataCubes", "responses": { "200": { "$ref": "#/components/responses/GetDataCubesResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/analytics/data-cubes/{id}": { "get": { "operationId": "ana-get-single-data-cube", "tags": [ "analytics" ], "summary": "Get Single DataCube", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataCubesDataResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/analytics/data-cubes/reports": { "get": { "operationId": "ana-get-data-cube-reports", "tags": [ "analytics" ], "summary": "Get Available Reports", "responses": { "200": { "$ref": "#/components/responses/GetDataCubesReportsResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/analytics/data-cubes/reports/{id}": { "get": { "operationId": "ana-get-single-data-cube-report", "tags": [ "analytics" ], "summary": "Get Single Report", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GetDataCubesReportDataResponse" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "401": { "$ref": "#/components/responses/InvalidToken" }, "403": { "$ref": "#/components/responses/UnauthorizedAccess" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/gis/agol/geojson/{serviceId}": { "get": { "operationId": "ana-get-gis-agol-geojson", "tags": [ "analytics" ], "summary": "Get AGOL GeoJSON", "parameters": [ { "$ref": "#/components/parameters/ServiceId" }, { "$ref": "#/components/parameters/LayerId" } ], "responses": { "200": { "$ref": "#/components/responses/GisAgolGeojson200" }, "4xx": { "$ref": "#/components/responses/ClientErrorResponse" } } } }, "/logs": { "get": { "operationId": "log-get-logs", "tags": [ "logs" ], "summary": "Get Logs", "description": "Searches for the logs of the requests made by your account.", "security": [ { "API-Key": [] } ], "parameters": [ { "$ref": "#/components/parameters/ClientCode" }, { "$ref": "#/components/parameters/InflorModule" }, { "$ref": "#/components/parameters/Endpoint" }, { "$ref": "#/components/parameters/StartDateTime" }, { "$ref": "#/components/parameters/EndDateTime" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/HasError" }, { "$ref": "#/components/parameters/LogStatus" }, { "$ref": "#/components/parameters/DataReady" }, { "$ref": "#/components/parameters/Package" } ], "responses": { "200": { "$ref": "#/components/responses/GetLogs" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/logs/received": { "get": { "operationId": "log-get-received-logs", "tags": [ "logs" ], "summary": "Get Account-Bound Logs", "description": "Searches for the logs of the requests made where the data is linked to your account even if the request wasn't sent by your account.", "security": [ { "API-Key": [] } ], "parameters": [ { "$ref": "#/components/parameters/Sender" }, { "$ref": "#/components/parameters/InflorModule" }, { "$ref": "#/components/parameters/Endpoint" }, { "$ref": "#/components/parameters/StartDateTime" }, { "$ref": "#/components/parameters/EndDateTime" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/HasError" }, { "$ref": "#/components/parameters/LogStatus" }, { "$ref": "#/components/parameters/DataReady" }, { "$ref": "#/components/parameters/Package" } ], "responses": { "200": { "$ref": "#/components/responses/GetLogsReceived" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } }, "/logs/data/{id}": { "get": { "operationId": "log-get-single-log-data", "tags": [ "logs" ], "summary": "Get Log", "description": "Return the data associated with a log registry.", "security": [ { "API-Key": [] } ], "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GetLogsDataSingle" }, "202": { "$ref": "#/components/responses/ApiProcessingResponse" }, "400": { "$ref": "#/components/responses/ApiBadRequestResponse" }, "500": { "$ref": "#/components/responses/ApiInternalServerErrorResponse" } } } } } }