API para uso geral no Protheus, tendo as principais funções utilizadas.
É necessário ligar a segurança do socket do rest para a utilização dessa api (chave SECURITY=1) |
Descrição:
Retorna a filial do alias informado
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/xfilial?alias=se5,se1,se2,sed,sa1,sa2,sra,ct0,ct2,sf2,sa6,se6 |
{
"SE1": "D MG 01 ",
"SE2": "D MG 01 ",
"SA2": "D MG ",
"SA1": "D MG ",
"SE5": "D MG 01 ",
"SA6": "D MG ",
"SRA": "D MG 01 ",
"SE6": "D MG 01 ",
"CT0": "D MG ",
"CT2": "D MG 01 ",
"SF2": "D MG 01 ",
"SED": "D MG 01 "
} |
Descrição:
Retorna o nome real da tabela do alias informado
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/retsqlname?alias=se5,se1,se2,sb1,sa1,sa2 |
{
"SE1": "SE1T10",
"SE2": "SE2T10",
"SA2": "SA2T10",
"SA1": "SA1T10",
"SE5": "SE5T10",
"SB1": "SB1T10"
} |
Descrição:
Retorna a estrutura do alias informado conforme presente no banco de dados (workarea)
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/dbstruct?alias=se5,SA1 |
{
"SA1": [
[
"A1_FILIAL",
"C",
8,
0
],
[
"A1_COD",
"C",
6,
0
],
[
"A1_LOJA",
"C",
2,
0
],
]
} |
Descrição:
Retorna o compartilhamento do alias informado
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/fwmodeaccess?alias=SA1,se5 |
{
"SA1": {
"businessUnit": "E",
"branch": "C",
"company": "E"
},
"SE5": {
"businessUnit": "E",
"branch": "E",
"company": "E"
}
} |
Descrição:
Retorna o título do alias informado
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/fwsx2util-getx2name?alias=se5,SA1,sa2,sed,sb1 |
{
"SA1": "Clientes",
"SA2": "Fornecedores",
"SE5": "Movimentação Bancaria",
"SB1": "Descrição Genérica do Produto",
"SED": "Naturezas"
} |
Descrição:
Retorna se o alias existe no dicionário de dados
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/fwaliasindic?alias=se5,SA1,sed,sB1 |
{
"SA1": true,
"SE5": true,
"SB1": true,
"SED": true
} |
Descrição:
Retorna os índices do alias informado
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/fwsixutil-getaliasindexes?alias=SA1,sa2,sed,sb1 |
{
"SA1": [
[
"A1_FILIAL",
"A1_COD",
"A1_LOJA"
],
[
"A1_FILIAL",
"A1_NOME",
"A1_LOJA"
],
],
"SA2": [
[
"A2_FILIAL",
"A2_COD",
"A2_LOJA"
],
[
"A2_FILIAL",
"A2_NOME",
"A2_LOJA"
],
],
"SB1": [
[
"B1_FILIAL",
"B1_COD"
],
[
"B1_FILIAL",
"B1_TIPO",
"B1_COD"
],
],
"SED": [
[
"ED_FILIAL",
"ED_CODIGO"
],
[
"ED_FILIAL",
"ED_PAI",
"ED_CODIGO"
],
]
} |
Descrição:
Retorna os campos que o usuário não pode acessar do alias informado conforme os dados protegidos
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/fwprotecteddatautil-usrnoaccessfieldsinlist?alias=SED |
{
"SED": []
} |
Descrição:
Retorna os campos que o usuário pode acessar do alias informado conforme os dados protegidos
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/fwprotecteddatautil-usraccesspdfield?alias=SED,SA1 |
{
"SA1": [
"A1_NREDUZ ",
"A1_PAGATR ",
"A1_BAIRROC",
"A1_COMPENT",
"A1_BAIRROE",
],
"SED": [
"ED_FILIAL",
"ED_CODIGO",
"ED_DESCRIC",
]
} |
Descrição:
Retorna o acesso do usuário conforme o do número recebido
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Acesso | String | Indica o acesso que será avaliado, podendo receber mais de um acesso, separado por vírgula | X |
api/framework/v1/basicProtheusServices/versenha?acesso=120,102,198 |
{
"195": true,
"198": true,
"120": true,
"102": true
} |
Descrição:
Retorna a estrutura da view (MVC) do alias informado
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Valor padrão |
|---|---|---|---|---|
| Alias | String | Indica o alias que será avaliado, podendo receber mais de um alias, separado por vírgula | X |
api/framework/v1/basicProtheusServices/fwformstructview?alias=SED,SB1 |
{
"SB1": {
"fields": [
{
"group": "",
"order": "02",
"folder": "1",
"field": "B1_COD",
"title": "Codigo",
"type": "C",
"combobox": [],
"size": 30,
"virtual": false,
"protectedData": false,
"userField": false,
"picture": "@!",
"canChange": true,
"decimal": 0,
"description": "Codigo do Produto"
},
],
"groups": [],
"folders": [
{
"title": "Cadastrais",
"id": "1"
},
{
"title": "Impostos",
"id": "2"
},
{
"title": "MRP / Suprimentos",
"id": "3"
},
{
"title": "C.Q.",
"id": "4"
},
{
"title": "Atendimento",
"id": "5"
},
{
"title": "Direitos autorais",
"id": "6"
},
{
"title": "Mat / Med",
"id": "7"
},
{
"title": "Garantia Estendida",
"id": "8"
}
]
},
"SED": {
"fields": [
{
"group": "",
"order": "02",
"folder": "1",
"field": "ED_CODIGO",
"title": "Codigo",
"type": "C",
"combobox": [],
"size": 10,
"virtual": false,
"protectedData": false,
"userField": false,
"picture": "@!",
"canChange": true,
"decimal": 0,
"description": "Codigo da Natureza"
},
],
"groups": [],
"folders": [
{
"title": "Dados da Natureza",
"id": "1"
},
{
"title": "Impostos",
"id": "2"
},
{
"title": "Fiscal",
"id": "3"
},
{
"title": "Jurídico",
"id": "4"
},
{
"title": "Dados Contábeis",
"id": "5"
}
]
}
} |
|
Descrição:
Retorna informações adicionais do usuário autenticado pela api
(disponível a partir da lib 20230626)
Parâmetros:
Será utilizado o usuário autenticado, api não possui parâmetros a serem passados.
api/framework/v1/basicProtheusServices/pswret |
{
"user_id": "000000",
"user_name": "Administrador",
"user_full_name": "Administrador",
"expiration_date": "00/00/00",
"number_of_days_to_expire": 999,
"authorization_to_change_the_password": true,
"change_password_at_next_logon": false,
"groups_array": [
"000000"
],
"superiors": "",
"department": "",
"position": "",
"email": "[email protected]",
"number_of_simultaneous_accesses": 99,
"date_of_last_change": "2022/07/04",
"user_blocked": false,
"number_of_digits_for_the_year": 4,
"listener_for_calls": false,
"extension": "",
"operation_log": "",
"company_branch_and_registration": "",
"allow_changing_system_database": true,
"days_to_go_back": 0,
"days_to_go_forward": 0,
"date_of_inclusion_in_the_system": "2015/08/28",
"global_field_level": 5,
"access_times": [
"00:00|23:59",
"00:00|23:59",
"00:00|23:59",
"00:00|23:59",
"00:00|23:59",
"00:00|23:59",
"00:00|23:59"
],
"path_for_disk_printing": "\\SPOOL\\",
"driver_for_direct_port_printing": "EPSON.DRV",
"accesses": "SSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSNSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSNNNNNNNNNNSNSNNSNNSNSSNNSSSSSSSSNNNNNSSSSNNNSSSSSSSSSSSNNNNNNSNNNSNNSSSSSSSSSNNSSSNSSSSSSSSSSSSNSSNNSSNSSSSNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN",
"companies_array": [
"@@@@"
],
"pe_useracs": "",
"print_type": 1,
"page_format": 1,
"environment_type": 1,
"prioritize_group_configuration": false,
"print_option": "",
"access_other_print_directories": false,
"modules_array": [
"015\\system\\SIGAATF.XNU",
"025\\system\\SIGACOM.XNU",
"035\\system\\SIGACON.xnu",
"045\\system\\SIGAEST.XNU",
"055SIGAFAT",
"065\\system\\SIGAFIN.XNU",
"075\\system\\SIGAGPE.XNU",
"085\\system\\SIGAFAS.xnu",
"095\\system\\SIGAFIS.XNU",
"105\\system\\SIGAPCP.XNU",
"115\\system\\SIGAVEI.XNU",
"125\\system\\SIGALOJA.XNU",
"135\\system\\SIGATMK.XNU",
"145\\system\\SIGAOFI.XNU",
"155\\system\\SIGARPM.xnu",
"165\\system\\SIGAPON.XNU",
"175\\system\\SIGAEIC.XNU",
"185\\system\\SIGATCF.XNU",
"195\\system\\SIGAMNT.XNU",
"205\\system\\SIGARSP.XNU",
"215\\system\\SIGAQIE.XNU",
"225\\system\\SIGAQMT.XNU",
"235\\system\\SIGAFRT.XNU",
"245\\system\\SIGAQDO.XNU",
"255\\system\\SIGAQIP.XNU",
"265\\system\\SIGATRM.XNU",
"275\\system\\SIGAEIF.xnu",
"285\\system\\SIGATEC.XNU",
"295\\system\\SIGAEEC.XNU",
"305\\system\\SIGAEFF.XNU",
"315\\system\\SIGAECO.XNU",
"325\\system\\SIGAAFV.xnu",
"335\\system\\SIGAPLS.XNU",
"345\\system\\SIGACTB.XNU",
"355\\system\\SIGAMDT.XNU",
"365\\system\\SIGAQNC.XNU",
"375\\system\\SIGAQAD.XNU",
"385\\system\\SIGAQCP.xnu",
"395\\system\\SIGAOMS.XNU",
"405\\system\\SIGACSA.XNU",
"415\\system\\SIGAPEC.XNU",
"425\\system\\SIGAWMS.XNU",
"435\\system\\SIGATMS.XNU",
"445\\system\\SIGAPMS.XNU",
"455\\system\\SIGACDA.XNU",
"465\\system\\SIGAACD.XNU",
"475\\system\\SIGAPPAP.XNU",
"485\\system\\SIGAREP.XNU",
"495\\system\\SIGAGE.XNU",
"505\\system\\SIGAEDC.XNU",
"515\\system\\SIGAHSP.XNU",
"525\\system\\SIGAVDOC.xnu",
"535\\system\\SIGAAPD.XNU",
"545\\system\\SIGAGSP.XNU",
"555\\system\\SIGACRD.XNU",
"565\\system\\SIGASGA.XNU",
"575\\system\\SIGAPCO.XNU",
"585\\system\\SIGAGPR.XNU",
"595\\system\\SIGAGAC.XNU",
"605\\system\\SIGAPRA.XNU",
"615\\system\\SIGAHGP.xnu",
"625\\system\\SIGAHHG.xnu",
"635\\system\\SIGAHPL.xnu",
"645\\system\\SIGAAPT.XNU",
"655\\system\\SIGAGAV.XNU",
"665\\system\\SIGAICE.XNU",
"675\\system\\SIGAAGR.XNU",
"685\\system\\SIGAARM.xnu",
"695\\system\\SIGAGCT.XNU",
"705\\system\\SIGAORG.XNU",
"715\\system\\SIGALVE.xnu",
"725\\system\\SIGAPHOTO.XNU",
"735\\system\\SIGACRM.XNU",
"745\\system\\SIGABPM.XNU",
"755\\system\\SIGAAPON.xnu",
"765\\system\\SIGAJURI.XNU",
"775\\system\\SIGAPFS.XNU",
"785\\system\\SIGAGFE.XNU",
"795\\system\\SIGASFC.XNU",
"805\\system\\SIGAACV.xnu",
"815\\system\\SIGALOG.xnu",
"825\\system\\SIGADPR.XNU",
"835\\system\\SIGAVPON.xnu",
"845\\system\\SIGATAF.XNU",
"855\\system\\SIGAESS.XNU",
"865\\system\\SIGAVDF.XNU",
"875\\system\\SIGAGCP.XNU",
"885\\system\\SIGAGTP.xnu",
"895\\system\\SIGATUR.xnu",
"905\\system\\SIGAGCV.xnu",
"915\\system\\SIGAPDS.XNU",
"92X\\system\\SIGATFL.XNU",
"93X\\system\\SIGACEN.XNU",
"94X",
"95X",
"965\\system\\SIGAESP2.xnu",
"975SIGAESP",
"985\\system\\SIGAESP1.xnu",
"995\\system\\SIGACFG.XNU"
]
} |
<style>
div.theme-default .ia-splitter #main {
margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
display: none;
}
#main {
padding-left: 10px;
padding-right: 10px;
overflow-x: hidden;
}
.aui-header-primary .aui-nav, .aui-page-panel {
margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
margin-left: 0px !important;
}
</style>
|