Frameworksp

Páginas filhas
  • BasicProtheusServices

Descrição:

API para uso geral no Protheus, tendo as principais funções utilizadas.

Utilização da API

É necessário ligar a segurança do socket do rest para a utilização dessa api (chave SECURITY=1)


xfilial

Descrição:
Retorna a filial do alias informado


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/xfilial?alias=se5,se1,se2,sed,sa1,sa2,sra,ct0,ct2,sf2,sa6,se6

Exemplo de retorno
{
	"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 "
}


retsqlname

Descrição:
Retorna o nome real da tabela do alias informado


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/retsqlname?alias=se5,se1,se2,sb1,sa1,sa2

Exemplo de retorno
{
	"SE1": "SE1T10",
	"SE2": "SE2T10",
	"SA2": "SA2T10",
	"SA1": "SA1T10",
	"SE5": "SE5T10",
	"SB1": "SB1T10"
}


dbstruct

Descrição:
Retorna a estrutura do alias informado conforme presente no banco de dados (workarea)


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/dbstruct?alias=se5,SA1

Exemplo de retorno
{
	"SA1": [
		[
			"A1_FILIAL",
			"C",
			8,
			0
		],
		[
			"A1_COD",
			"C",
			6,
			0
		],
		[
			"A1_LOJA",
			"C",
			2,
			0
		],
	]
}


fwmodeaccess

Descrição:
Retorna o compartilhamento do alias informado


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/fwmodeaccess?alias=SA1,se5

Exemplo de retorno
{
	"SA1": {
		"businessUnit": "E",
		"branch": "C",
		"company": "E"
	},
	"SE5": {
		"businessUnit": "E",
		"branch": "E",
		"company": "E"
	}
}


fwsx2util-getx2name

Descrição:
Retorna o título do alias informado


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/fwsx2util-getx2name?alias=se5,SA1,sa2,sed,sb1

Exemplo de retorno
{
	"SA1": "Clientes",
	"SA2": "Fornecedores",
	"SE5": "Movimentação Bancaria",
	"SB1": "Descrição Genérica do Produto",
	"SED": "Naturezas"
}


fwaliasindic

Descrição:
Retorna se o alias existe no dicionário de dados


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/fwaliasindic?alias=se5,SA1,sed,sB1

Exemplo de retorno
{
	"SA1": true,
	"SE5": true,
	"SB1": true,
	"SED": true
}


fwsixutil-getaliasindexes

Descrição:
Retorna os índices do alias informado


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/fwsixutil-getaliasindexes?alias=SA1,sa2,sed,sb1

Exemplo de retorno
{
	"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"
		],
	]
}


fwprotecteddatautil-usrnoaccessfieldsinlist

Descrição:
Retorna os campos que o usuário não pode acessar do alias informado conforme os dados protegidos


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/fwprotecteddatautil-usrnoaccessfieldsinlist?alias=SED

Exemplo de retorno
{
	"SED": []
}


fwprotecteddatautil-usraccesspdfield

Descrição:
Retorna os campos que o usuário pode acessar do alias informado conforme os dados protegidos


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/fwprotecteddatautil-usraccesspdfield?alias=SED,SA1

Exemplo de retorno
{
	"SA1": [
		"A1_NREDUZ ",
		"A1_PAGATR ",
		"A1_BAIRROC",
		"A1_COMPENT",
		"A1_BAIRROE",
	],
	"SED": [
		"ED_FILIAL",
		"ED_CODIGO",
		"ED_DESCRIC",
	]
}


versenha

Descrição:
Retorna o acesso do usuário conforme o do número recebido


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AcessoStringIndica o acesso que será avaliado, podendo receber mais de um acesso, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/versenha?acesso=120,102,198

Exemplo de retorno
{
	"195": true,
	"198": true,
	"120": true,
	"102": true
}


fwformstructview

Descrição:
Retorna a estrutura da view (MVC) do alias informado


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias que será avaliado, podendo receber mais de um alias, separado por vírgulaX
Exemplos de uso

api/framework/v1/basicProtheusServices/fwformstructview?alias=SED,SB1

Exemplo de retorno
{
	"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"
			}
		]
	}
}

Features

Foram adicionados ao retorno os campos browse e required. Os mesmos só estarão disponíveis na LIB 20230109 ou superior