12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

Especificação Técnica [VALIDATED]

Last updated by | Natalia Cristina Loterio Rodrigues | Sep 7, 2022 at 11:01 PM GMT-3

Documentação PI System Vale (pt_BR)

Aplicações (Soluções e Integrações)

Global

CMA Web Local

Especificação Técnica

Contents
• Objetivo do Documento
• Documentos de Referência
• Dicionário de Termos
• Detalhamento da Solução
• Pré-Requisitos
• Funções PI Web API
• Batch
• Exemplo Batch
• AssetDatabase GetByPath
• Exemplo Request
• Exemplo Response
• EventFrame GetEventFramesQuery
• Exemplo Request
• Exemplo Response
• EventFrame GetAttributes
• Exemplo Request
• Exemplo Response
• Stream GetValue
• Exemplo Request
• Exemplo Response
• Fluxos de Execução
• Fluxo: Requisição para consultar os valores dos atributos d…
• Fluxo: Resposta para requisição de descoberta do WebID d…
• Endpoints e Filas
• Endpoints
• Filas
• Anexos
• PI Web API Reference
• PI Web API Overview

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 1/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

Objetivo do Documento
Este documento tem como objetivo apresentar as informações e definições que permitam o
desenvolvimento de um processo de integração de envio de informações entre CMA Web Local e PIMS.

Documentos de Referência
A tabela abaixo apresenta os documentos utilizados como referência na elaboração do presente
documento.

Documentos de
# Descrição
referência

ICC 010 CMA Web Apresenta as informações e definições necessárias para a

1
Local integração do CMA Web Local.

Dicionário de Termos
A tabela a seguir, contém a definição de termos técnicos citados nesse documento e foi criada com o
objetivo de tornar explícitos conceitos, siglas, abreviações e procedimentos utilizados nos servidores PIMS,
assim como permitir que os profissionais envolvidos, independentemente de sua formação, tenham a
mesma visão do assunto abordado.

Termo Descrição

Sigla de Plant Information Management System. Banco de dados temporal

PIMS
responsável por armazenar dados de processos em plantas industriais.

ADF Azure Data Factory.

PI
Sistema PIMS do Fabricante AVEVA.
System

PI Point É um componente no banco de dados que armazena registros e valores.

Rotinas de cálculo customizadas que executam periodicamente ou a partir de

Analysis
eventos.

Asset Framework, ferramenta do PI System capaz de dar contexto aos PI Points na

AF
forma de elementos, event frames e cálculo de analysis.

IP.21 Aspen InfoPlus.21, Sistema PIMS do Fabricante Aspentech.

O WebID é um mecanismo para recuperar dados dos servidores PI enquanto

WebID permanece seguro para uso em URLs. Esse é obtido por meio de uma codificação do
path da TAG de interesse.

Detalhamento da Solução
[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 2/20
12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

O CMA Web Local é responsável por disponibilizar as informações de alarmes gerados por eventos de
produção online pelo PI System, harmonizadas no formato de pontos alarmados devidamente reconhecidos
pelo sistema CMA Web, utilizando o módulo integrador SenseUp Enterprise Hub irá entregar esses dados
em uma WebAPI disponbilizada pelo sistema CMA Web.

Pré-Requisitos
• Credenciais/token de acesso ao webservice;
• Disponibilidade dos dados via webservice;
• As amostras de interesse do PIMS deverão existir no CMA Web Local;
• Os DE x PARA deverão estar configurados no PIMS para poder armazenar na base de dados.

Funções PI Web API

Batch
A PI Web API oferece suporte ao lote de várias solicitações REST lógicas em uma única solicitação HTTP.

Realiza a execução de um lote de solicitações no serviço. A entrada é um dicionário com IDs como chaves e
objetos de solicitação como valores. Cada objeto de solicitação especifica o método HTTP e o recurso e,
opcionalmente, o conteúdo e uma lista de IDs pai. A lista de IDs pai especifica quais outras solicitações
devem ser concluídas antes que uma determinada solicitação seja executada.

Essa função é utilizada para que em uma requisição seja possível consultar vários TAGs ou escrever em
vários TAGs.

Exemplo Batch

{
"Tag1": {
"Method": "GET",
"Resource": "[Link]
"Headers": { "Cache-Control": "no-cache" }
},
"Tag2": {
"Method": "GET",
"Resource": "[Link]
"Headers": { "Cache-Control": "no-cache" }
}
}

AssetDatabase GetByPath
Esse método retorna o WebID do Database de interesse com base no caminho hierárquico associado a ele.
Por meio do campo "selectedfiels" é possível selecionar quais os campos a serem retornados, como o WebI.

Exemplo Request

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 3/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

{
"Database": {
"Method": "GET",
"Resource": "[Link]
"Headers": {
"Cache-Control": "no-cache"
}
}
}

Por meio do termo "&selectedfields=WebID" é selecionado o retorno apenas do WebId.

Exemplo Response

{
"Database": {
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"WebId": "F1RDK-Sm-oaCPUKxAtVatNqDtQU3bFnDHvmUqUCQCQjWgkVgUElBRi1RQS1WSVRPUklBXEFQTElDQcOHw5VFU
}
}
}

EventFrame GetEventFramesQuery
Por meio deste método é possível pesquisar EventFrames de acordo com os parâmetros de interesse. Para o
caso do CMA Web Local, será utilizado como filtro os atributos Localidade, CMA e Valor.

Exemplo Request

{
"EventFrames": {
"Method": "GET",
"Resource": "[Link]
"Parameters": [
"$.[Link]"
],
"ParentIds": [
"Database"
]
}
}

Por meio do termo "&selectedfields=WebID" é selecionado o retorno apenas do WebId.

Exemplo Response

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 4/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

{
"EventFrames": {
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Items": [
{
"WebId": "F1FmK-Sm-oaCPUKxAtVatNqDtQPISi0pLP7BGlkABQVoLTfAUElBRi1RQS1WSVRPUklBXEFQTElDQ
"StartTime": "2022-05-09T12:23:11.0490112Z",
"EndTime": "2022-05-09T13:26:31.0590057Z",
"Links": {
"Attributes": "[Link]
}
},
{
"WebId": "F1FmK-Sm-oaCPUKxAtVatNqDtQHpYZ-5bP7BGlkABQVoLTfAUElBRi1RQS1WSVRPUklBXEFQTElDQ
"StartTime": "2022-05-09T12:53:06.0350036Z",
"EndTime": "2022-05-09T15:09:01.0640106Z",
"Links": {
"Attributes": "[Link]
}
},
{
"WebId": "F1FmK-Sm-oaCPUKxAtVatNqDtQ6YhurZvP7BGlkABQVoLTfAUElBRi1RQS1WSVRPUklBXEFQTElDQ
"StartTime": "2022-05-09T13:26:36.0590057Z",
"EndTime": "2022-05-09T15:08:56.0640106Z",
"Links": {
"Attributes": "[Link]
}
},
{
"WebId": "F1FmK-Sm-oaCPUKxAtVatNqDtQOAy_-qnP7BGlkABQVoLTfAUElBRi1RQS1WSVRPUklBXEFQTElDQ
"StartTime": "2022-05-09T15:09:01.0640106Z",
"EndTime": "9999-12-31T23:59:59Z",
"Links": {
"Attributes": "[Link]
}
}
]
}
}
}

EventFrame GetAttributes
Por meio do Batch, é utilizado os parâmetros do request de EventFrame para buscar os atributos de cada
evento. Assim, é passado na chamada o link para os atributos e, por meio deste, é obtido os campos de
Name e WebID de cada atributo dos eventos.

Exemplo Request

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 5/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

{
"Attributes": {
"Method": "GET",
"RequestTemplate": {
"Resource": "{0}?selectedFields=[Link];[Link]"
},
"Parameters": [
"$.[Link][*].[Link]"
],
"ParentIds": [
"EventFrames"
]
}
}

Por meio do termo "?selectedFields=[Link] ;[Link]" é selecionado o retorno apenas do WebId

e do Nome.

Exemplo Response

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 6/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

{
"Attributes": {
"Status": 207,
"Headers": {},
"Content": {
"Total": 4,
"Items": [
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Items": [
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQPISi0pLP7BGlkABQVoLTfArJzKpcFtBVE0oUR5
"Name": "CMA"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQPISi0pLP7BGlkABQVoLTfA6J0z2zLXI1YoFpSM
"Name": "Descrição do TAG"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQPISi0pLP7BGlkABQVoLTfAmau-9BcLhFwuF_q3
"Name": "Localidade"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQPISi0pLP7BGlkABQVoLTfAtJllEq9d11cFrJp6
"Name": "Nome do Tag"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQPISi0pLP7BGlkABQVoLTfAI3DI06JvuFo2QIP1
"Name": "Unidade de Engenharia"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQPISi0pLP7BGlkABQVoLTfAMunf_UFEuFYoVvn1
"Name": "Valor"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQPISi0pLP7BGlkABQVoLTfA1AyKKKk5Il8F2kjb
"Name": "Valor Referência do TAG"
}
]
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Items": [
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQHpYZ-5bP7BGlkABQVoLTfAjo5xjMVtBVE0oUR5
"Name": "CMA"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQHpYZ-5bP7BGlkABQVoLTfAyo-I8jbXI1YoFpSM
"Name": "Descrição do TAG"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQHpYZ-5bP7BGlkABQVoLTfAu7kF3RMLhFwuF_q3
"Name": "Localidade"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQHpYZ-5bP7BGlkABQVoLTfAloveO6td11cFrJp6
"Name": "Nome do Tag"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQHpYZ-5bP7BGlkABQVoLTfAAWJz-qZvuFo2QIP1
"Name": "Unidade de Engenharia"
},
{

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 7/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQHpYZ-5bP7BGlkABQVoLTfAEPtk1EVEuFYoVvn1
"Name": "Valor"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQHpYZ-5bP7BGlkABQVoLTfA9h4xAa05Il8F2kjb
"Name": "Valor Referência do TAG"
}
]
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Items": [
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQ6YhurZvP7BGlkABQVoLTfAeZAG2shtBVE0oUR5
"Name": "CMA"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQ6YhurZvP7BGlkABQVoLTfAPZH_pDvXI1YoFpSM
"Name": "Descrição do TAG"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQ6YhurZvP7BGlkABQVoLTfATKdyix4LhFwuF_q3
"Name": "Localidade"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQ6YhurZvP7BGlkABQVoLTfAYZWpbaZd11cFrJp6
"Name": "Nome do Tag"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQ6YhurZvP7BGlkABQVoLTfA9nwErKtvuFo2QIP1
"Name": "Unidade de Engenharia"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQ6YhurZvP7BGlkABQVoLTfA5-UTgkhEuFYoVvn1
"Name": "Valor"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQ6YhurZvP7BGlkABQVoLTfAAQBGV6A5Il8F2kjb
"Name": "Valor Referência do TAG"
}
]
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Items": [
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQOAy_-qnP7BGlkABQVoLTfAqBTXjfptBVE0oUR5
"Name": "CMA"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQOAy_-qnP7BGlkABQVoLTfA7BUu8wnXI1YoFpSM
"Name": "Descrição do TAG"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQOAy_-qnP7BGlkABQVoLTfAnSOj3CwLhFwuF_q3
"Name": "Localidade"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQOAy_-qnP7BGlkABQVoLTfAsBF4OpRd11cFrJp6
"Name": "Nome do Tag"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQOAy_-qnP7BGlkABQVoLTfAJ_jV-5lvuFo2QIP1
"Name": "Unidade de Engenharia"

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 8/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQOAy_-qnP7BGlkABQVoLTfANmHC1XpEuFYoVvn1
"Name": "Valor"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQOAy_-qnP7BGlkABQVoLTfA0ISXAJI5Il8F2kjb
"Name": "Valor Referência do TAG"
}
]
}
}
]
}
}
}

Stream GetValue
Por meio do Batch, é utilizado como parâmetro o WebID dos atributos encontrados no request anterior para
buscar os valores de cada atributo. Assim, é utilizado esse parâmetro junto com a função values.

Exemplo Request

{
"Values": {
"Method": "GET",
"RequestTemplate": {
"Resource": "[Link]
},
"Parameters": [
"$.[Link][*].[Link][*].WebId"
],
"ParentIds": [
"Attributes"
]
}
}

Exemplo Response

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 9/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

{
"Values": {
"Status": 207,
"Headers": {},
"Content": {
"Total": 28,
"Items": [
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Yes",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT_6Q7M1_YIT_STS1",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 10/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "2022-05-09T12:23:11.0490112Z",
"Value": "Bypassada",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Bad input value in '.\\Elements[.]|Tag Monitorado 1|%Attribute%\r\n': Sys
"UnitsAbbreviation": "",
"Good": false,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Yes",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 11/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT_6Q7M1_YIT_STS1",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "2022-05-09T12:53:06.0350036Z",
"Value": "Cannot convert 'Bypassada' to type Single.",
"UnitsAbbreviation": "",
"Good": false,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "2022-05-09T15:09:01.0640106Z",
"Value": "Bad input value in '.\\Elements[.]|Tag Monitorado 1|%Attribute%\r\n': Sys
"UnitsAbbreviation": "",
"Good": false,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 12/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Yes",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT_6Q7M1_YIT_STS1",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 13/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "2022-05-09T13:26:36.0590057Z",
"Value": "Bypassada",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Bad input value in '.\\Elements[.]|Tag Monitorado 1|%Attribute%\r\n': Sys
"UnitsAbbreviation": "",
"Good": false,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Yes",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 14/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT_6Q7M1_YIT_STS1",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 403,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Errors": [
"Cannot connect to the PI Data Archive. Windows authentication trial failed bec
]
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Bad input value in '.\\Elements[.]|Tag Monitorado 1|%Attribute%\r\n': Sys
"UnitsAbbreviation": "",
"Good": false,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
}
]
}
}
}

Fluxos de Execução
Obs.: É válido pontuar que os exemplos apresentados são apenas para mostrar como as requisições são
realizadas por parte da aplicação. Para a validação de dados em produção deve-se seguir o processo
indicado na pagína de Troubleshooting.

Fluxo: Requisição para consultar os valores dos atributos dos EventFrames de interesse

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 15/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

Requisição do tipo POST; o corpo é um JSON com chamadas encadeadas e utilizando parâmetros para
obter os resultados necessários.

{
"Database": {
"Method": "GET",
"Resource": "[Link]
"Headers": {
"Cache-Control": "no-cache"
}
},
"EventFrames": {
"Method": "GET",
"Resource": "[Link]
"Parameters": [
"$.[Link]"
],
"ParentIds": [
"Database"
]
},
"Attributes": {
"Method": "GET",
"RequestTemplate": {
"Resource": "{0}?selectedFields=[Link];[Link]"
},
"Parameters": [
"$.[Link][*].[Link]"
],
"ParentIds": [
"EventFrames"
]
},
"Values": {
"Method": "GET",
"RequestTemplate": {
"Resource": "[Link]
},
"Parameters": [
"$.[Link][*].[Link][*].WebId"
],
"ParentIds": [
"Attributes"
]
}
}

Fluxo: Resposta para requisição de descoberta do WebID de mais de um PI Point

A resposta da requisição batch é um JSON que usa chaves correspondentes às fornecidas na requisição,
com objetos de resposta contendo um código de status, cabeçalhos de resposta e o corpo da resposta.

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 16/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

{
"Database": {
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"WebId": "F1RDK-Sm-oaCPUKxAtVatNqDtQU3bFnDHvmUqUCQCQjWgkVgUElBRi1RQS1WSVRPUklBXEFQTElDQcOHw5VFU
}
},
"EventFrames": {
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Items": [
{
"WebId": "F1FmK-Sm-oaCPUKxAtVatNqDtQjYMB4cLP7BGlkABQVoLTfAUElBRi1RQS1WSVRPUklBXEFQTElDQ
"StartTime": "2022-05-09T18:07:11.0520019Z",
"EndTime": "9999-12-31T23:59:59Z",
"Links": {
"Attributes": "[Link]
}
}
]
}
},
"Values": {
"Status": 207,
"Headers": {},
"Content": {
"Total": 7,
"Items": [
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Yes",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT",

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 17/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "PEVT_6Q7M1_YIT_STS1",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "",
"UnitsAbbreviation": "",
"Good": true,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
},
{
"Status": 403,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Errors": [
"Cannot connect to the PI Data Archive. Windows authentication trial failed bec
]
}
},
{
"Status": 200,
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Timestamp": "1970-01-01T00:00:00Z",
"Value": "Bad input value in '.\\Elements[.]|Tag Monitorado 1|%Attribute%\r\n': Sys
"UnitsAbbreviation": "",
"Good": false,
"Questionable": false,
"Substituted": false,
"Annotated": false
}
}
]
}
},
"Attributes": {
"Status": 207,
"Headers": {},
"Content": {
"Total": 1,
"Items": [
{
"Status": 200,

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 18/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview
"Headers": {
"Content-Type": "application/json; charset=utf-8"
},
"Content": {
"Items": [
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQjYMB4cLP7BGlkABQVoLTfAHZtplpFtBVE0oUR5
"Name": "CMA"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQjYMB4cLP7BGlkABQVoLTfAWZqQ6GLXI1YoFpSM
"Name": "Descrição do TAG"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQjYMB4cLP7BGlkABQVoLTfAKKwdx0cLhFwuF_q3
"Name": "Localidade"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQjYMB4cLP7BGlkABQVoLTfABZ7GIf9d11cFrJp6
"Name": "Nome do Tag"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQjYMB4cLP7BGlkABQVoLTfAkndr4PJvuFo2QIP1
"Name": "Unidade de Engenharia"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQjYMB4cLP7BGlkABQVoLTfAg-58zhFEuFYoVvn1
"Name": "Valor"
},
{
"WebId": "F1AbFK-Sm-oaCPUKxAtVatNqDtQjYMB4cLP7BGlkABQVoLTfAZQspG_k5Il8F2kjb
"Name": "Valor Referência do TAG"
}
]
}
}
]
}
}
}

Endpoints e Filas

Endpoints
PRD: [Link] 
DEV: [Link] 

Filas
Middleware: App Process Integration TCS – GL

CMA Web Local: App Maintenance TCS -GL

Sense UP: App SenseUp Hub -GL

Anexos

PI Web API Reference

[Link]/bundle/pi-web-api-reference/page/[Link] 

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 19/20

12/15/22, 3:34 PM Especificação Técnica [VALIDATED] - Overview

PI Web API Overview

[Link] 

[Link] PIMS/_wiki/wikis/[Link]/14033/Especificação-Técnica-VALIDATED- 20/20