Point Config Operations

Read Operations	Description
GetPointAttrMetadata	Given a service name (PNT, UIS or CVS), this operation returns point attribute metadata information for the PNT service.

GetPointAttrMetadata

Given a service name (PNT, UIS or CVS), this operation will return an XML response containing the point attribute metadata information for the specified point service. This operation is useful for exposing any "nice names" that have been assigned to specific point attributes. The return XML will also indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetPointAttrMetadataReq>).

Element Name	Required	Description
SvcName	Yes	The Site.Service to which to connect. This parameter must specify the name of a PNT, UIS, or CVS Site.Service. If a UIS or CVS is specified, the service will resolve to its associated PNT.

Target Services

The service name node (<SvcName>) must specify the name of a PNT, UIS, or CVS Site.Service. If a UIS or CVS is specified, the service will resolve to its associated PNT.

Examples

Request

Copy

GetPointAttrMetadata Request

1
2
3
4
5
6
<?xml version="1.0"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn"  >
    <GetPointAttrMetadataReq>
        <SvcName>CYGDEMO.PNT</SvcName>
    </GetPointAttrMetadataReq>
</CygNetEnterpriseOperations>

Response

The following example represents a successful response.

Copy

GetPointAttrMetadata Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetPointAttrMetadataResp>
        <PntAttrMetadata>
            <PointGeneral1>General 1 </PointGeneral1>
            <PointGeneral2>General 2</PointGeneral2>
            <PointIndexed1>Indexed 1</PointIndexed1>
            <PointIndexed2>Indexed 2</PointIndexed2>
            <PointIndexed3>Indexed 3</PointIndexed3>
            <PointTableDriven1>Table Driven 1</PointTableDriven1>
            <PointTableDriven2>Table Driven 2</PointTableDriven2>
            <PointTableDriven3>Table Driven 3</PointTableDriven3>
            <PointUserFlag1>User Flag 1</PointUserFlag1>
            <PointUserFlag2>User Flag 2</PointUserFlag2>
            <PointUserFlag3>User Flag 3</PointUserFlag3>
            <PointUserFlag4>User Flag 4</PointUserFlag4>
            <PointUserFlag5>User Flag 5</PointUserFlag5>
            <PointUserFlag6>User Flag 6</PointUserFlag6>
            <PointUserFlag7>User Flag 7</PointUserFlag7>
            <PointUserFlag8>User Flag 8</PointUserFlag8>
            <PointVerifiedFlag1>Verified Flag 1</PointVerifiedFlag1>
            <PointVerifiedFlag2>Verified Flag 2</PointVerifiedFlag2>
            <PointVerifiedFlag3>Verified Flag 3</PointVerifiedFlag3>
            <PointVerifiedFlag4>Verified Flag 4</PointVerifiedFlag4>
        </PntAttrMetadata>
        <OperationResults success="true" resp_timestamp="2023-10-05T21:48:10.189Z" exec_duration="PT8.091S"></OperationResults>
     </GetPointAttrMetadataResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy

GetPointAttrMetadata Response Unsuccessful

1
2
3
4
5
6
7
8
9
10
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetPointAttrMetadataResp>
        <PntAttrMetadata />
        <OperationResults success="false" resp_timestamp="2023-07-30T22:13:02.517Z" exec_duration="PT0.002S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS0</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </GetPointAttrMetadataResp>
</CygNetEnterpriseOperations>