Schema Flow
Policy Flow
Available Schema Types
FAQs
Multi - User Roles
Demo Using APIs

1. Login as a User

1.1 Get the list of policies.

get
/api/v1/policies/
Displaying list of policies

1.2 In the policy config there is a root block which is the top of the structure

1.3 Request the config for the root block

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/97379c43-2bce-4e67-9817-a79fbad3e53d
Requesting configuration of root block

1.4 Root block contains other blocks in the 'blocks' field. Request the config for the block by the block ID. Recursively repeat this operation for all contained blocks in order to construct all components.

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/bb342b37-8bb6-4595-93fc-98fd63a23c16
Requesting configuration of block by block ID

1.5 At present only PolicyRolesBlock is available to the user. Select the "INSTALLER" role.

post
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/bb342b37-8bb6-4595-93fc-98fd63a23c16
Registering the role as

1.6 Request the root block and all contained blocks.

1.6.1 Requesting InterfaceStepBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/97379c43-2bce-4e67-9817-a79fbad3e53d
Requesting InterfaceStepBlock

1.6.2 Requesting requestVCDocumentBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/9d98e2fd-6d2b-4152-b48c-cf10eb4f1298
Request requestVCDocumentBlock

1.6.3 Requesting Installer Details

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/53dac8a9-b480-457e-920a-e4d4c653bfbe
Requesting Installer Details

1.7 Create json according to the schema and send to the requestVCDocumentBlock

post
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/53dac8a9-b480-457e-920a-e4d4c653bfbe
Creating JSON and sending it to requestVCDocumentBlock

1.8 Request the root block and all contained blocks again.

1.8.1 Requesting InterfaceStepBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/97379c43-2bce-4e67-9817-a79fbad3e53d
Requesting InterfaceStepBlock

1.8.2 Requesting InformationBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/9d98e2fd-6d2b-4152-b48c-cf10eb4f1298
Requesting InformationBlock

1.8.3 Requesting data after approval

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/2368a338-adaa-434a-a7a0-803e009e5717
Waiting for the data to be approval

2. Login as a Standard Registry

2.1 Request the list of policies.

get
/api/v1/policies
Request List of policies

2.2 Request the root block and all contained blocks.

2.2.1 Requesting InterfaceContainerBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/97379c43-2bce-4e67-9817-a79fbad3e53d
Requesting InterfaceContainerBlock

2.2.2 Requesting InterfaceContainerBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/77da138a-c455-4ec6-8202-fd6a529f5300
Requesting InterfaceContainerBlock

2.2.3 Requesting InterfaceDocumentsSourceBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/e5c40e14-3970-4f40-9e2c-34a260e6f499
Requesting InterfaceDocumentsSourceBlock

2.2.4 Requesting Approval

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/d5c7c788-696d-457d-985e-dce3886b726
Requesting Approval
get
/api/v1/policies/621376c8e6763a0014fb0de4/tag/approve_documents_btn
Requesting BlockID
get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/6f0f37c0-b62b-4be5-b1d0-e8114398350d
Requesting InterfaceActioBlock

2.4 Approve the document

Select the VC from the grid:
const VC = data[0];
Change status:
VC.option.status = "APPROVED";
Send to the VC:
POST /api/v1/policies/621376c8e6763a0014fb0de4/blocks/6f0f37c0-b62b-4be5-b1d0-e8114398350d
Request:
VC

3. Login as the User

3.1 Request the root block and all the contained blocks.

3.1.1 Requesting InterfaceStepBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/97379c43-2bce-4e67-9817-a79fbad3e53d
Requesting InterfaceStepBlock

3.1.2 Requesting InterfaceContainerBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/9d98e2fd-6d2b-4152-b48c-cf10eb4f1298
Requesting InterfaceContainerBlock

3.1.3 Requesting multiple InterfaceContainerBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/7b9273a1-1398-4560-be19-cc59d6c4c752
Requesting multiple InterfaceContainerBlock

3.1.4 Requesting InterfaceDocumentsSourceBlock and InterfaceStepBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/4008376b-0047-4004-83df-cf4c3555fc33
Requesting InterfaceDocumentsSourceBlock and InterfaceStepBlock

3.1.5 Requesting Data

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/af9fd59b-06a3-48b5-b610-b0af7888e39b
Requesting Data

3.1.6 Requesting requestVCDocumentBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/06cfd440-03ec-471e-9b3f-e0c583555b94
Requesting requestVCDocumentBlock

3.1.7 Requesting Data and Schema

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/d068b59e-eec7-4452-b866-468e9ed6c7fa
Requesting Data and Schema
get
/api/v1/policies/621376c8e6763a0014fb0de4/tag/download_config_btn
Requesting BlockID

3.2.1 Requesting InterfaceActionBlock

get
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/24942cf7-fcc5-4dff-8471-d5affeb4c206
Requesting InterfaceActionBlock

3.3 Create a sensor

post
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/d068b59e-eec7-4452-b866-468e9ed6c7fa
Creating a Sensor

3.4 Refresh the Blocks

3.5 Download the config

post
/api/v1/policies/621376c8e6763a0014fb0de4/blocks/24942cf7-fcc5-4dff-8471-d5affeb4c206
Downloading the configuration

3.6 Sample MRV Sender Data

post
/external
Sending MRV Data
Copy link
Edit on GitHub
On this page
1. Login as a User
1.1 Get the list of policies.
get
Displaying list of policies
1.2 In the policy config there is a root block which is the top of the structure
1.3 Request the config for the root block
get
Requesting configuration of root block
1.4 Root block contains other blocks in the 'blocks' field. Request the config for the block by the block ID. Recursively repeat this operation for all contained blocks in order to construct all components.
get
Requesting configuration of block by block ID
1.5 At present only PolicyRolesBlock is available to the user. Select the "INSTALLER" role.
post
Registering the role as
1.6 Request the root block and all contained blocks.
get
Requesting InterfaceStepBlock
get
Request requestVCDocumentBlock
get
Requesting Installer Details
1.7 Create json according to the schema and send to the requestVCDocumentBlock
post
Creating JSON and sending it to requestVCDocumentBlock
1.8 Request the root block and all contained blocks again.
get
Requesting InterfaceStepBlock
get
Requesting InformationBlock
get
Waiting for the data to be approval
2. Login as a Standard Registry
2.1 Request the list of policies.
get
Request List of policies
2.2 Request the root block and all contained blocks.
get
Requesting InterfaceContainerBlock
get
Requesting InterfaceContainerBlock
get
Requesting InterfaceDocumentsSourceBlock
get
Requesting Approval
2.3 In the 'Status Operation' field , there is a link to "approve_documents_btn" block, which requests the Block ID.
get
Requesting BlockID
get
Requesting InterfaceActioBlock
2.4 Approve the document
3. Login as the User
3.1 Request the root block and all the contained blocks.
get
Requesting InterfaceStepBlock
get
Requesting InterfaceContainerBlock
get
Requesting multiple InterfaceContainerBlock
get
Requesting InterfaceDocumentsSourceBlock and InterfaceStepBlock
get
Requesting Data
get
Requesting requestVCDocumentBlock
get
Requesting Data and Schema
3.2 In the fields of the grid there is a link to the "download_config_btn" bloc.
get
Requesting BlockID
get
Requesting InterfaceActionBlock
3.3 Create a sensor
post
Creating a Sensor
3.4 Refresh the Blocks
3.5 Download the config
post
Downloading the configuration
3.6 Sample MRV Sender Data
post
Sending MRV Data