Documentation

ApiServiceTrait

Table of Contents

Methods

downloadInfoModel()  : array<string|int, mixed>|string
Download the infomodel
getInfomodelNamespaces()  : array<string|int, mixed>|string
Get the infomodel namespaces
getInfoModels()  : array<string|int, mixed>|string
Get the infomodels from the API service
loadUaNodes()  : array<string|int, mixed>
Creates a dictionary of UA nodes from the given project name space keys and project ID
uploadInfomodel()  : int
Upload an infomodel to the API service

Methods

downloadInfoModel()

Download the infomodel

public downloadInfoModel(ApiServiceFactory $apiService, int $nodesetId[, bool $nodesetXMLOnly = false ][, bool $metadataOnly = false ]) : array<string|int, mixed>|string
Parameters
$apiService : ApiServiceFactory
  • The API service
$nodesetId : int
  • The nodeset ID
$nodesetXMLOnly : bool = false
  • Whether to download only the nodeset XML
$metadataOnly : bool = false
Return values
array<string|int, mixed>|string —
  • The response from the request

getInfomodelNamespaces()

Get the infomodel namespaces

public getInfomodelNamespaces(ApiServiceFactory $apiService) : array<string|int, mixed>|string
Parameters
$apiService : ApiServiceFactory
  • The API service
Return values
array<string|int, mixed>|string —
  • The infomodel namespaces

getInfoModels()

Get the infomodels from the API service

public getInfoModels(ApiServiceFactory $apiService) : array<string|int, mixed>|string
Parameters
$apiService : ApiServiceFactory
  • The API service
Return values
array<string|int, mixed>|string

loadUaNodes()

Creates a dictionary of UA nodes from the given project name space keys and project ID

public loadUaNodes(array<string|int, mixed> $projectNameSpaceKeys, string $projectId, OPCWebApiService $OPCWebApiService, OpcType $projectTypes) : array<string|int, mixed>
Parameters
$projectNameSpaceKeys : array<string|int, mixed>
  • The project name space keys
$projectId : string
  • The project ID
$OPCWebApiService : OPCWebApiService
  • The OPC Web API service
$projectTypes : OpcType
  • The project types
Return values
array<string|int, mixed> —

$results - The results of the loaded nodes

uploadInfomodel()

Upload an infomodel to the API service

public uploadInfomodel(ApiServiceFactory $apiService, array<string|int, mixed> $body[, bool $overwrite = false ]) : int
Parameters
$apiService : ApiServiceFactory
  • The API service
$body : array<string|int, mixed>
  • The body of the request containing the infomodel data
$overwrite : bool = false
  • Whether to overwrite an existing infomodel with the same name
Return values
int —
  • The ID of the uploaded infomodel

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results