Channels

Changed on
get/api/v2/channels

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

type'sub' | 'pub' | 'download' | 'upload'

Channel type

useAnonymousExtChannelboolean
payloadEncryptionboolean
messageFormsboolean

Response

Gives channels based on type from query

fqcnstring required

Channel type

messageFormsboolean required

Message forms

payloadEncryptionboolean required

Channel encryption

type'sub' | 'pub' | 'download' | 'upload' required

Channel type

useAnonymousExtChannelboolean required

Use anonymous external channel

Example response

[
  {
    "fqcn": "channel.name",
    "payloadEncryption": true,
    "type": "sub",
    "conditions": {
      "dids": [
        "did:ethr:volta:0x09Df5d33f1242E1b8aA5E0E0F6BfA687E6846993"
      ],
      "roles": [
        "marketoperator.roles"
      ],
      "qualifiedDids": [
        "did:ethr:volta:0x09Df5d33f1242E1b8aA5E0E0F6BfA687E6846993",
        "did:ethr:volta:0x3Ce3B60427b4Bf0Ce366d9963BeC5ef3CBD06ad5"
      ],
      "topics": [
        {
          "topicName": "operatorEnvelope",
          "owner": "aemo.edge",
          "topicId": "622fed6e4258501225095045"
        }
      ],
      "responseTopics": [
        {
          "topicName": "operatorEnvelope",
          "topicOwner": "aemo.edge",
          "topicId": "622fed6e4258501225095045",
          "responseTopicId": "622fed6e4258501225095045"
        }
      ]
    }
  }
]

Changes

  • ba62234d6c7aRevision changes
    • info

      added the required property ////// to the response with the status

  • fa8e74fc2211Revision changes
    • info

      added the new optional query request parameter messageForms

    • info

      added the new optional query request parameter payloadEncryption

    • info

      added the new optional query request parameter useAnonymousExtChannel

    • info

      the query request parameter type became optional

    • info

      added the required property / to the response with the status