---
title: "GetWriterGroupState"
method: GET
path: "/v2/diagnostics/writergroups/{dataSetWriterGroup}"
tags: ["Diagnostics"]
---

# GetWriterGroupState

`GET /v2/diagnostics/writergroups/{dataSetWriterGroup}`

Get the state of a single writer group and the state of each of its dataset writers.

## Path parameters

- `dataSetWriterGroup` string, required

## Response `200`

The operation was successful.

- WriterGroupStateDiagnosticModel — Model for writer group status diagnostics.
  - `id` string, required — Writer group identifier.
  - `writerGroupName` string — Writer group name.
  - `version` integer — Writer group version
  - `dataSetWriters` DataSetWriterStateDiagnosticModel[], required — Diagnostics for the dataset writers
    - `id` string, required — Dataset writer identifier.
    - `dataSetWriterName` string — Dataset writer name.
    - `endpointUrl` string — The endpoint url of the server the writer is connecting to.
    - `useSecurity` boolean — Whether the connection to the endpoint uses a secure channel.
    - `opcAuthenticationMode` 'Anonymous' | 'UsernamePassword' | 'Certificate' — Specifies the authentication method used to connect to OPC UA servers. The chosen mode determines how the Publisher authenticates itself to servers. When using credentials or certificates, encrypted communication should be enabled via UseSecurity or EndpointSecurityMode to protect authentication secrets.
    - `opcAuthenticationUsername` string — The user name used to connect to the endpoint in case of user name and password authentication.
    - `source` PublishedDataSetSourceDiagnosticModel — Model for monitored item node errors
      - `errors` MonitoredItemNodeErrorModel[] — Error information for nodes inside the writer source
        - `nodeId` string, required — Node id of the variable
        - `errorInfo` ServiceResultModel, required — Service result
          - `statusCode` integer — Error code - if null operation succeeded.
          - `errorMessage` string — Error message in case of error or null.
          - `symbolicId` string — Symbolic identifier
          - `locale` string — Locale of the error message
          - `additionalInfo` string — Additional information if available
          - `namespaceUri` string — Namespace uri
          - `inner` ServiceResultModel — recursive

## Other responses

- `400` — The passed in information is invalid.
- `404` — The item was not found.

## Changes

- **2026-08-31** `6a0e0e1a68ac` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/azure/apis/opcpublisher/changes/v2/diagnostics/writergroups/:dataSetWriterGroup/get.md)

---

[API](https://skmtc.dev/azure/apis/opcpublisher.md) · [All operations](https://skmtc.dev/azure/apis/opcpublisher/llms.txt) · [OpenAPI document](https://skmtc.dev/azure/apis/opcpublisher/revisions/6a0e0e1a68ac?raw)