### Start Metadata Rule Preview - 202 Accepted Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/metadata-rules/metadata-metadata-rule-preview.md

Example response body for a 202 Accepted status code when starting a metadata rule preview. It provides a link to the preview and its expiration time.

```json
{
  "PreviewLink": "/api/v1/tenants/{tenantId}/namespaces/{namespaceId}/preview/metadatarules?Token=00000000-0000-0000-0000-000000000000",
  "Expires": 7200
}
```

--------------------------------

### Example Signup Collection Response (JSON)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

An example JSON response body for the 'Get All Signups' API endpoint, illustrating the structure of a `SignupCollection`. It contains a list of `Signup` objects, each with details like `Id`, `Name`, `Owner`, `CommunityId`, `Type`, dates, and `SignupState`.

```json
{
  "Signups": [
    {
      "Id": "string",
      "Name": "string",
      "Owner": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "CommunityId": "string",
      "Type": "Stream",
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z",
      "SignupState": "Activating"
    },
    {
      "Id": "string",
      "Name": "string",
      "Owner": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "CommunityId": "string",
      "Type": "Stream",
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z",
      "SignupState": "Active"
    },
    {
      "Id": "string",
      "Name": "string",
      "Owner": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "CommunityId": "string",
      "Type": "Stream",
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z",
      "ExpiredDate": "2019-09-24T14:15:22Z",
      "SignupState": "Expired"
    }
  ]
}
```

--------------------------------

### Example Success Response for Get Statistics

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/metadata-rules/metadata-rules-internal/metadata-rule-admin.md

An example of a successful response when retrieving store statistics, indicating the total rule count.

```json
{
  "RuleCount": 0
}
```

--------------------------------

### Get Community by ID - Example JSON Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/identity/communities.md

An example JSON payload representing a successful response when retrieving community details. It includes community identifiers, tenant information, creation date, and associated roles.

```json
{
  "Id": "string",
  "MemberRoleId": "string",
  "Name": "string",
  "DisplayName": "string",
  "Description": "string",
  "Tenants": [
    {
      "Id": "string",
      "Name": "string",
      "Status": "None",
      "IsOwner": true,
      "UserCount": 0,
      "ClientCount": 0,
      "PreferredRegionId": "string",
      "ContactEmail": "string",
      "CommunityAlias": "string"
    }
  ],
  "DateCreated": "2019-08-24T14:15:22Z",
  "PreferredRegionId": "string",
  "CommunityRoles": [
    {
      "Id": "string",
      "Name": "string",
      "Description": "string",
      "RoleScope": 0,
      "TenantId": "string",
      "CommunityId": "string",
      "RoleTypeId": "string"
    }
  ]
}
```

--------------------------------

### List Quantity Unit of Measure Access Rights Success Response Example

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/sequential-data-store/sds-access-control-list.md

Example JSON response for a successful GET request to list access rights for a quantity unit of measure. The response is an array of strings representing the access rights.

```json
HTTP/1.1 200
Content-Type: application/json

["Read", "Write"]
```

--------------------------------

### Rule Preview Response (JSON)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/asset-rules/asset-asset-rule-preview.md

Example response structure for successful preview creation. Contains preview link URL and expiration time in seconds.

```JSON
{
  "PreviewLink": "/api/v1-preview/tenants/{tenantId}/namespaces/{namespaceId}/preview/assetrules?Token=00000000-0000-0000-0000-000000000000",
  "Expires": 7200
}
```

--------------------------------

### GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups/{signupId}/updates

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-updates.md

Retrieves a sequence of change data updates for all resources within the Signup, starting from the sequential marker represented by a provided bookmark.

```APIDOC
## GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups/{signupId}/updates

### Description
Returns a sequence of change data updates for all resources within the Signup, starting from the sequential marker represented by a provided `Bookmark`.

### Method
GET

### Endpoint
/api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups/{signupId}/updates

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - The tenant identifier.
- **namespaceId** (string) - Required - The namespace identifier.
- **signupId** (string) - Required - Signup unique identifier.

#### Query Parameters
- **bookmark** (string) - Required - An encoded token representing a sequential starting point from which users can retrieve updates for the current request.

#### Request Headers
- **Community-Id** (string) - Optional - Community unique identifier. Must be provided to retrieve changed data for a signup containing resources shared through a community.

### Response
#### Success Response (200)
- **data** (array) - A sequence of updates.
- **bookmark** (string) - An encoded token representing the next sequential starting point.

#### Response Example
```json
{
  "data": [
    {
      "resourceId": "stream2",
      "operation": "Insert",
      "events": [
        {
          "Timestamp": "3/7/2024 12:00:00 AM",
          "Value": 12
        },
        {
          "Timestamp": "3/8/2024 12:00:00 AM",
          "Value": 53
        }
      ]
    },
    {
      "resourceId": "stream1",
      "operation": "Insert",
      "events": [
        {
          "Timestamp": "3/7/2024 12:00:00 AM",
          "Value": 234
        },
        {
          "Timestamp": "3/8/2024 12:00:00 AM",
          "Value": 7
        }
      ]
    },
    {
      "resourceId": "stream1",
      "operation": "Remove",
      "events": [
        {
          "Timestamp": "2024-03-07T00:00:00Z"
        }
      ]
    },
    {
      "resourceId": "stream2",
      "operation": "Update",
      "events": [
        {
          "Timestamp": "3/7/2024 12:00:00 AM",
          "Value": 121
        }
      ]
    }
  ],
  "bookmark": "H4sIAAAAAAAAChXEiQ2AMAwEwYKQ0dlxXtqggTxOFS6eoF1NyU_VZNusUw4LpCUqVVuDlHVP7dNkDheIEv5fkcalcb1DTJKLXEADnOGHEzz8foLRcKNaAAAA"
}
```

### Error Responses
- **400** - Bad Request. The server could not understand the request due to malformed syntax.
- **401** - Unauthorized. The client is not authenticated.
- **403** - Forbidden. The client is not authorized.
- **500** - Internal Server Error. The server has encountered an error while processing the request.
```

--------------------------------

### Asset Rule Preview Results Example (JSON)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/asset-rules/asset-asset-rule-preview.md

Example JSON response body for a successful retrieval of asset rule preview results. It outlines the structure of the 'Assets' array, including asset ID, change type, and detailed asset information, along with statistics on streams and total results.

```json
{
  "Status": "status",
  "Assets": [
    {
      "AssetId": "assetId",
      "ChangeType": "changeType",
      "Asset": {
        "Id": "id",
        "AssetTypeId": "assetTypeId",
        "Name": "name",
        "Description": "description",
        "Metadata": [
          {
            "Id": "id",
            "Name": "name",
            "Description": "description",
            "SdsTypeCode": 18,
            "Value": "value",
            "Uom": "uom"
          }
        ],
        "StreamReferences": [
          {
            "Id": "id",
            "Name": "name",
            "Description": "description",
            "StreamId": "streamId"
          }
        ],
        "Status": {
          "Name": "name",
          "Description": "description",
          "StreamReferenceId": "streamReferenceId",
          "StreamPropertyId": "streamPropertyId",
          "ValueStatusMappings": [
            {
              "Value": "value",
              "Status": 1,
              "DisplayName": "displayName"
            }
          ]
        }
      }
    }
  ],
  "Statistics": {
    "Streams": 1,
    "TotalResults": 1
  }
}
```

--------------------------------

### List Tenant Billing Cycles 200 Response Body

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/operations/operations-usage.md

Example JSON response for a successful retrieval of tenant billing cycles. Contains a list of billing cycles with start and end dates.

```json
[
  {
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z"
  }
]
```

--------------------------------

### POST /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

Creates a signup for the list of resource identifiers provided. The signup will initially be in the Activating state and will transition to Active after background setup is complete.

```APIDOC
## POST /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups

### Description
Creates a signup for the list of resource identifiers provided. Upon creating your signup, it will be placed in the Activating SignupState. It is essential to invoke GetSignupById while your signup is in this Activating SignupState.

### Method
POST

### Endpoint
/api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - Tenant unique identifier
- **namespaceId** (string) - Required - Namespace unique identifier

### Request Body
- **Name** (string) - Required - Name of the signup
- **ResourceType** (string) - Required - Type of resources being subscribed to
- **ResourceIds** (array) - Required - List of resource identifiers

### Request Example
```json
{
  "Name": "string",
  "ResourceType": "Stream",
  "ResourceIds": [
    "string"
  ]
}
```

### Response
#### Success Response (202)
- **Id** (string) - Signup unique identifier
- **Name** (string) - Signup name
- **Owner** (object) - Signup owner information
- **CommunityId** (string) - Community identifier if applicable
- **Type** (string) - Resource type
- **CreatedDate** (string) - Creation timestamp
- **ModifiedDate** (string) - Last modification timestamp
- **SignupState** (string) - Current state of the signup

#### Response Example
```json
{
  "Id": "string",
  "Name": "string",
  "Owner": {
    "Type": "Client",
    "ObjectId": "string",
    "TenantId": "string"
  },
  "CommunityId": "string",
  "Type": "Stream",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z",
  "SignupState": "Activating"
}
```
```

--------------------------------

### Execute StreamView Data Transformation with HTTP GET

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/developer-guide/sequential-data-store-dev/sds-read-data.md

Demonstrates HTTP GET requests for reading transformed SDS stream data using SdsStreamView IDs. Includes examples for retrieving the first event, paginating 100 events from a start index, and fetching the most recent value. All requests require streamViewId as a query parameter to specify the target data shape.

```http
GET api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Data/Transform/First?streamViewId={streamViewId}
```

```http
#
```

--------------------------------

### Start Asset Rule Preview - HTTP

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/asset-rules/asset-asset-rule-preview.md

Initiates a preview of an asset rule configuration. Requires tenant and namespace IDs. Optional parameters control metadata preservation and pagination. Returns a preview link with expiration.

```HTTP
POST /api/v1-preview/tenants/{tenantId}/namespaces/{namespaceId}/preview/assetrules
?KeepOldMetadata={KeepOldMetadata}&Skip={Skip}&Count={Count}&PageSize={PageSize}
```

--------------------------------

### Get Unit of Measure - Example Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/sequential-data-store/sds-units-of-measure.md

Example response body for the Get Unit of Measure endpoint, returning a single SdsUom object.

```json
{
    "Id":"ounce",
    "Abbreviation":"oz",
    "Name":"ounce",
    "DisplayName":"ounce",
    "QuantityId":"Mass",
    "ConversionFactor":0.028349523
}
```

--------------------------------

### Update Signup Response Example (JSON)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

An example JSON response after a signup has been successfully updated. It mirrors the structure of a retrieved signup, confirming the changes made.

```json
{
  "Id": "string",
  "Name": "string",
  "Owner": {
    "Type": "Client",
    "ObjectId": "string",
    "TenantId": "string"
  },
  "CommunityId": "string",
  "Type": "Stream",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z",
  "SignupState": "Active"
}
```

--------------------------------

### Example Success Response for Get Statistics

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/data-views/data-views-data-views-resolved.md

An example JSON response for a successful 'Get Statistics' request. It details the resolution time, counts of data items, groups, and field mappings, along with nested structures for data field sets and individual data fields.

```json
HTTP 200 OK
{
    "TimeOfResolution": "2019-12-13T01:23:45Z",
    "DataItemCount": 24,
    "GroupCount": 2,
    "FieldMappingCount": 10,
    "DataFieldSets": [
        {
            "DataItemCount": 18,
            "UnmappedDataItemCount": 3,
            "DataFields": [
                {
                    "FieldMappingCount": 3,
                    "DataMappingCount": 6,
                    "EmptyDataMappingCount": 0,
                    "UnmappedGroupCount": 0
                },
                {
                    "FieldMappingCount": 3,
                    "DataMappingCount": 6,
                    "EmptyDataMappingCount": 2,
                    "UnmappedGroupCount": 1
                }
            ]
        },
        {
            "DataItemCount": 6,
            "UnmappedDataItemCount": 0,
            "DataFields": [
                {
                    "FieldMappingCount": 2,
                    "DataMappingCount": 4,
                    "EmptyDataMappingCount": 2,
                    "UnmappedGroupCount": 1
                }
            ]
        }
    ]
}
```

--------------------------------

### Get All Signups (API)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

Retrieves all signups within a tenant's namespace. Supports pagination with `skip` and `count` parameters. Requires `tenantId` and `namespaceId`. Optionally accepts `Community-Id` header for community-specific signups. Returns a `SignupCollection` on success.

```text
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups
?skip={skip}&count={count}
```

--------------------------------

### Example Create Signup Response (JSON)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

An example JSON response body for the 'Create Signup' API endpoint when the request is accepted (Status Code 202). It represents the newly created `Signup` object, showing its `Id`, `Name`, `Owner` details, `CommunityId`, `Type`, dates, and initial `SignupState` as 'Activating'.

```json
{
  "Id": "string",
  "Name": "string",
  "Owner": {
    "Type": "Client",
    "ObjectId": "string",
    "TenantId": "string"
  },
  "CommunityId": "string",
  "Type": "Stream",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z",
  "SignupState": "Activating"
}
```

--------------------------------

### Get Stream Metrics API Response Example

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/operations/operations-metrics.md

Example JSON response for the Get Stream Metrics API, showing a list of timestamped metric values. This structure is returned upon successful retrieval of stream metrics.

```json
[
  {
    "Timestamp": "2020-05-15T14:38:55.989531-07:00",
    "Value": 0.0
  },
  {
    "Timestamp": "2020-05-15T14:38:55.9925501-07:00",
    "Value": 0.0
  }
]
```

--------------------------------

### Get Sampled Data for Asset - Example JSON Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/assets/assets-asset-centric-data.md

Example JSON response for a 'Get Sampled Data' request. The 'Results' object contains an array of sampled data points, each with a timestamp and values for the requested streams. 'Errors' will be present on failure.

```json
{
  "Results": {
    "StreamReferenceWithEventsName": [
      {
        "Timestamp": "2019-01-02T00:00:00Z",
        "Temp": 0.044,
        "Pres": 1
      },
      {
        "Timestamp": "2019-01-02T00:16:38Z",
        "Temp": 998.046,
        "Pres": 1
      },
      {
        "Timestamp": "2019-01-02T01:00:00Z",
        "Temp": 155.5,
        "Pres": 1
      }
    ]
  },
  "Errors": null
}
```

--------------------------------

### Get Last Data for Asset - Example JSON Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/assets/assets-asset-centric-data.md

Example JSON response for a successful 'Get Last Data' request. It includes the 'Results' object containing stream references and their last known values, or an 'Errors' object if the request failed.

```json
{
  "Results": {
    "StreamReferenceWithEventsName": [
      {
        "Timestamp": "2019-01-02T01:00:00Z",
        "Temp": 155.5,
        "Pres": 1
      }
    ]
  },
  "Errors": null
}
```

--------------------------------

### Retrieve Signup by ID Response Example (JSON)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

An example JSON response for retrieving a signup. It details the structure of a signup object, including its ID, name, owner information, community ID, type, creation and modification dates, and its current signup state.

```json
{
  "Bookmark": "string",
  "Id": "string",
  "Name": "string",
  "Owner": {
    "Type": "Client",
    "ObjectId": "string",
    "TenantId": "string"
  },
  "CommunityId": "string",
  "Type": "Stream",
  "CreatedDate": "2019-08-24T14:15:22Z",
  "ModifiedDate": "2019-08-24T14:15:22Z",
  "SignupState": "Active"
}
```

--------------------------------

### IdentityProviderUserCapabilites JSON Example

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/identity/identity-identity-providers.md

Example JSON object detailing user-level capabilities for an identity provider, such as sign-in, invitation, and search support.

```json
{
  "SignIn": true,
  "Invitation": true,
  "Search": true
}
```

--------------------------------

### Example Trustee Response for Get Owner

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/metadata-rules/metadata-access-control-list.md

An example JSON response for successfully retrieving the owner (Trustee) of a metadata rule. Includes Type, TenantId, and ObjectId of the trustee.

```json
{
  "Type": 2,
  "TenantId": "00000000-0000-0000-0000-000000000000",
  "ObjectId": "00000000-0000-0000-0000-000000000000"
}
```

--------------------------------

### Example Solar Inverter Asset Configuration

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/developer-guide/data-views-dev/data-views-stream-asset-examples/data-views-asset-examples.md

Provides a complete JSON example of a solar inverter asset, including its ID, Name, detailed Metadata, and specific Stream References for Power In and Power Out.

```json
{
    "Id": "Biltmore Primary Inverter 0",
    "Name": "Biltmore Primary Inverter 0",
    "Metadata": [
        {
            "Id": "Site",
            "Name": "Site",
            "SdsTypeCode": "String",
            "Value": "Biltmore"
        },
        {
            "Id": "Meter",
            "Name": "Meter",
            "SdsTypeCode": "String",
            "Value": "Primary"
        },
        {
            "Id": "Inverter",
            "Name": "Inverter",
            "SdsTypeCode": "Int64",
            "Value": 0
        },
        {
            "Id": "Nominal Power",
            "Name": "Nominal Power",
            "SdsTypeCode": "Double",
            "Value": 1.21
        }
    ],
    "StreamReferences": [
        {
            "Id": "Power In",
            "Name": "Power In",
            "StreamId": "BILT.Meter.Primary.Inverter.0.PwrIn"
        },
        {
            "Id": "Power Out",
            "Name": "Power Out", 
            "StreamId": "BILT.Meter.Primary.Inverter.0.PwrOut"
        }
    ]
}
```

--------------------------------

### Create Signup (API)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

Creates a new signup for specified resources. The signup initially enters an 'Activating' state, requiring a subsequent `GetSignupById` call to transition to 'Active'. The request body includes the signup's `Name`, `ResourceType`, and `ResourceIds`. Requires `tenantId` and `namespaceId`. Optionally accepts `Community-Id` header. Returns a `Signup` object upon successful creation.

```json
{
  "Name": "string",
  "ResourceType": "Stream",
  "ResourceIds": [
    "string"
  ]
}
```

--------------------------------

### Get Identity Provider Group Mapping Roles Example Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/identity/identity-identity-providers.md

Example JSON response for the 'Get Identity Provider Group Mapping Roles' endpoint (Status Code 200). The response includes 'Results', detailing group information such as 'Id', 'Name', 'Email', 'IsClusterManagementAllowed', 'IdentityProviderClaimId', and 'RoleIds'. A 'SkipToken' is present for pagination.

```json
{
  "Results": [
    {
      "Id": "string",
      "Name": "string",
      "Email": "user@example.com",
      "IsClusterManagementAllowed": true,
      "IdentityProviderClaimId": "string",
      "RoleIds": [
        "string"
      ]
    }
  ],
  "SkipToken": "string"
}
```

--------------------------------

### Create Asset Rule Example

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/asset-rules/asset-asset-rules-overview.md

An example JSON structure for defining an asset rule. This includes expressions for extracting values from stream properties and outputs for defining generated assets. Requires specifications for stream matching and automation ID for permissions.

```json
{
   "Id":"sampleID",
   "Name":"sampleName",
   "Description":"sampleDescription",
   "AutomationId":"sampleAutomationID",
   "Expressions":[
      {
         "Field":"Id",
         "Specifications":[
            {
               "Type":"Group",
               "Name":"streamId"
            }
         ]
      },
      {
         "Field":"Name",
         "Specifications":[
            {
               "Type":"Group",
               "Name":"location",
               "StrictValueMappings":true,
               "ValueMappings":{
                  "SL":"San leandro",
                  "AUS":"Austin"
               }
            },
            {
               "Type":"Delimiter",
               "Value":"."
            },
            {
               "Type":"Literal",
               "Value":"test"
            }
         ]
      }
   ],
   "Outputs":[
      {
         "Field":"Asset",
         "Value":{
            "Id":"{location} asset",
            "Name":"{location} asset",
            "Description":"this is an asset generated by an asset rule",
            "Metadata":[
               {
                  "Id":"Location",
                  "Name":"Location",
                  "Description":"the location of the asset",
                  "SdsTypeCode":"18",
                  "Value":"{location}"
               }
            ],
            "StreamReferences":[
               {
                  "Id":"Rule Stream",
                  "Description":"a stream reference to the input stream that caused the rule to generate this asset",
                  "StreamId":"{streamId}"
               }
            ]
         }
      }
   ]
}
```

--------------------------------

### Get Asset - JSON Response (Success)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/assets/assets-assets.md

Example of a successful response when getting an asset. It returns a JSON object containing asset details, metadata, stream references, and tags.

```json
{
  "Id": "SampleAsset",
  "Description": "This is a sample asset.",
  "Metadata": [
    {
      "Id": "Id-abcde",
      "Name": "ModelNumber",
      "Description": "This is a static attribute on the asset which represents the model number.",
      "SdsTypeCode": "Double",
      "Value": 0.01
    }
  ],
  "StreamReferences": [
    {
      "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
      "Name": "Data",
      "Description": "This is the description for this stream reference.",
      "StreamId": "SdsStream_1"
    }
  ],
  "Tags": [
    "Tag1",
    "Tag2"
  ]
}
```

--------------------------------

### GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups/{signupId}/resources

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

This endpoint fetches a paginated list of resources associated with a signup, optionally filtered by accessibility. It supports skipping records and limiting results for efficient retrieval. The total count is provided in the response header.

```APIDOC
## GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups/{signupId}/resources

### Description
Retrieves a list of the signup's resources.

### Method
GET

### Endpoint
/api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups/{signupId}/resources?skip={skip}&count={count}&resourceFilter={resourceFilter}

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - Tenant identifier.
- **namespaceId** (string) - Required - Namespace identifier.
- **signupId** (string) - Required - Signup unique identifier.

#### Query Parameters
- **skip** (integer) - Optional - Zero-based offset of the first resource. Defaults to 0.
- **count** (integer) - Optional - Maximum number of resources to return. Defaults to 100.
- **resourceFilter** (any) - Optional - SignupResourceFilter to specify resource accessibility. If unspecified, all resources are returned.

#### Request Headers
|Header|Type|Required|Description|
|---|---|---|---|
|Community-Id|string|false|Community unique identifier. Must be provided if the signup contains shared resources.|

### Response
#### Success Response (200)
Returns the signup's resources as SignupResources.
- **Resources** (array) - List of resources.
  - **ResourceId** (string) - Resource identifier.
  - **IsAccessible** (boolean) - Accessibility status.

#### Response Example
{
  "Resources": [
    {
      "ResourceId": "string",
      "IsAccessible": true
    }
  ]
}

#### Response Headers
|Status|Header|Type|Description|
|---|---|---|---|
|200|Total-Count|integer|Total number of signup resources.|

#### Error Responses
- **400** - Bad request.
- **403** - Forbidden. The client does not have the required permissions.
- **404** - Not Found.
- **500** - Internal server error.
```

--------------------------------

### Example 200 Response for Bulk Get Resolved Assets

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/assets/assets-resolved-asset.md

This is an example of a successful (200 OK) response from the Bulk Get Resolved Assets API. It returns an array of resolved asset objects, each containing details like Id, Name, Metadata, and Streams. This format is useful for applications that need to process multiple asset details simultaneously.

```JSON
[
  {
    "Id": "Equipment1",
    "Name": "Equipment1",
    "Resolved": true,
    "Description": "An example asset",
    "AssetTypeId": "Equipment",
    "AssetTypeName": "Equipment",
    "Metadata": [
      {
        "Name": "site",
        "Id": "site",
        "SdsTypeCode": "String",
        "Value": "PHYL"
      }
    ],
    "Streams": [
      {
        "Name": "Reader1",
        "Type": {
          "Id": "TimeIndexedDouble",
          "SdsTypeCode": "Object",
          "Properties": [
            {
              "Id": "Timestamp",
              "IsKey": true,
              "SdsType": {
                "Id": "TimeIndexedDouble.Timestamp",
                "SdsTypeCode": "DateTime"
              },
              "InterpolationMode": "Default"
            },
            {
              "Id": "Value",
              "SdsType": {
                "Id": "TimeIndexedDouble.Value",
                "SdsTypeCode": "Double"
              },
              "InterpolationMode": "Default"
            }
          ]
        },
        "StreamReferenceName": "Reader1",
        "Id": "Reader1",
        "StreamId": "Equipment1-Reader1",
        "PropertyMaps": [
          {
            "Id": "Timestamp",
            "SourcePropertyId": "Timestamp"
          },
          {
            "Id": "Value",
            "SourcePropertyId": "Value"
          }
        ]
      }
    ],
    "UnresolvedStreams": [],
    "UnresolvedMetadata": [],
    "StatusDefinitionType": "StreamPropertyMapping",
    "Tags": []
  },
  {
    "Id": "Equipment2",
    "Name": "Equipment2",
    "Resolved": true,
    "Description": "Setup Script Asset Type",
    "AssetTypeId": "Equipment",
    "AssetTypeName": "Equipment",
    "Metadata": [
      {
        "Name": "site",
        "Id": "site",
        "SdsTypeCode": "String",
        "Value": "SLTC"
      }
    ],
    "Streams": [
      {
        "Name": "Reader1",
        "Type": {
          "Id": "TimeIndexedDouble",
          "SdsTypeCode": "Object",
          "Properties": [
            {
              "Id": "Timestamp",
              "IsKey": true,
              "SdsType": {
                "Id": "TimeIndexedDouble.Timestamp",
                "SdsTypeCode": "DateTime"
              },
              "InterpolationMode": "Default"
            },
            {
              "Id": "Value",
              "SdsType": {
                "Id": "TimeIndexedDouble.Value",
                "SdsTypeCode": "Double"
              },
              "InterpolationMode": "Default"
            }
          ]
        },
        "StreamReferenceName": "Reader1",
        "Id": "Reader1",
        "StreamId": "Equipment2-Reader1",
        "PropertyMaps": [
          {
            "Id": "Timestamp",
            "SourcePropertyId": "Timestamp"
          },
          {
            "Id": "Value",
            "SourcePropertyId": "Value"
          }
        ]
      }
    ],
    "UnresolvedStreams": [],
    "UnresolvedMetadata": [],
    "StatusDefinitionType": "StreamPropertyMapping",
    "Tags": []
  }
]
```

--------------------------------

### GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

Gets all signups in a tenant's namespace. Supports pagination through skip and count parameters. Can filter by community using the Community-Id header.

```APIDOC
## GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups

### Description
Gets all signups in a tenant's namespace.

### Method
GET

### Endpoint
/api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - Tenant unique identifier
- **namespaceId** (string) - Required - Namespace unique identifier

#### Query Parameters
- **skip** (integer) - Optional - Zero-based offset of the first signup to retrieve. Default is 0.
- **count** (integer) - Optional - Maximum number of signups to retrieve. Default is 100.

### Request Example
```text
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups?skip=0&count=100
```

### Response
#### Success Response (200)
- **Signups** (array) - Collection of Signup objects

#### Response Headers
- **Total-Count** (integer) - Total number of signups

#### Response Example
```json
{
  "Signups": [
    {
      "Id": "string",
      "Name": "string",
      "Owner": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "CommunityId": "string",
      "Type": "Stream",
      "CreatedDate": "2019-08-24T14:15:22Z",
      "ModifiedDate": "2019-08-24T14:15:22Z",
      "SignupState": "Activating"
    }
  ]
}
```
```

--------------------------------

### Create Template API Request

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/software-management/configuration-template.md

This snippet demonstrates how to create a new template using a POST request. The request body includes the template's name, type, version, description, and configuration. The response indicates whether the template was successfully created.

```HTTP
POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates
```

```JSON
{
  "Name": "string",
  "Type": "string",
  "Version": "string",
  "Description": "string",
  "Configuration": "string"
}
```

--------------------------------

### GET /api/v1/tenants/{tenantId}/usage

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/operations/operations-usage.md

Returns tenant usage data, based on active/completed billing cycles, and whether start and end parameters are provided or omitted. When start is provided and end is omitted, a single day of usage data is returned. When both start and end are provided, daily usage data is returned for the range provided.

```APIDOC
## GET /api/v1/tenants/{tenantId}/usage

### Description
Returns tenant usage data, based on active/completed billing cycles, and whether start and end parameters are provided or omitted. When start is provided and end is omitted, a single day of usage data is returned. When both start and end are provided, daily usage data is returned for the range provided.

### Method
GET

### Endpoint
/api/v1/tenants/{tenantId}/usage

### Parameters
#### Path Parameters
- **tenantId** (string) - Required - Tenant identifier

#### Query Parameters
- **start** (string) - Optional - Start date of the range for daily usage data
- **end** (string) - Optional - End date of the range for daily usage data; if no end date is provided, only one summary is returned.
- **groupByNamespace** (boolean) - Optional - Selection to order usage data by namespace

### Response
#### Success Response (200)
- **Array of UsageDataRecord objects** - Usage data for the requested tenant

#### Response Example
```json
[
  {
    "Date": "2019-08-24T14:15:22Z",
    "TenantId": "string",
    "NamespaceId": "string",
    "ClusterRegion": "string",
    "IngressEvents": 0,
    "IngressStreamsAccessed": 0,
    "EgressEvents": 0,
    "EgressStreamsAccessed": 0
  }
]
```

### Error Responses
- **400** - Missing or invalid inputs
- **401** - Unauthorized
- **403** - Forbidden
- **500** - Internal server error
```

--------------------------------

### RuleStateEnum

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/asset-rules/asset-asset-rule-preview.md

Enumeration for the state of a rule, either 'Started' or 'Stopped'.

```APIDOC
## RuleStateEnum

### Description
Enumeration for the state of a rule, either 'Started' or 'Stopped'.

### Enumerated Values

|Property|Value|
|---|---|
|Started|0|
|Stopped|1|
```

--------------------------------

### Bulk Create Assets API Response Example (JSON)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/assets/assets-assets.md

Example JSON response for a successful bulk asset creation. It includes details of created assets and any potential child errors.

```json
{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SampleAsset",
      "Description": "This is a sample asset.",
      "Metadata": [
        {
          "Id": "Id-abcde",
          "Name": "ModelNumber",
          "Description": "This is a static attribute on the asset which represents the model number.",
          "SdsTypeCode": "Double",
          "Value": 0.01
        }
      ],
      "StreamReferences": [
        {
          "Id": "5345e98d-dc43-4f9d-a666-158a3baaf244",
          "Name": "Data",
          "Description": "This is the description for this stream reference.",
          "StreamId": "SdsStream_1"
        }
      ],
      "Tags": [
        "Tag1",
        "Tag2"
      ]
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Resolution": "string",
      "Reason": "string",
      "StatusCode": 0,
      "property1": null,
      "property2": null
    }
  ]
}
```

--------------------------------

### List Access Rights - Example Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/software-management/access.md

This is an example of a successful (200 OK) JSON response body when listing access rights. It provides an array of strings representing the available common access rights.

```json
[
  "Read",
  "Write",
  "Delete",
  "ManageAccessControl"
]
```

--------------------------------

### API Response Example (CSV with Header)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/data-views/data-views-preview-data-views-data.md

Example response body for a successful API request (form=csvh). Returns data in a CSV format with a header row, clearly labeling Time, Temperature, Flowrate, and Volume columns. Enhances readability and data interpretability.

```csv
Time,Temperature,Flowrate,Volume
2018-01-01T00:00:00Z,24,44,245
2018-01-01T00:00:01Z,24,44,245
2018-01-01T00:00:02Z,24,44,245
```

--------------------------------

### Get Collection ACL - Example Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/software-management/access.md

This is an example of a successful (200 OK) JSON response body when retrieving the AccessControlList for the softwaremanagement collection. It details the trustees and their access rights.

```json
{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "00000000-0000-0000-0000-000000000000"
      },
      "AccessType": 0,
      "AccessRights": 15
    }
  ]
}
```

--------------------------------

### SdsStreamViewMap Success Response Example

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/sequential-data-store/sds-stream-views.md

Example of a successful JSON response (HTTP 200) for the Get Stream View Map API. It includes source and target type IDs, along with a list of property mappings, which can include a mode for transformations.

```json
HTTP/1.1 200
Content-Type: application/json
{
    "SourceTypeId": "Simple",
    "TargetTypeId": "Simple3",
    "Properties": [
        {
            "SourceId": "Time",
            "TargetId": "Time"
        },
        {
            "SourceId": "Measurement",
            "TargetId": "Value",
            "Mode": 20
        },
        {
            "SourceId": "State",
            "Mode": 2
        },
        {
            "TargetId": "State",
            "Mode": 1
        }
    ]
}
```

--------------------------------

### Start Metadata Rule Preview API Request

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/metadata-rules/metadata-metadata-rule-preview.md

Initiates a preview for a metadata rule, generating a RulePreviewResponse. It requires tenant and namespace IDs, and optionally accepts parameters to control the preview process. The request body must contain a RuleModel object.

```text/http
POST /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/preview/metadatarules?KeepOldMetadata={KeepOldMetadata}&Skip={Skip}&Count={Count}&PageSize={PageSize}
```

--------------------------------

### List Templates API Request

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/software-management/configuration-template.md

This snippet shows how to make a GET request to list templates. The request includes optional parameters for pagination, sorting, and filtering. The response includes a list of templates with details such as ID, name, type, version, and description.

```HTTP
GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/SoftwareManagement/Templates
?skip={skip}&count={count}&orderBy={orderBy}&query={query}
```

--------------------------------

### Get Progress - 200 Response

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/rules/asset-rules/asset-asset-rules.md

Example JSON response representing the 'Running' state of a rule's execution progress.

```json
{
  "State": "Running"
}
```

--------------------------------

### Get Enumeration Response Examples

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/event-type-store/event-type-store-enumeration-types.md

Example JSON responses for successful enumeration retrieval (200) and error cases including bad requests (400). The successful response includes enumeration details with members, version, and state information.

```json
{
  "Id": "SimpleEnumeration",
  "Name": "SimpleEnumeration",
  "GraphQLName": "SimpleEnumeration",
  "Members": [
    {
      "Name": "ACTIVE",
      "GraphQLName": "ACTIVE",
      "Code": 0,
      "State": "Active",
      "Description": "This is an active state"
    },
    {
      "Name": "CLOSED",
      "GraphQLName": "CLOSED",
      "Code": 1,
      "State": "Active",
      "Description": "This is a closed state"
    }
  ],
  "Version": 1,
  "State": "Active",
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z"
}
```

```json
{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "property1": null,
  "property2": null
}
```

--------------------------------

### Retrieve Signup by ID (GET API)

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/change-broker/change-broker-signups.md

Fetches a specific signup using its unique identifier. The response includes the signup's state and modification date, with additional properties based on the state. It requires tenant, namespace, and signup IDs as path parameters.

```text
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups/{signupId}
```

--------------------------------

### Get SdsType Success Response Example

Source: https://github.com/aveva/connect-data-services-developer-docs/blob/main/content/api-reference/sequential-data-store/sds-types.md

Example of a successful HTTP 200 response when retrieving an SdsType. The response body is a JSON object detailing the type's ID, Name, SdsTypeCode, and its Properties, including nested types.

```json
HTTP/1.1 200
Content-Type: application/json

{
"Id":"Simple",
"Name":"Simple",
"SdsTypeCode":1,
"Properties":[
    {
        "Id":"Time",
        "Name":"Time",
        "IsKey":true,
        "SdsType":{
            "Id":"19a87a76-614a-385b-ba48-6f8b30ff6ab2",
            "Name":"DateTime",
            "SdsTypeCode":16
        }
    },
    {
        "Id":"State",
        "Name":"State",
        "SdsType":{
            "Id":"e20bdd7e-590b-3372-ab39-ff61950fb4f3",
            "Name":"State",
            "SdsTypeCode":609,
            "Properties":[
                {
                    "Id":"Ok",
                    "Value":0
                },
                {
                    "Id":"Warning",
                    "Value":1
                },
                {
                    "Id":"Alarm",
                    "Value":2
                }
            ]
        }
    },
    {
        "Id":"Measurement",
        "Name":"Measurement",
        "SdsType":{
            "Id":"6fecef77-20b1-37ae-aa3b-e6bb838d5a86",
            "Name":"Double",
            "SdsTypeCode":14
        }
    }
]
}
```