Documentation

OPCWebApiService
in package

Table of Contents

Properties

$apiService  : ApiService

Methods

__construct()  : mixed
createNodesetModel()  : array<string|int, mixed>
Create a nodeset model
createProject()  : string
Create a new project and return the project ID
createType()  : array<string|int, mixed>
Request for creating OPC UA types in the project
createTypesInBulk()  : mixed
generateNodesetXml()  : string
Generates and returns the XML for a nodeset model.
getLocalNodesets()  : array<string|int, mixed>
Get local nodesets
getModelUri()  : string
Generates a model URI based on the thinkIQ Library name provided.
getOpcType()  : array<string|int, mixed>
Serves as the base requests for to get OPC types
getProject()  : array<string|int, mixed>
Get a project by its ID
loadNodesetXmlFromServer()  : array<string|int, mixed>
Load nodeset XML from server
removeNodesetModel()  : array<string|int, mixed>
Remove a nodeset model
removeProject()  : string
Remove a project by its ID
updateType()  : array<string|int, mixed>
Request for updating OPC UA type in the project
uploadNodesetXml()  : array<string|int, mixed>
Upload nodeset XML content, this method will encode the XML content as base64
uploadXmlToLocalNodeset()  : array<string|int, mixed>
Uploads a nodeset XML file into the local nodeset in the server.

Properties

Methods

createNodesetModel()

Create a nodeset model

public createNodesetModel(string $projectId, string $modelUri, string $nodesetVersion, string $publicationDate[, string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$projectId : string
  • The project ID
$modelUri : string
  • The model URI
$nodesetVersion : string
  • The nodeset version
$publicationDate : string
  • The publication date
$version : string = 'v1'
  • The version of the API to use
Return values
array<string|int, mixed>

createProject()

Create a new project and return the project ID

public createProject(string $name, string $owner[, string $version = 'v1' ]) : string
Parameters
$name : string
  • The name of the project
$owner : string
  • The owner of the project
$version : string = 'v1'
  • The version of the API to use
Return values
string —
  • The project ID

createType()

Request for creating OPC UA types in the project

public createType(string $projectId, string $namespace, mixed $body[, string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$projectId : string
  • The project ID
$namespace : string
  • The namespace
$body : mixed
  • The body of the request
$version : string = 'v1'
  • The version of the API to use
Return values
array<string|int, mixed>

createTypesInBulk()

public createTypesInBulk(string $projectId, string $namespace, string $parentNodeId, array<string|int, mixed> $types[, string $typeEndPoint = 'property' ][, string $version = "v1" ]) : mixed
Parameters
$projectId : string
$namespace : string
$parentNodeId : string
$types : array<string|int, mixed>
$typeEndPoint : string = 'property'
$version : string = "v1"

generateNodesetXml()

Generates and returns the XML for a nodeset model.

public generateNodesetXml(string $projectId, string $modelUri[, string $version = 'v1' ]) : string
Parameters
$projectId : string
  • The project ID
$modelUri : string
$version : string = 'v1'
  • The version of the API to use
Return values
string —
  • The XML content

getLocalNodesets()

Get local nodesets

public getLocalNodesets([string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$version : string = 'v1'
  • The version of the API to use
Return values
array<string|int, mixed> —
  • A set of local nodesets that are available in the server

getModelUri()

Generates a model URI based on the thinkIQ Library name provided.

public static getModelUri(string $libraryName) : string
Parameters
$libraryName : string
  • The name of the ThinKIQ library that we are going to use to create the model URI
Return values
string —
  • The generated model URI for the ThinkIQ library

getOpcType()

Serves as the base requests for to get OPC types

public getOpcType(OpcType $type, string $projectId, string $nodeNamespaceKey[, array<string|int, mixed>|object $filters = [] ][, string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$type : OpcType
  • The OPC Type that we are accessing in the request
$projectId : string
  • The project ID
$nodeNamespaceKey : string
  • The namespace
$filters : array<string|int, mixed>|object = []
  • The query filters to apply to the request
$version : string = 'v1'
  • The version of the API to use
Return values
array<string|int, mixed>

getProject()

Get a project by its ID

public getProject(string $projectId[, string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$projectId : string
  • The project ID
$version : string = 'v1'
  • The version of the API to use
Return values
array<string|int, mixed> —
  • The project data

loadNodesetXmlFromServer()

Load nodeset XML from server

public loadNodesetXmlFromServer(string $projectId, string $uri[, string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$projectId : string
$uri : string
$version : string = 'v1'
Return values
array<string|int, mixed>

removeNodesetModel()

Remove a nodeset model

public removeNodesetModel(string $projectId, string $modelUri[, string $version = "v1" ]) : array<string|int, mixed>
Parameters
$projectId : string
  • The project ID
$modelUri : string
  • The model URI
$version : string = "v1"
  • The version of the API to use
Return values
array<string|int, mixed>

removeProject()

Remove a project by its ID

public removeProject(string $projectId[, string $version = 'v1' ]) : string
Parameters
$projectId : string
  • The project ID
$version : string = 'v1'
  • The version of the API to use
Return values
string —
  • The response from the server

updateType()

Request for updating OPC UA type in the project

public updateType(string $projectId, string $namespace, mixed $body[, string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$projectId : string
  • The project ID
$namespace : string
  • The namespace
$body : mixed
  • The body of the request
$version : string = 'v1'
  • The version of the API to use
Return values
array<string|int, mixed>

uploadNodesetXml()

Upload nodeset XML content, this method will encode the XML content as base64

public uploadNodesetXml(string $projectId, string $fileName, string $xmlContent[, string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$projectId : string
  • The project ID
$fileName : string
  • The name of the file
$xmlContent : string
  • The content of the XML file
$version : string = 'v1'
  • The version of the API to use
Return values
array<string|int, mixed>

uploadXmlToLocalNodeset()

Uploads a nodeset XML file into the local nodeset in the server.

public uploadXmlToLocalNodeset(string $fileName, string $xmlContent[, string $version = 'v1' ]) : array<string|int, mixed>
Parameters
$fileName : string
  • The name of the file
$xmlContent : string
  • The content of the XML file
$version : string = 'v1'
  • The version of the API to use
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results