Histórico da Página

...

Visão Geral
GET Rota
1. Descrição do Método:
2. Parâmetros
3. Códigos de Resposta
4. Tratamento de Erros
5. Segurança
6. Exemplos
7. Recomendações de Uso
8. Referências e Links Relacionados
POST Rota
1. Parametros
2. Retorno
3. Exemplo de utilizacao
PUT Rota
1. Parametros
2. Retorno
3. Exemplo de utilizacao
DELETE Rota
1. Parametros
2. Retorno
3. Exemplo de utilizacao

01. VISÃO GERAL

GET /rota/assets/{asset}/{item}

02. GET /api/bo-ba/v1/insights/stock/rupturealert

Descrição do Método

Retorna os dados do insight RuptureAlerts, filtrados pela Empresa/Filial que o usuário tem acesso. As filiais que o usuário tem acecsso são determinadas pelos grupos do usuário, e se o mesmo não pertencera nenhum grupo, as que foram associadas no cadastro de usuárioRetorna os detalhes de um ativo identificado pelos parâmetros asset e item na url.

Parâmetros

Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".são mandatórios, e devem ser passados via queryParams.

Parâmetro	Tipo	Descrição

Valor Default

cUserId

fieldsstringLista de campos (separados por vírgula) que devem ser retornados.-languagestringIndica o formato que os labels dos campos solicitados devem ser retornados. Só são aceitos os valores: 'pt' para português, 'en' para inglês e 'es' para espanhol'pt'

...

String	Id do usuário Protheus (cUserId)
cComGrp	String	Código da empresa logada (cEmpAnt)
cBranch	String	Código da fililal logada (cFilAnt)

Códigos de Resposta

O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.

Com o código HTTP 200.

Propriedade	Tipo	Descrição	Adicional

locationObjectObjeto indicando a localização do ativo

Caso o ativo esteja sem localização cadastrada, retornar null.


branchs	string	Código da filial
company	string	Código da empresa
coduser	string	Código do usuário
sessionId	string	Id da sessão ativa
items	Object	Objeto container dos alerts
items.tenantid	string	Tenant Id da Filial.
items.alerts	Array	Array com os dados do insight, por item
items.alerts.accuracy	number	Percentual de acurácia do insight
items.alerts.branch	string	Código da Filial
items.alerts

location.latnumberLatitude da localização do ativolocation.lngnumberLongitude da localização do ativolocation.local

.code

string

Localização do ativo no sistema (código do N1_LOCAL)

Código do produto
items.alerts.company_group	string
items.alerts.desc_espec	string
items.alerts

location.local

.description

string

Descrição

da localização do ativo no sistema (NL_DESCRIC)imagebooleanoindicador se o ativo possui ou não uma imagem cadastrada no sistema

do produto.
items.alerts.forecast_value	number
items.alerts.frequency	string	D-Diário M-Mensal S-Semanal
items.alerts.graphPoints	array	Array com os pontos do gráfico.
items.alerts.graphPoints.code	string	Código do produto
items.alerts.graphPoints.final_reference_date	datetime
items.alerts.graphPoints.frequency	string	D-Diário M-Mensal S-Semanal
items.alerts.graphPoints.id	string
items.alerts.graphPoints.initial_reference_date	string
items.alerts.graphPoints.lower_bound	number
items.alerts.graphPoints.pb_value	number
items.alerts.graphPoints.prediction	boolean
items.alerts.graphPoints.tenantid	string
items.alerts.graphPoints.upper_bound	number
items.alerts.group_code	string
items.alerts.group_description	string
items.alerts.id	string
items.alerts.inventory_periodicity	string
items.alerts.last_revision_date	datetime
items.alerts.max_stock	number	Estoque máximo do produto
items.alerts.mdmLastUpdated	datetime
items.alerts.minimum_lot	number
items.alerts.origin	string
items.alerts.pb_calculate	boolean
items.alerts.replenishment	number
items.alerts.safety_stock	number
items.alerts.stock_out_date	datetime
items.alerts.stock_quantity	number	Quantidade de estoque
items.alerts.storage	string	Armazém do produto
items.alerts.store	string
items.alerts.supplier	string	Código do fornecedor
items.alerts.suppliername	string	Descrição do fornecedor
items.alerts.tenantId	string
items.alerts.type	string	Sigla da embalagem
items.alerts.type_description	string	Descrição da embalagem
items.alerts.unity	string	Tipo de Unidade do produto

fieldsArrayLista com os campos disponíveis para este ativofields[].identifierstringIdentificador do campo no Protheus

Exemplo de retorno da requisição:

GET /wsatf001/assets/00001/00001?language=pt&fields=name,description,quantity http://<ip:port>/api/bo-ba/v1/insights/stock/rupturealert?cUserId=000001&cBranch=D%20MG%2001&cComGrp=T1

Bloco de código

language	js
theme	RDark
title	response.json
collapse	true

{
	"location": {
		"lat": -23.5084952, 
		"lng": -46.6536569,
		"local": {
			"code": "0000001".
			"description": "BRAZ LEME"
		}
	},
	"image": true,
	"fields": [
		{
			"identifier": "N1_NOME",
			"type": "string",
			"value": "Grua",
			"label": "Nome"
		},
		{
			"identifier": "N1_DESC",
			"type": "string",
			"value": "Grua 20 metros amarela",
			"label": "Descrição"
		},
		{
			"identifier": "N1_QTDE",
			"type": "number",
			"value": "2",
			"label": "Quantidade"
		},
	],
	"invoices" : [
		{
		   "name": "Grupo JLima",
			"supplier": "000001",
			"unit": "000001",
			"invoice": "0000001",
			"series": "01"
		}
	],
	"balances": [
		{
			"asset_type": "0001",
			"balance_type": "00001",
			"history": '',
			"write_off": false,
			"sequence": "00001"
		}
	]
}    "branchs": "D MG 01",
    "coduser": "000000",
    "company": "T1",
    "items": {
        "alerts": [
            {
                "accuracy": 87.69,
                "branch": "D MG 01",
                "code": "000102",
                "company_group": "T1",
                "desc_espec": "",
                "description": "EMBALAGEM - ARROZ PARBOILIZADO SABOR SUL 6X5KG TP1 LF",
                "forecast_value": 518,
                "frequency": "D",
                "graphPoints": [
                    {
                        "code": "000102",
                        "final_reference_date": "2023-12-10T03:00:00-03:00",
                        "frequency": "D",
                        "id": "2b86ef8a63f702aaa59dc397817908b6",
                        "initial_reference_date": "2023-12-10T03:00:00-03:00",
                        "lower_bound": 6176.721,
                        "pb_value": 6407.721,
                        "prediction": true,
                        "tenantid": "20938a01-1e6d-4041-80c5-f4d980603e37",
                        "upper_bound": 6637.721
                    }
                ],
                "group_code": "0191",
                "group_description": "EMBALAGEM",
                "id": "2b86ef8a63f702aaa59dc397817908b6",
                "inventory_periodicity": "0",
                "last_revision_date": "2022-02-04T00:00:00-03:00",
                "max_stock": 0,
                "mdmLastUpdated": "2023-12-05T16:53:26-03:00",
                "minimum_lot": 0,
                "origin": "0",
                "pb_calculate": true,
                "replenishment": 11322,
                "safety_stock": 5627,
                "stock_out_date": "2023-12-02T03:00:00-03:00",
                "stock_quantity": 7475,
                "storage": "01",
                "store": "    ",
                "supplier": "      ",
                "suppliername": "",
                "tenantId": "a066b32a-9565-463b-863d-1cb65562546e",
                "type": "EM",
                "type_description": "EMBALAGEM",
                "unity": "KG"
            }
        ],
        "tenantId": null
    },
    "sessionId": "a16d8a68f2701004480BB7C04F344632"
 }

Tratamento de erros

Caso n

POST /rota/assets/request/

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave