List all the schemas and policy relevant to the rule with the specified ID

Retrieves schema rule relationships.

get

Retrieves schema rule relationships for the specified ID.

Authorizations

Path parameters

ruleIdstringrequired

Schema Rule Identifier

Example: 000000000000000000000001

Responses

application/json

objectoptional

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/schema-rules/{ruleId}/relationships HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "policy": {
    "id": "000000000000000000000001",
    "uuid": "00000000-0000-0000-0000-000000000000",
    "name": "Policy name",
    "description": "Description",
    "topicDescription": "Description",
    "policyTag": "Tag",
    "status": "DRAFT",
    "creator": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
    "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
    "topicId": "0.0.1",
    "messageId": "0000000000.000000001",
    "codeVersion": "1.0.0",
    "createDate": "1900-01-01T00:00:00.000Z",
    "version": "1.0.0",
    "config": {},
    "userRole": "Installer",
    "userRoles": [
      "Installer"
    ],
    "userGroup": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "role": "Installer",
      "groupLabel": "Label",
      "groupName": "Name",
      "active": true
    },
    "userGroups": [
      {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "role": "Installer",
        "groupLabel": "Label",
        "groupName": "Name",
        "active": true
      }
    ],
    "policyRoles": [
      "Registrant"
    ],
    "policyNavigation": [
      {
        "role": "Registrant",
        "steps": [
          {
            "block": "Block tag",
            "level": 1,
            "name": "Step name"
          }
        ]
      }
    ],
    "policyTopics": [
      {
        "name": "Project",
        "description": "Project",
        "memoObj": "topic",
        "static": false,
        "type": "any"
      }
    ],
    "policyTokens": [
      {
        "tokenName": "Token name",
        "tokenSymbol": "Token symbol",
        "tokenType": "non-fungible",
        "decimals": "",
        "changeSupply": true,
        "enableAdmin": true,
        "enableFreeze": true,
        "enableKYC": true,
        "enableWipe": true,
        "templateTokenTag": "token_template_0"
      }
    ],
    "policyGroups": [
      {
        "name": "Group name",
        "creator": "Registrant",
        "groupAccessType": "Private",
        "groupRelationshipType": "Multiple",
        "members": [
          "Registrant"
        ]
      }
    ],
    "categories": [
      "text"
    ],
    "projectSchema": "00000000-0000-0000-0000-000000000000",
    "tests": [
      {
        "id": "000000000000000000000001",
        "uuid": "00000000-0000-0000-0000-000000000000",
        "name": "Test Name",
        "policyId": "000000000000000000000001",
        "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
        "status": "New",
        "date": "1900-01-01T00:00:00.000Z",
        "duration": 0,
        "progress": 0,
        "resultId": "00000000-0000-0000-0000-000000000000",
        "result": "text"
      }
    ]
  },
  "schemas": [
    {
      "id": "000000000000000000000001",
      "uuid": "00000000-0000-0000-0000-000000000000",
      "name": "Schema name",
      "description": "Description",
      "entity": "POLICY",
      "iri": "00000000-0000-0000-0000-000000000000",
      "status": "DRAFT",
      "topicId": "0.0.1",
      "version": "1.0.0",
      "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
      "messageId": "0000000000.000000001",
      "category": "POLICY",
      "documentURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "contextURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "document": {},
      "context": {}
    }
  ]
}