TOTVS - RESTFul API

COMPANIES

/COMPANIES/ [ GET_COMPANIES ]

Description

endpoint de criação de grupo de empresas

For more details

BRANCHES

/BRANCHES/ [ GET_BRANCH ]

Description

endpoint de criação de Filais

For more details

TOKEN

/TOKEN/ [ POST ]

Description

Endpoint para geração e atualização de token de acesso.

For more details

MENUS

/MENUS/ [ GET_ALL ]

Description

Menus é a representação do item de segurança que permite acesso as produtos TOTVS.

For more details

SYSTEMPARAMETERS

/SYSTEMPARAMETERS/ [ DELETE GET_ALL POST PUT ]

Description

API para os parâmetros de sistemas do produtos TOTVS

For more details

VALCNABATI

/VALCNABATI/ [ GET ]

Description

Recebe Lista de CNAB´s Ativo

For more details

LEARQCONFIG

/LEARQCONFIG/ [ GET ]

Description

Recebe Arquivo Configuração CNAB´s

For more details

CHANGEPASSWORDUSERSERVICE

/CHANGEPASSWORDUSERSERVICE/ [ GET POST ]

Description

API para troca de senha do usuário

For more details

COMPANIESTSS

/COMPANIESTSS/ [ GET_COMPANIES POST_CONFIG ]

Description

Servicos de NFe

For more details

DISCOVERYPKGMAN

/DISCOVERYPKGMAN/ [ GET_APPLY PUT_CREATE ]

Description

API de Aplicação e manutenção de pacotes

For more details

TOTVSEAI

/TOTVSEAI/ [ DELETE_FILTER GET_APPS POST_APPSCONF PUT_FILTER ]

Description

Serviço genérico do EAI TOTVS.

Este serviço permite o uso do EAI em diferentes contextos, de maneira única a todos os produtos TOTVS.

Para detalhes do EAI Protheus, consulte a documentação do EAI Protheus aqui

For more details

ACCESSPRIVILEGESSERVICES

/ACCESSPRIVILEGESSERVICES/ [ GET_ALIASACCESS ]

Description

Serviço para consulta de privilégios

For more details

AGENTSCHEDULE

/AGENTSCHEDULE/ [ DELETE_AGENTSCHEDULE GET_AGENTSCHEDULE POST_AGENTSCHEDULE PUT_AGENTSCHEDULE ]

Description

Endpoint de agentes de schedule

For more details

FWATTRESTLOG

/FWATTRESTLOG/ [ GET ]

Description

API para consulta de logs de auditoria do gestão de projetos

For more details

BASICPROTHEUSSERVICES

/BASICPROTHEUSSERVICES/ [ GET_DBSTRUCT ]

Description

API de serviços gerais do Protheus

For more details

DBDATAPROVIDERS

/DBDATAPROVIDERS/ [ GET_PARAMETERS POST_GETDATA ]

Description

Classe para permitir serviço Smart View gerar relatórios com as entidades do Protheus

For more details

DISCOVERYENVEXCLUSIVE

/DISCOVERYENVEXCLUSIVE/ [ GET_ALL ]

Description

API de verificação de acesso exclusivo ao sistema

For more details

DISCOVERYENVIRONMENTS

/DISCOVERYENVIRONMENTS/ [ DELETE GET_ALL POST PUT ]

Description

API dos ambientes do TOTVS Discovery

For more details

DISCOVERYSTAGES

/DISCOVERYSTAGES/ [ DELETE GET_ALL POST PUT ]

Description

API Stages dos ambientes que serão utilizados para classificação do ambientes do TOTVS Discovery

For more details

EAISCHEDULE

/EAISCHEDULE/ [ GET_EAISCHEDULE PUT_EAIBLOCKTRANS ]

Description

Endpoint de EAIs de schedule

For more details

SMARTSCHEDEXEC

/SMARTSCHEDEXEC/ [ DELETE_SCHEXECDELETE GET_SMARTALLEXECLIST POST_EXECUTESMARTSCHED ]

Description

Endpoint de SmartSchedExec

For more details

BRAND

/BRAND/ [ GET ]

Description

Endpoint para consulta de marca do ERP

For more details

LANGUAGE

/LANGUAGE/ [ GET ]

Description

Endpoint para consulta de idiomas do Protheus

For more details

HEALTHCHECK

/HEALTHCHECK/ [ GET_SIMPLE ]

Description

avaliação de status do server rest

For more details

JOBEXECUTION

/JOBEXECUTION/ [ GET_EXECLIST ]

Description

endpoint de JobExecution

For more details

JOBSCHEDULER

/JOBSCHEDULER/ [ DELETE_SCHED GET_ID_SCHD POST_SCHED PUT_SCHED ]

Description

endpoint de JobScheduler

For more details

JWKS

/JWKS/ [ GET ]

Description

JWK for JWT

For more details

FWJWT

/FWJWT/ [ POST ]

Description

JWT authentication for REST

For more details

DISCOVERYLOGOPERATION

/DISCOVERYLOGOPERATION/ [ GET_ALL ]

Description

API para consulta de logs operacionais do discovery

For more details

OAUTHCALLBACK

/OAUTHCALLBACK/ [ GET ]

Description

API para Callback de cliente oAuth2

For more details

OAUTH

/OAUTH/ [ GET POST ]

Description

Protheus oAuth server

For more details

PROFILESERVICE

/PROFILESERVICE/ [ DELETE_PROFILE GET_PROFILE POST_PROFILE PUT_PROFILE ]

Description

API de Profile do Protheus

For more details

PROJECTINFOENV

/PROJECTINFOENV/ [ GET_ALL POST_CREATEPACK ]

Description

API responsável por retornar informações dos projetos de um determinado ambiente

For more details

QS

/QS/ [ GET ]

Description

RESTFUL de execução dos indicadores de consulta rápida

For more details

CHECK_SECURITY

/CHECK_SECURITY/ [ GET ]

Description

Este serviço informa se a segurança no servidor REST esta habilitada e se a autenticação foi efetuada com sucesso

For more details

DISCOVERY

/DISCOVERY/ [ DELETE_ENVIRONMENTS GET_CONFIGGET POST_AUTHENTICATION ]

Description

Informações do ambiente Protheus

For more details

FWMODEL

/FWMODEL/ [ DELETE GET POST PUT ]

Description

Serviço genérico de integração e manipulação dos modelos de negócios do TOTVS Linha Protheus.

Este serviço permite a utilização das regras de negócio (Model) baseadas em Submodelos, Estrutura de Dados e validações em código desenvolvidas pelas área de negócio, permitindo a sua reutilização em forma de serviços.

O Model é composto basicamente por Submodelos. Um SubModelo representa uma entidade e permite manipular registros.

Existem basicamente dois tipos de Submodelo, o formfield e o formgrid. O primeiro permite manipular somente um registro por vez e o segundo permite manipular vários registros ao mesmo tempo.

A regra de negócio pode definir os seguintes itens:

Submodelos de edição, tais como FormField(edição de apenas uma linha) e FormGrid(edição de várias linhas)
Regras de Dependência entre os Submodelos
Validação de Campos
Validação de Submodelo
Validação Geral
Persistência(gravação) dos dados
Estrutura de Dados para os submodelos

O Model é totalmente segregado, porém ele mantém todas as regras de negócio originais e permite as operações de Create,Read,Update e Delete.

Para maiores informações, consulte: aqui

O catálogo de serviços pode ser obtido em: /api/tss/fwmodel.catalog

For more details

FWRESTTRANSLATE

/FWRESTTRANSLATE/ [ GET ]

Description

API para retorno de traduções do sistema

For more details

ROLES

/ROLES/ [ GET_ROLES ]

Description

endpoint de Roles

For more details

ENTITLEMENTS

/ENTITLEMENTS/ [ POST ]

Description

API para definir direitos a recursos ao usuário (Company, Role e Menu)

For more details

GROUPS

/GROUPS/ [ GET ]

Description

O SCIM 'Groups' é um protocolo de aplicação REST, para provisionamento e gerenciamento de dados de identidade na web. O protocolo suporta a recuperação e descoberta de grupos.

For more details

RESOURCES

/RESOURCES/ [ DELETE GET POST PUT ]

Description

API para gerenciamento de recursos

For more details

SYNC

/SYNC/ [ GET ]

Description

Inicia sincronismo de Users e Resources

For more details

PING

/PING/ [ GET ]

Description

Retorna se o serviço SCIM esta disponível

For more details

USERS

/USERS/ [ DELETE GET POST PUT ]

Description

O SCIM 'Users' é um protocolo de aplicação REST, para provisionamento e gerenciamento de dados de identidade na web. O protocolo suporta a criação, modificação, recuperação e descoberta de usuários.

For more details

SERVICESCHEDULE

/SERVICESCHEDULE/ [ GET_READSERVICES PUT_STARTSERVICE ]

Description

Endpoint de serviços de execução do schedule

For more details

SHIFTF6

/SHIFTF6/ [ GET_SYSTEM ]

Description

serviço para fazer inventário dos recursos do ambiente

For more details

SMARTSCHEDAPI

/SMARTSCHEDAPI/ [ DELETE_SMARTSCHED GET_GETDEFPARAMS POST_SMARTSCHED PUT_SMARTSCHED ]

Description

endpoint do smartSchedule

For more details

SVCUSTOMSERVICE

/SVCUSTOMSERVICE/ [ DELETE_SVBYID GET_SVCUSTOM POST_SVCUSTOM ]

Description

API de controle da tabela de campos personalizados do Smart View

For more details

SYSTEMMODULES

/SYSTEMMODULES/ [ GET_ALL ]

Description

SystemModules é a representação dos módulos dos sistemas TOTVS que o usuário tem acesso.

For more details

TREPORTSCTLSERVICE

/TREPORTSCTLSERVICE/ [ DELETE_TREPBYID GET_TREPBYID POST_TREPCONTROLLER PUT_TREPCONTROLLER ]

Description

API de controle do de/para do Smart View

For more details

UPDATESLOG

/UPDATESLOG/ [ GET_ALL ]

Description

API dos logs de atualização do UPDDISTR no ambiente Protheus

For more details

UPDLOGREST

/UPDLOGREST/ [ GET_ALL ]

Description

API dos logs de atualização do UPDDISTR no ambiente Protheus

For more details

VIRTUALLOCKSERVICE

/VIRTUALLOCKSERVICE/ [ DELETE_VIRTUALLOCK POST_VIRTUALLOCK PUT_VIRTUALLOCK ]

Description

Api de Controle de Transações

For more details

ADDRESSBAN

/ADDRESSBAN/ [ DELETE GET_ALL POST PUT ]

Description

API para manutenção ambientes que devem ser banidos do Discovery

For more details

PROJECTSTAGE

/PROJECTSTAGE/ [ GET_ONE ]

Description

STR0001

For more details

DISCOVERYKEYS

/DISCOVERYKEYS/ [ GET_ALL ]

Description

API de chaves de configuração dos stages

For more details

DISCOVERYLOG

/DISCOVERYLOG/ [ GET_ALL ]

Description

API para consulta de logs de eventos do discovery

For more details

GENERICLIST

/GENERICLIST/ [ GET ]

Description

API para listagem genérica de alias do Protheus

For more details

PROJECTTRAIL

/PROJECTTRAIL/ [ DELETE GET_ALL POST PUT ]

Description

API para manutenção das trilhas de projetos que serão utilizadas pela gestão de projetos do Discovery

For more details

GENERICQUERY

/GENERICQUERY/ [ GET ]

Description

API para listagem genérica (query) de alias do Protheus

For more details

TABLESPACE

/TABLESPACE/ [ DELETE GET_ALL POST ]

Description

API para manutenção da configuração de tablespace do embedded audit trail

For more details

GENERICRECORDS

/GENERICRECORDS/ [ GET_MPVIEW ]

Description

Esta API irá retornar o resultado de uma consulta SQL cadastrada na base de dados (Consulta Genérica Relacional).

For more details

NFE

/NFE/ [ POST_DANFE ]

Description

Servicos de NFe

For more details

PERGUNTESERVICE

/PERGUNTESERVICE/ [ GET PUT_PERGUNTE ]

Description

API de Perguntes do Protheus

For more details

APINEWNFSE

/APINEWNFSE/ [ GET_MUNICIPIO POST_SETMUNICIPIO ]

Description

CRUD do portal da NEW NFS-e

For more details

SAML

/SAML/ [ GET ]

Description

SAML authentication for REST

For more details

DEFAULTS

/DEFAULTS/ [ GET POST ]

Description

Serviços genéricos do Protheus.

For more details

TSSAPIDOC

/TSSAPIDOC/ [ POST_RETORNADOC ]

Description

API para retorno de DANFE TSS

For more details

TSSAPIVOLUMETRIA

/TSSAPIVOLUMETRIA/ [ POST_CONSOLI ]

Description

API para consultar de documento processados no TSS consolidados.

For more details

/diagnosticCenter/v1/routine

[ GET ]

Syntax

/diagnosticCenter/v1/routine

Method

GET

/diagnosticCenter/v1/appserver

[ GET ]

Syntax

/diagnosticCenter/v1/appserver

Method

GET

/diagnosticCenter/v1/configdbms

[ GET ]

Syntax

/diagnosticCenter/v1/configdbms

Method

GET

/diagnosticCenter/v1/dbaccess

[ GET ]

Syntax

/diagnosticCenter/v1/dbaccess

Method

GET

/diagnosticCenter/v1/execblock/*

[ GET ]

Syntax

diagnosticCenter/v1/execblock/:code

Method

GET

/diagnosticCenter/v1/getisadmin

[ GET ]

Syntax

/diagnosticCenter/v1/getisadmin

Method

GET

/diagnosticCenter/v1/lib

[ GET ]

Syntax

/diagnosticCenter/v1/lib

Method

GET

/diagnosticCenter/v1/license

[ GET ]

Syntax

/diagnosticCenter/v1/license

Method

GET

/diagnosticCenter/v1/param/*

[ GET ]

Syntax

diagnosticCenter/v1/param/:code

Method

GET

/diagnosticCenter/v1/protheus

[ GET ]

Syntax

/diagnosticCenter/v1/protheus

Method

GET

/diagnosticCenter/v1/rpo

[ GET ]

Syntax

/diagnosticCenter/v1/rpo

Method

GET

/diagnosticCenter/v1/sllib

[ GET ]

Syntax

/diagnosticCenter/v1/sllib

Method

GET

/diagnosticCenter/v1/smartclient

[ GET ]

Syntax

/diagnosticCenter/v1/smartclient

Method

GET

/diagnosticCenter/v1/smartview

[ GET ]

Syntax

/diagnosticCenter/v1/smartview

Method

GET

/diagnosticCenter/v1/updateconfigdbms

[ GET ]

Syntax

/diagnosticCenter/v1/updateconfigdbms

Method

GET

/diagnosticCenter/v1/isadmin

[ POST ]

Syntax

/diagnosticCenter/v1/isadmin

Method

POST

/api/framework/getgroups

[ GET ]

Syntax

/api/framework/getgroups

Method

GET

/api/framework/v1/invalidateToken

[ POST ]

Syntax

/api/framework/v1/invalidateToken

Method

POST

/api/framework/v1/personalizationCatalog

[ GET ]

Syntax

/api/framework/v1/personalizationCatalog

Method

GET

/api/framework/v1/personalizationCatalog/*

[ GET ]

Syntax

api/framework/v1/personalizationCatalog/:function

Method

GET

/api/framework/v1/personalizationCatalog//

[ GET ]

Syntax

api/framework/v1/personalizationCatalog/:function/:type

Method

GET

/api/framework/v1/personalizationCatalog///*

[ GET ]

Syntax

api/framework/v1/personalizationCatalog/:function/:type/:branch

Method

GET

/api/framework/v1/personalizationCatalog/activate/*

[ PUT ]

Syntax

api/framework/v1/personalizationCatalog/activate/:function

Method

PUT

/api/framework/v1/personalizationCatalog/activate//

[ PUT ]

Syntax

api/framework/v1/personalizationCatalog/activate/:function/:type

Method

PUT

/api/framework/v1/personalizationCatalog/activate///*

[ PUT ]

Syntax

api/framework/v1/personalizationCatalog/activate/:function/:type/:branch

Method

PUT

/api/framework/v1/personalizationCatalog/deactivate/*

[ PUT ]

Syntax

api/framework/v1/personalizationCatalog/deactivate/:function

Method

PUT

/api/framework/v1/personalizationCatalog/deactivate//

[ PUT ]

Syntax

api/framework/v1/personalizationCatalog/deactivate/:function/:type

Method

PUT

/api/framework/v1/personalizationCatalog/deactivate///*

[ PUT ]

Syntax

api/framework/v1/personalizationCatalog/deactivate/:function/:type/:branch

Method

PUT

/api/framework/privileges/functions/groupDetail

[ GET ]

Syntax

/api/framework/privileges/functions/groupDetail

Method

GET

/api/framework/privileges/functions/groupMenuDef

[ GET ]

Syntax

/api/framework/privileges/functions/groupMenuDef

Method

GET

/api/framework/privileges/functions/groupMenuDefDetail

[ GET ]

Syntax

/api/framework/privileges/functions/groupMenuDefDetail

Method

GET

/api/framework/privileges/functions/groups

[ GET ]

Syntax

/api/framework/privileges/functions/groups

Method

GET

/api/framework/privileges/functions/privilege

[ GET ]

Syntax

/api/framework/privileges/functions/privilege

Method

GET

/api/framework/privileges/functions/privilegeLinked

[ GET ]

Syntax

/api/framework/privileges/functions/privilegeLinked

Method

GET

/api/framework/privileges/functions/privilegeMenuDef

[ GET ]

Syntax

/api/framework/privileges/functions/privilegeMenuDef

Method

GET

/api/framework/privileges/functions/userDetail

[ GET ]

Syntax

/api/framework/privileges/functions/userDetail

Method

GET

/api/framework/privileges/functions/userMenuDef

[ GET ]

Syntax

/api/framework/privileges/functions/userMenuDef

Method

GET

/api/framework/privileges/functions/userMenuDefDetail

[ GET ]

Syntax

/api/framework/privileges/functions/userMenuDefDetail

Method

GET

/api/framework/privileges/functions/users

[ GET ]

Syntax

/api/framework/privileges/functions/users

Method

GET

/api/framework/privileges/sanitation/menusWithPrivileges

[ GET ]

Syntax

/api/framework/privileges/sanitation/menusWithPrivileges

Method

GET

/api/framework/privileges/sanitation/totals

[ GET ]

Syntax

/api/framework/privileges/sanitation/totals

Method

GET

/api/framework/privileges/sanitation/usersWithoutPrivileges

[ GET ]

Syntax

/api/framework/privileges/sanitation/usersWithoutPrivileges

Method

GET

/api/framework/privileges/sanitation/usersWithPrivilegesExclusive

[ GET ]

Syntax

/api/framework/privileges/sanitation/usersWithPrivilegesExclusive

Method

GET

/api/framework/privileges/sanitation/usersWithPrivilegesOnProfile

[ GET ]

Syntax

/api/framework/privileges/sanitation/usersWithPrivilegesOnProfile

Method

GET

/api/framework/getRules

[ GET ]

Syntax

/api/framework/getRules

Method

GET

/.well-known/treports/security

[ GET ]

Syntax

/.well-known/treports/security

Method

GET

/api/framework/current-user

[ GET ]

Syntax

/api/framework/current-user

Method

GET

/api/framework/getusers

[ GET ]

Syntax

/api/framework/getusers

Method

GET

/api/framework/treports/integratedprovider/v1/businessobjectcustom

[ GET ]

Syntax

/api/framework/treports/integratedprovider/v1/businessobjectcustom

Method

GET

/api/framework/v1/FormOptimization/Template/*

[ PATCH DELETE GET PUT ]

Syntax

api/framework/v1/FormOptimization/Template/:templateId

Method

PATCH

DELETE

GET

PUT

/api/framework/v1/FormOptimization/Template//

[ PATCH ]

Syntax

api/framework/v1/FormOptimization/Template/:templateId/:companyGrp

Method

PATCH

/api/framework/v1/FormOptimization/ContainsRecords/*

[ GET ]

Syntax

api/framework/v1/FormOptimization/ContainsRecords/:templateCode

Method

GET

/api/v1/dictionary

[ GET ]

Syntax

/api/v1/dictionary

Method

GET

/api/v1/dictionary/*

[ GET ]

Syntax

api/v1/dictionary/:id

Method

GET

/api/v1/MPDocumentController/AddFiles

[ POST ]

Syntax

/api/v1/MPDocumentController/AddFiles

Method

POST

/api/v1/MPDocumentController/CheckFileExists

[ GET ]

Syntax

/api/v1/MPDocumentController/CheckFileExists

Method

GET

/api/v1/MPDocumentController/ModeDocument

[ GET ]

Syntax

/api/v1/MPDocumentController/ModeDocument

Method

GET

/api/framework/v1/FormOptimization/Eligible/*

[ GET ]

Syntax

api/framework/v1/FormOptimization/Eligible/:alias

Method

GET

/api/framework/v1/Dictionary/Fields

[ GET ]

Syntax

/api/framework/v1/Dictionary/Fields

Method

GET

/api/v1/fieldsindexes

[ GET ]

Syntax

/api/v1/fieldsindexes

Method

GET

/api/v1/fieldsindexes//

[ GET ]

Syntax

api/v1/fieldsindexes/:dictionary/:id

Method

GET

/api/framework/v1/FormOptimization/Triggers//

[ GET ]

Syntax

api/framework/v1/FormOptimization/Triggers/:type/:field

Method

GET

/api/framework/v1/FormOptimization/TriggersQuantity//

[ GET ]

Syntax

api/framework/v1/FormOptimization/TriggersQuantity/:/:field

Method

GET

/api/framework/v1/FormOptimization/FieldUsage/*

[ GET POST ]

Syntax

api/framework/v1/FormOptimization/FieldUsage/:alias

Method

GET

POST

/api/v1/groupfields

[ GET ]

Syntax

/api/v1/groupfields

Method

GET

/api/v1/groupfields//

[ GET ]

Syntax

api/v1/groupfields/:dictionary/:id

Method

GET

/api/v1/indexes

[ GET ]

Syntax

/api/v1/indexes

Method

GET

/api/v1/indexes/*

[ GET ]

Syntax

api/v1/indexes/:id

Method

GET

/api/v1/kind-dictionary

[ GET ]

Syntax

/api/v1/kind-dictionary

Method

GET

/api/v1/kind-dictionary/*

[ GET ]

Syntax

api/v1/kind-dictionary/:id

Method

GET

/api/v1/kind-pergunt

[ GET ]

Syntax

/api/v1/kind-pergunt

Method

GET

/api/v1/kind-pergunt/*

[ GET ]

Syntax

api/v1/kind-pergunt/:id

Method

GET

/api/framework/v1/FormOptimization/Routine

[ GET ]

Syntax

/api/framework/v1/FormOptimization/Routine

Method

GET

/api/framework/v1/FormOptimization/TemplateApplied/*

[ GET ]

Syntax

api/framework/v1/FormOptimization/TemplateApplied/:routine

Method

GET

/api/framework/v1/FormOptimization/Template

[ GET POST ]

Syntax

/api/framework/v1/FormOptimization/Template

Method

GET

POST

/api/framework/v1/FormOptimization/TemplateHead

[ GET ]

Syntax

/api/framework/v1/FormOptimization/TemplateHead

Method

GET

/api/framework/v1/FormOptimization/TemplateHead/*

[ GET ]

Syntax

api/framework/v1/FormOptimization/TemplateHead/:code

Method

GET

/api/v1/WizardDBTools/ListDictionary

[ GET ]

Syntax

/api/v1/WizardDBTools/ListDictionary

Method

GET

/api/v1/WizardDBTools/MyDatabaseConnection

[ GET ]

Syntax

/api/v1/WizardDBTools/MyDatabaseConnection

Method

GET

/api/v1/WizardDBTools/TestDatabaseConnection

[ GET ]

Syntax

/api/v1/WizardDBTools/TestDatabaseConnection

Method

GET

/api/framework/v1/FormOptimization/UsedInModules/*

[ GET ]

Syntax

api/framework/v1/FormOptimization/UsedInModules/:field

Method

GET

/api/framework/v1/FormOptimization/FieldProperties

[ GET ]

Syntax

/api/framework/v1/FormOptimization/FieldProperties

Method

GET

/api/framework/v1/FormOptimization/Indexes//

[ GET ]

Syntax

api/framework/v1/FormOptimization/Indexes/:table/:field

Method

GET

/api/framework/v1/FormOptimization/IndexesQuantity//

[ GET ]

Syntax

api/framework/v1/FormOptimization/IndexesQuantity/:table/:field

Method

GET

/api/framework/v1/FormOptimization/Relationships///*

[ GET ]

Syntax

api/framework/v1/FormOptimization/Relationships/:type/:table/:field

Method

GET

/api/framework/v1/FormOptimization/RelationshipsQuantity

[ GET ]

Syntax

/api/framework/v1/FormOptimization/RelationshipsQuantity

Method

GET

/api/framework/treports/integratedprovider/v1/searchobjects

[ GET ]

Syntax

/api/framework/treports/integratedprovider/v1/searchobjects

Method

GET

/api/framework/treports/integratedprovider/v1/getdata/*

[ POST ]

Syntax

api/framework/treports/integratedprovider/v1/getdata/:dataId

Method

POST

/.well-known/treports/connector

[ GET ]

Syntax

/.well-known/treports/connector

Method

GET

/api/framework/treports/integratedprovider/v1/getfilter///filter

[ GET ]

Syntax

api/framework/treports/integratedprovider/v1/getfilter/:schemaId/:filterId/filter

Method

GET

/api/framework/treports/integratedprovider/v1/schema/*

[ GET ]

Syntax

api/framework/treports/integratedprovider/v1/schema/:schemaId

Method

GET

/tlpp/healthcheck

[ GET ]

Syntax

/tlpp/healthcheck

Method

GET

/tlpp/healthcheck/datetime

[ GET ]

Syntax

/tlpp/healthcheck/datetime

Method

GET

/tlpp/healthcheck/ok

[ GET ]

Syntax

/tlpp/healthcheck/ok

Method

GET

/tlpp/dbaccessinfosapi/getgenericinfos

[ GET ]

Syntax

/tlpp/dbaccessinfosapi/getgenericinfos

Method

GET

/tlpp/dbaccessinfosapi/gettccheckupinfos

[ GET ]

Syntax

/tlpp/dbaccessinfosapi/gettccheckupinfos

Method

GET

/tlpp/dbaccessinfosapi/gettcpinginfos

[ GET ]

Syntax

/tlpp/dbaccessinfosapi/gettcpinginfos

Method

GET

/tlpp/dbaccesstcgetinfoapi/getslotreturn

[ GET ]

Syntax

/tlpp/dbaccesstcgetinfoapi/getslotreturn

Method

GET

/rest/clf/swagger

[ GET ]

Syntax

/rest/clf/swagger

Method

GET

/appserver/buildDate

[ GET ]

Syntax

/appserver/buildDate

Method

GET

/appserver/buildTime

[ GET ]

Syntax

/appserver/buildTime

Method

GET

/appserver/environment

[ GET ]

Syntax

/appserver/environment

Method

GET

/appserver/revision

[ GET ]

Syntax

/appserver/revision

Method

GET

/appserver/VdrRevision

[ GET ]

Syntax

/appserver/VdrRevision

Method

GET

/appserver/version

[ GET ]

Syntax

/appserver/version

Method

GET

/appserver/versionName

[ GET ]

Syntax

/appserver/versionName

Method

GET

/tlpp/sourceRevision

[ GET ]

Syntax

/tlpp/sourceRevision

Method

GET

/tlpp/sourceRevisionDate

[ GET ]

Syntax

/tlpp/sourceRevisionDate

Method

GET

/tlpp/environment

[ GET ]

Syntax

/tlpp/environment

Method

GET

/tlpp/version

[ GET ]

Syntax

/tlpp/version

Method

GET

/tlpp/versionName

[ GET ]

Syntax

/tlpp/versionName

Method

GET

/tlpp/versionNumber

[ GET ]

Syntax

/tlpp/versionNumber

Method

GET

/totvs/environment

[ GET ]

Syntax

/totvs/environment

Method

GET

/tlpp/managerDBAccess/dbaccessconnect

[ GET ]

Syntax

/tlpp/managerDBAccess/dbaccessconnect

Method

GET

/tlpp/oauth2/token

[ POST GET ]

Syntax

/tlpp/oauth2/token

Method

POST

GET

/tlpp/probat/discovery

[ GET ]

Syntax

/tlpp/probat/discovery

Method

GET

/tlpp/probat/export

[ GET ]

Syntax

/tlpp/probat/export

Method

GET

/tlpp/rest/usage/time

[ GET ]

Syntax

/tlpp/rest/usage/time

Method

GET

/tlpp/rest/config

[ GET ]

Syntax

/tlpp/rest/config

Method

GET

/tlpp/getFiles

[ GET ]

Syntax

/tlpp/getFiles

Method

GET

/tlpp/rest/list/service

[ GET ]

Syntax

/tlpp/rest/list/service

Method

GET

/tlpp/gui/authentication/getloginstatus

[ GET ]

Syntax

/tlpp/gui/authentication/getloginstatus

Method

GET

/tlpp/gui/authentication

[ POST ]

Syntax

/tlpp/gui/authentication

Method

POST

/tlpp/environments/getEnvironments

[ GET ]

Syntax

/tlpp/environments/getEnvironments

Method

GET

/tlpp/gui/config

[ GET ]

Syntax

/tlpp/gui/config

Method

GET

/tlpp/gui/bt/list

[ GET ]

Syntax

/tlpp/gui/bt/list

Method

GET

/tlpp/gui/bt/quantity

[ GET ]

Syntax

/tlpp/gui/bt/quantity

Method

GET

/tlpp/gui/cg/list

[ GET ]

Syntax

/tlpp/gui/cg/list

Method

GET

/tlpp/gui/ec/list

[ GET ]

Syntax

/tlpp/gui/ec/list

Method

GET

/tlpp/rest/get/documentation

[ POST ]

Syntax

/tlpp/rest/get/documentation

Method

POST

Path	https://totvstransmitetss-protheus.totvscloud.com.br:8079/api/tss
Services	200

TOTVS - RESTFul API

API's List

COMPANIES /COMPANIES/ [ GET_COMPANIES ]

Description

BRANCHES /BRANCHES/ [ GET_BRANCH ]

Description

TOKEN /TOKEN/ [ POST ]

Description

MENUS /MENUS/ [ GET_ALL ]

Description

SYSTEMPARAMETERS /SYSTEMPARAMETERS/ [ DELETE GET_ALL POST PUT ]

Description

VALCNABATI /VALCNABATI/ [ GET ]

Description

LEARQCONFIG /LEARQCONFIG/ [ GET ]

Description

CHANGEPASSWORDUSERSERVICE /CHANGEPASSWORDUSERSERVICE/ [ GET POST ]

Description

COMPANIESTSS /COMPANIESTSS/ [ GET_COMPANIES POST_CONFIG ]

Description

DISCOVERYPKGMAN /DISCOVERYPKGMAN/ [ GET_APPLY PUT_CREATE ]

Description

TOTVSEAI /TOTVSEAI/ [ DELETE_FILTER GET_APPS POST_APPSCONF PUT_FILTER ]

Description

ACCESSPRIVILEGESSERVICES /ACCESSPRIVILEGESSERVICES/ [ GET_ALIASACCESS ]

Description

AGENTSCHEDULE /AGENTSCHEDULE/ [ DELETE_AGENTSCHEDULE GET_AGENTSCHEDULE POST_AGENTSCHEDULE PUT_AGENTSCHEDULE ]

Description

FWATTRESTLOG /FWATTRESTLOG/ [ GET ]

Description

BASICPROTHEUSSERVICES /BASICPROTHEUSSERVICES/ [ GET_DBSTRUCT ]

Description

DBDATAPROVIDERS /DBDATAPROVIDERS/ [ GET_PARAMETERS POST_GETDATA ]

Description

DISCOVERYENVEXCLUSIVE /DISCOVERYENVEXCLUSIVE/ [ GET_ALL ]

Description

DISCOVERYENVIRONMENTS /DISCOVERYENVIRONMENTS/ [ DELETE GET_ALL POST PUT ]

Description

DISCOVERYSTAGES /DISCOVERYSTAGES/ [ DELETE GET_ALL POST PUT ]

Description

EAISCHEDULE /EAISCHEDULE/ [ GET_EAISCHEDULE PUT_EAIBLOCKTRANS ]

Description

SMARTSCHEDEXEC /SMARTSCHEDEXEC/ [ DELETE_SCHEXECDELETE GET_SMARTALLEXECLIST POST_EXECUTESMARTSCHED ]

Description

BRAND /BRAND/ [ GET ]

Description

LANGUAGE /LANGUAGE/ [ GET ]

Description

HEALTHCHECK /HEALTHCHECK/ [ GET_SIMPLE ]

Description

JOBEXECUTION /JOBEXECUTION/ [ GET_EXECLIST ]

Description

JOBSCHEDULER /JOBSCHEDULER/ [ DELETE_SCHED GET_ID_SCHD POST_SCHED PUT_SCHED ]

Description

JWKS /JWKS/ [ GET ]

Description

FWJWT /FWJWT/ [ POST ]

Description

DISCOVERYLOGOPERATION /DISCOVERYLOGOPERATION/ [ GET_ALL ]

Description

OAUTHCALLBACK /OAUTHCALLBACK/ [ GET ]

Description

OAUTH /OAUTH/ [ GET POST ]

Description

PROFILESERVICE /PROFILESERVICE/ [ DELETE_PROFILE GET_PROFILE POST_PROFILE PUT_PROFILE ]

Description

PROJECTINFOENV /PROJECTINFOENV/ [ GET_ALL POST_CREATEPACK ]

Description

QS /QS/ [ GET ]

Description

CHECK_SECURITY /CHECK_SECURITY/ [ GET ]

Description

DISCOVERY /DISCOVERY/ [ DELETE_ENVIRONMENTS GET_CONFIGGET POST_AUTHENTICATION ]

Description

FWMODEL /FWMODEL/ [ DELETE GET POST PUT ]

Description

FWRESTTRANSLATE /FWRESTTRANSLATE/ [ GET ]

Description

ROLES /ROLES/ [ GET_ROLES ]

Description

COMPANIES

/COMPANIES/ [ GET_COMPANIES ]

BRANCHES

/BRANCHES/ [ GET_BRANCH ]

TOKEN

/TOKEN/ [ POST ]

MENUS

/MENUS/ [ GET_ALL ]

SYSTEMPARAMETERS

/SYSTEMPARAMETERS/ [ DELETE GET_ALL POST PUT ]

VALCNABATI

/VALCNABATI/ [ GET ]

LEARQCONFIG

/LEARQCONFIG/ [ GET ]

CHANGEPASSWORDUSERSERVICE

/CHANGEPASSWORDUSERSERVICE/ [ GET POST ]

COMPANIESTSS

/COMPANIESTSS/ [ GET_COMPANIES POST_CONFIG ]

DISCOVERYPKGMAN

/DISCOVERYPKGMAN/ [ GET_APPLY PUT_CREATE ]

TOTVSEAI

/TOTVSEAI/ [ DELETE_FILTER GET_APPS POST_APPSCONF PUT_FILTER ]

ACCESSPRIVILEGESSERVICES

/ACCESSPRIVILEGESSERVICES/ [ GET_ALIASACCESS ]

AGENTSCHEDULE

/AGENTSCHEDULE/ [ DELETE_AGENTSCHEDULE GET_AGENTSCHEDULE POST_AGENTSCHEDULE PUT_AGENTSCHEDULE ]

FWATTRESTLOG

/FWATTRESTLOG/ [ GET ]

BASICPROTHEUSSERVICES

/BASICPROTHEUSSERVICES/ [ GET_DBSTRUCT ]

DBDATAPROVIDERS

/DBDATAPROVIDERS/ [ GET_PARAMETERS POST_GETDATA ]

DISCOVERYENVEXCLUSIVE

/DISCOVERYENVEXCLUSIVE/ [ GET_ALL ]

DISCOVERYENVIRONMENTS

/DISCOVERYENVIRONMENTS/ [ DELETE GET_ALL POST PUT ]

DISCOVERYSTAGES

/DISCOVERYSTAGES/ [ DELETE GET_ALL POST PUT ]

EAISCHEDULE

/EAISCHEDULE/ [ GET_EAISCHEDULE PUT_EAIBLOCKTRANS ]

SMARTSCHEDEXEC

/SMARTSCHEDEXEC/ [ DELETE_SCHEXECDELETE GET_SMARTALLEXECLIST POST_EXECUTESMARTSCHED ]

BRAND

/BRAND/ [ GET ]

LANGUAGE

/LANGUAGE/ [ GET ]

HEALTHCHECK

/HEALTHCHECK/ [ GET_SIMPLE ]

JOBEXECUTION

/JOBEXECUTION/ [ GET_EXECLIST ]

JOBSCHEDULER

/JOBSCHEDULER/ [ DELETE_SCHED GET_ID_SCHD POST_SCHED PUT_SCHED ]

JWKS

/JWKS/ [ GET ]

FWJWT

/FWJWT/ [ POST ]

DISCOVERYLOGOPERATION

/DISCOVERYLOGOPERATION/ [ GET_ALL ]

OAUTHCALLBACK

/OAUTHCALLBACK/ [ GET ]

OAUTH

/OAUTH/ [ GET POST ]

PROFILESERVICE

/PROFILESERVICE/ [ DELETE_PROFILE GET_PROFILE POST_PROFILE PUT_PROFILE ]

PROJECTINFOENV

/PROJECTINFOENV/ [ GET_ALL POST_CREATEPACK ]

QS

/QS/ [ GET ]

CHECK_SECURITY

/CHECK_SECURITY/ [ GET ]

DISCOVERY

/DISCOVERY/ [ DELETE_ENVIRONMENTS GET_CONFIGGET POST_AUTHENTICATION ]

FWMODEL

/FWMODEL/ [ DELETE GET POST PUT ]

FWRESTTRANSLATE

/FWRESTTRANSLATE/ [ GET ]

ROLES

/ROLES/ [ GET_ROLES ]

ENTITLEMENTS

/ENTITLEMENTS/ [ POST ]

GROUPS

/GROUPS/ [ GET ]

RESOURCES

/RESOURCES/ [ DELETE GET POST PUT ]

SYNC

/SYNC/ [ GET ]

PING

/PING/ [ GET ]

USERS

/USERS/ [ DELETE GET POST PUT ]

SERVICESCHEDULE

/SERVICESCHEDULE/ [ GET_READSERVICES PUT_STARTSERVICE ]

SHIFTF6

/SHIFTF6/ [ GET_SYSTEM ]

SMARTSCHEDAPI

/SMARTSCHEDAPI/ [ DELETE_SMARTSCHED GET_GETDEFPARAMS POST_SMARTSCHED PUT_SMARTSCHED ]

SVCUSTOMSERVICE

/SVCUSTOMSERVICE/ [ DELETE_SVBYID GET_SVCUSTOM POST_SVCUSTOM ]

SYSTEMMODULES

/SYSTEMMODULES/ [ GET_ALL ]

TREPORTSCTLSERVICE

/TREPORTSCTLSERVICE/ [ DELETE_TREPBYID GET_TREPBYID POST_TREPCONTROLLER PUT_TREPCONTROLLER ]

UPDATESLOG

/UPDATESLOG/ [ GET_ALL ]

UPDLOGREST

/UPDLOGREST/ [ GET_ALL ]

VIRTUALLOCKSERVICE

/VIRTUALLOCKSERVICE/ [ DELETE_VIRTUALLOCK POST_VIRTUALLOCK PUT_VIRTUALLOCK ]

ADDRESSBAN

/ADDRESSBAN/ [ DELETE GET_ALL POST PUT ]

PROJECTSTAGE

/PROJECTSTAGE/ [ GET_ONE ]

DISCOVERYKEYS

/DISCOVERYKEYS/ [ GET_ALL ]

DISCOVERYLOG

/DISCOVERYLOG/ [ GET_ALL ]

GENERICLIST

/GENERICLIST/ [ GET ]

PROJECTTRAIL

/PROJECTTRAIL/ [ DELETE GET_ALL POST PUT ]

GENERICQUERY

/GENERICQUERY/ [ GET ]

TABLESPACE

/TABLESPACE/ [ DELETE GET_ALL POST ]

GENERICRECORDS

/GENERICRECORDS/ [ GET_MPVIEW ]

NFE

/NFE/ [ POST_DANFE ]

PERGUNTESERVICE

/PERGUNTESERVICE/ [ GET PUT_PERGUNTE ]

APINEWNFSE

/APINEWNFSE/ [ GET_MUNICIPIO POST_SETMUNICIPIO ]

SAML

/SAML/ [ GET ]

DEFAULTS

/DEFAULTS/ [ GET POST ]

TSSAPIDOC

/TSSAPIDOC/ [ POST_RETORNADOC ]

TSSAPIVOLUMETRIA

/TSSAPIVOLUMETRIA/ [ POST_CONSOLI ]

/diagnosticCenter/v1/routine

[ GET ]

/diagnosticCenter/v1/appserver

[ GET ]

/diagnosticCenter/v1/configdbms

[ GET ]