All pages
Powered by GitBook
1 of 1

Loading...

Previews the policy from IPFS without loading it into the local DB

Returns preview of the remote policies.

post

Returns preview of the remote policies.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
messageIdstringRequired
Responses
200

Policy preview.

application/json
401

Unauthorized.

403

Forbidden.

500

Internal server error.

application/json
post
/external-policies/preview
{
  "module": {
    "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": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "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"
      }
    ]
  },
  "messageId": "0000000000.000000001",
  "schemas": [
    []
  ],
  "tags": [
    []
  ],
  "moduleTopicId": "0.0.1"
}
POST /api/v1/external-policies/preview HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "messageId": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}