Histórico da Página
| Expandir | |||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
As APIs disponibilizadas funcionam com duas autenticações, Basic ou Token Bearer, nos dois casos é necessário um usuário e senha do RM previamente disponibilizado
|
| Expandir | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
Para buscar varias etapas no SGE, o filtro da busca deve ser passado via QueryString. codColigada: Coligada da Turma/Disciplina no RM idTurmaDisc: Id da Turma/Disciplina no RM tipoEtapa: N para nota ou F para falta
| |||||||||||||||||||||||||||||||||||||||||||||
| HTML | |||||||||||||||||||||||||||||||||||||||||||||
<!DOCTYPE html>
<html>
<head>
<title>edchart.com Yaml To HTML Converter</title>
</head>
<body>
<table>
<tr>
<td>openapi</td>
<td>servers.0.description</td>
<td>servers.0.url</td>
<td>servers.0.variables.serverUrl.default</td>
<td>servers.0.variables.serverHttpPort.default</td>
<td>info.description</td>
<td>info.version</td>
<td>info.title</td>
<td>info.contact.name</td>
<td>info.contact.url</td>
<td>info.contact.email</td>
<td>info.x-totvs.messageDocumentation.name</td>
<td>info.x-totvs.messageDocumentation.description</td>
<td>info.x-totvs.messageDocumentation.segment</td>
<td>info.x-totvs.productInformation.0.product</td>
<td>info.x-totvs.productInformation.0.contact</td>
<td>info.x-totvs.productInformation.0.description</td>
<td>info.x-totvs.productInformation.0.adapter</td>
<td>info.x-totvs.productInformation.0.helpUrl</td>
<td>info.x-totvs.productInformation.0.note</td>
<td>paths./systemParameters.get.tags.0</td>
<td>paths./systemParameters.get.summary</td>
<td>paths./systemParameters.get.x-totvs.productInformation.0.product</td>
Também é possível buscar uma etapa especifica, para isso os dados da chave devem ser passados na URL separados por pipeline "|", devem ser passados o codColigada, idTurmaDisc, codEtapa e tipoEtapa.
|
| Expandir | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Para buscar os planos de aula no SGE, o filtro da busca deve ser passado via QueryString. codColigada: Coligada da Turma/Disciplina no RM idTurmaDisc: Id da Turma/Disciplina no RM
Para atualizar os dados de um plano de aula (importação de conteúdo realizado) os dados da chave do registro devem ser passados na URL separados por pipeline "|" e os campos a serem atualizados devem ser enviados no corpo da requisição. Como chave do campo devem ser passados o codColigada, idTurmaDisc, idPlanoAula.
|
| HTML |
|---|
<style> .expand-control { cursor: pointer; text-decoration: none; margin-bottom: 10px; background-color: #ededed; height: 20px; font-size: 15px; padding: 5px; } .expand-control-text { vertical-align: top; font-weight: bold; color: #242424; } .post { background-color: #378000; color: #ffffff; display: inline-block; padding: 5px; border-radius: 5px; font-weight: bold; } .get { background-color: #004fd6; color: #ffffff; display: inline-block; padding: 5px; border-radius: 5px; font-weight: bold; } .put { background-color: #ffa200; color: #ffffff; display: inline-block; padding: 5px; border-radius: 5px; font-weight: bold; } .delete { background-color: #cf0000; color: #ffffff; display: inline-block; padding: 5px; border-radius: 5px; font-weight: bold; } .endereco{ display: inline-block; padding: 5px; font-weight: bold; } </style> <!-- EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST: <div class="post">POST</div> <div class="get">GET</div> <div class="put">PUT</div> <div class="delete">DELETE</div> O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO: <div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div> --><td>components.parameters.ParameterId.name</td> <td>components.parameters.ParameterId.in</td> <td>components.parameters.ParameterId.required</td> <td>components.parameters.ParameterId.description</td> <td>components.parameters.ParameterId.schema.type</td> <td>components.parameters.Codes.name</td> <td>components.parameters.Codes.in</td> <td>components.parameters.Codes.description</td> <td>components.parameters.Codes.required</td> <td>components.parameters.Codes.example</td> <td>components.parameters.Codes.schema.type</td> <td>components.parameters.Description.name</td> <td>components.parameters.Description.in</td> <td>components.parameters.Description.description</td> <td>components.parameters.Description.required</td> <td>components.parameters.Description.example</td> <td>components.parameters.Description.schema.type</td> </tr> <tr> <td>3.0.1</td> <td>API para os parâmetros de sistemas do produtos TOTVS</td> <td>{{host}}/api/framework/v1</td> <td>localhost</td> <td>8051</td> <td>API para os parâmetros de sistemas do produtos TOTVS</td> <td>1.000</td> <td>Parametros de Sistema</td> <td>T-Talk</td> <td>API.Totvs.com.br</td> <td>[email protected]</td> <td>systemParameters</td> <td>Parâmetros de Sistema</td> <td>Foundation</td> <td>Protheus</td> <td>[email protected]</td> <td>Cadastro de parâmetros</td> <td></td> <td>link aqui</td> <td>Essa API exige que seja configurada a segurança no servidor (SECURITY=1).</td> <td>System Parameters</td> <td>Retorna todos os parâmetros do sistema</td> <td>Protheus</td> <td>true</td> <td>Este verbo esta disponivel com todos os parametros</td> <td>12.1.23</td> <td>Retorna todos os parâmetros do sistema</td> <td>getSystemParameters</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Order</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Page</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/PageSize</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Fields</td> <td>#/components/parameters/Codes</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/AcceptLanguage</td> <td>#/components/parameters/Description</td> <td>Operação realizada com sucesso</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/PagedParameters</td> <td>System Parameters</td> <td>Inclui o parâmetro passado na requisição</td> <td>Inclui o parâmetro passado na requisição</td> <td>postParameter</td> <td>Protheus</td> <td>true</td> <td>Este verbo esta disponivel com todos os parametros</td> <td>12.1.23</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/ParameterInfo</td> <td>Parâmetro para ser incluido</td> <td>Operação realizada com sucesso</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/PagedParameters</td> <td>erro no momento da Inclusão</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel</td> <td>System Parameters</td> <td>Altera o parâmetro passado na requisição</td> <td>Altera o parâmetro passado na requisição</td> <td>postParameterId</td> <td>Protheus</td> <td>true</td> <td>Este verbo esta disponivel com todos os parametros</td> <td>12.1.23</td> <td>#/components/parameters/ParameterId</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/parameters/Authorization</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/ParameterInfo</td> <td>Parâmetro para ser incluído</td> <td>Operação realizada com sucesso</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/ParameterInfo</td> <td>erro no momento da Inclusão</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel</td> <td>Parâmetro não localizado na base</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel</td> <td>System Parameters</td> <td>Exclusão de parâmetro da base</td> <td>Exclusão de parâmetro da base</td> <td>DeleteParameterId</td> <td>Protheus</td> <td>true</td> <td>#/components/parameters/ParameterId</td> <td>Operação realizada com sucesso</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/SystemParameter_1_000.json#/definitions/ParameterInfo</td> <td>Não disponivel</td> <td>https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/apis/types/totvsApiTypesBase.json#/definitions/ErrorModel</td> <td>systemParameterId</td> <td>path</td> <td>true</td> <td>Identificador Único representando o parâmetro</td> <td>string</td> <td>codes</td> <td>query</td> <td>"Códigos de parâmetros retornados pelo get separado por vírgula (</td> <td>) "</td> <td>false</td> <td>"param1</td> <td>param2"</td> <td>string</td> <td>description</td> <td>query</td> <td>Busca de descrição do paramêtro</td> <td>false</td> <td>Parâmetro de busca</td> <td>string</td> </tr> <tr> <td></td> </tr> </table> </body> </html> |
Import HTML Content
Visão Geral
Conteúdo das Ferramentas