Ignition 8.3 OpenAPI - Functionality Similar to Tag Browser Export for Tag and UDT JSON

Ignition
,
1

Hello,

I have been testing out the API in 8.3 to import/export projects and pull backups—it has been working great!

However, while browsing through the available REST operations, I was unable to find a way to target a specific Tag Provider to export/import the JSON for tags and UDT definitions (similar to how you can in the Designer's Tag Browser).

The closest endpoint I found was “/find/ignition/tag_provider", but I believe this only reports high-level information about the provider itself. During testing it only listed core as an available collection although the example shows string, not sure if maybe I'm missing something to potentially expose more information.

I just wanted to verify if I accidentally overlooked this functionality. If not, I plan to submit a feature request.

Thanks for your time!

3

You should be able to cancel that request. You should be using the endpoint found at {gateway_address}/openapi#tag/tags/paths/~1data~1api~1v1~1tags~1export/get. That endpoint allows for you to supply a provider name as a URL param, as well as providing a URL param for the export type.

GET {gateway_address}/data/api/v1/tags/export?provider=MyProvider&type=json

Edit: This endpoint became available as part of 8.3.2.

4

Thanks for the response, I will take it down, I was running 8.3.1, just updated to 8.3.2.

5

Oh my goodness. I thought those were included from the initial 8.3.0 release! You’re right - they didn’t make it in until 8.3.2.

6

So there's no browse type of function available through the OpenAPI?
I can't say, give me a list of the existing providers and a list of the root root folders under each provider. Even if I know the provider and a folder ahead of time, I'd still have to wait for it to download everything before then filtering through what I want?

7

It's more of a status and configuration API than it is a runtime feature API.

8

Understandable, I was just hoping to this would be a cool way grab tags and addresses of a particular type from particular provider remotly into Excel and then use that to generate data that we would remotly enter into a Kepware Server through their API.

9

You could build the endpoint you need pretty easily with the WebDev module calling the system.tag scripting functions.

10

I was just trying to come up with something to make configuration a little bit easier. Something could work with any newer install. I didn't want to install or explain extra modules. :slight_smile: