All pages
Powered by GitBook
1 of 14

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Creating Virtual Account

Create a new virtual account

POST /policies/{policyId}/dry-run/user

Create a new virtual account. Only users with the Standard Registry role are allowed to make the request

Path Parameters

Name
Type
Description

policyId*

String

Policy ID

{
    content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    username:
                      type: string
                    did:
                      type: string 
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

Dry Run Mode using APIs

Logging Virtual User

Logs virtual user into the system

POST /policies/{policyId}/dry-run/login

Logs virtual user into the system. Only users with the Standard Registry role are allowed to make the request

Path Parameters

Name
Type
Description

Request Body

Name
Type
Description

Returning all Virtual Users

Returns all virtual users

GET /policies/{policyId}/dry-run/users

Returns all virtual users. Only users with the Standard Registry role are allowed to make the request

Path Parameters

Name
Type
Description

Returns List of Transactions

Returns lists of virtual transactions

GET /policies/{policyId}/dry-run/transactions

Returns lists of virtual transactions. Only users with the Standard Registry role are allowed to make the request

Running Policy without making any changes

Dry Run policy

PUT /policies/{policyId}/dry-run

Run policy without making any persistent changes or executing transaction. Only users with the Standard Registry role are allowed to make the request.

Deletes SavePoint

Path Parameters
Name
Type
Description

policyId*

String

Policy ID

{
     content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishPolicy'
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

policy ID*

String

policy ID

*

Object

Virtual User

{
    content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    username:
                      type: string
                    did:
                      type: string
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

policyId*

String

Policy ID

{
    content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    username:
                      type: string
                    did:
                      type: string
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}
Path Parameters
Name
Type
Description

policyId*

String

Policy ID

{
   content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    createDate:
                      type
{
    // Response
}
{
    // Response
}

Restarting the execution of Policy

Restarts the execution of the policy

POST /policies/{policyId}/dry-run/restart

Restarts the execution of the policy. Clear data in database. Only users with the Standard Registry role are allowed to make the request

Path Parameters

Name
Type
Description

Returns List of IPFS Files

Returns lists of IPFS files.

GET /policies/{policyId}/dry-run/ipfs

Returns lists of IPFS files. Only users with the Standard Registry role are allowed to make the request

Path Parameters

Name
Type
Description

Returns Savepoint State

Restoring SavePoint

Returns List of Artifacts

Returns lists of virtual artifacts

GET /policies/{policyId}/dry-run/artifacts

Returns lists of virtual artifacts. Only users with the Standard Registry role are allowed to make the request

Returning Policy to Editing

Return policy to editing

PUT /policies/{policyId}/draft

Return policy to editing. Only users with the Standard Registry role are allowed to make the request

{
    // Response
}
:
string
type:
type: string
hederaAccountId:
type: string
}
Path Parameters
Name
Type
Description

policyId*

String

Policy ID

{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishPolicy'
}
{
    // Response
}
{
    // Response
}
{
   content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

policyId*

String

Policy ID

{
    // Response
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}

policyId*

String

Policy ID

{
    content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    createDate:
                      type: string
                    documentURL:
                      type: string
                    document:
                      type: object
}
{
    // Response
}
{
    // Response
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

}
Path Parameters
Name
Type
Description

policyId*

String

Policy ID

{
    content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    createDate:
                      type
{
    // Response
}
{
    // Response
}

Create Savepoint

{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}
:
string
type:
type: string
owner:
type: string
}

Delete dry-run savepoint.

post

Delete dry-run savepoint. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 000000000000000000000001
Body
stringOptional
Responses
200

.

No content

401

Unauthorized.

403

Forbidden.

500

Internal server error.

application/json
post
/policies/{policyId}/savepoint/delete

Get savepoint state.

get

Get savepoint state. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 000000000000000000000001
Body
stringOptional
Responses
200

.

No content

401

Unauthorized.

403

Forbidden.

500

Internal server error.

application/json
get
/policies/{policyId}/savepoint/restore

Restore dry-run savepoint.

post

Restore dry-run savepoint. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 000000000000000000000001
Body
stringOptional
Responses
200

.

No content

401

Unauthorized.

403

Forbidden.

500

Internal server error.

application/json
post
/policies/{policyId}/savepoint/restore

Create dry-run savepoint.

post

Create dry-run savepoint. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 000000000000000000000001
Body
stringOptional
Responses
200

.

No content

401

Unauthorized.

403

Forbidden.

500

Internal server error.

application/json
post
/policies/{policyId}/savepoint/create

No content

No content

No content

No content

POST /api/v1/policies/{policyId}/savepoint/delete HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
GET /api/v1/policies/{policyId}/savepoint/restore HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
POST /api/v1/policies/{policyId}/savepoint/restore HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
POST /api/v1/policies/{policyId}/savepoint/create HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"