All pages
Powered by GitBook
1 of 32

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Retirement APIs

Approving Wipe Requests

Approve wipe request.

POST /contracts/wipe/requests/{requestId}/approve

Approve wipe contract request. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Clearing Wipe Requests

Clear wipe requests.

DELETE /contracts/wipe/{contractId}/requests

Clear wipe contract requests. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Get Contract Permissions

Get contract permissions

GET /contracts/{contractId}/permissions

Get smart-contract permissions. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Adding Retire Admin

Add retire admin.

POST /contracts/retire/{contractId}/admin/{hederaId}

Add retire contract admin. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Removing Wipe Admin

Remove wipe admin.

DELETE /contracts/wipe/{contractId}/admin/{hederaId}

Remove wipe contract admin. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Deleting Retire Requests

Clear retire requests.

DELETE /contracts/retire/{contractId}/requests

Clear retire contract requests. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Approving Retire Request

Approve retire request.

POST /contracts/retire/requests/{requestId}/approve

Approve retire contract request. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Retiring Tokens

Retire tokens.

POST /contracts/retire/pools/{poolId}/retire

Retire tokens.

Path Parameters

Name
Type
Description

Enabling Wipe Requests

Enable wipe requests.

POST /contracts/wipe/{contractId}/requests/enable

Enable wipe contract requests. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Unsetting Retire Pool

Unset retire pool.

DELETE /contracts/retire/pools/{poolId}

Unset retire contract pool. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Adding Wipe Wiper

Add wipe wiper.

POST /contracts/wipe/{contractId}/wiper/{hederaId}

Add wipe contract wiper. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Deleting Retire Pools

Clear retire pools.

DELETE /contracts/retire/{contractId}/pools

Clear retire contract pools. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Setting Retire Pools

Set retire pool.

POST /contracts/retire/{contractId}/pools

Set retire contract pool. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Returns a list of all Wipe requests

Return a list of all wipe requests

GET /contracts/wipe/requests

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

Query Parameters

Name
Type
Description

Returning list of all Retire Pools

Return a list of all retire pools.

GET /contracts/retire/pools

Returns all retire pools.

Query Parameters

Name
Type
Description

Creating new Contract

Creates new contract.

POST /contracts

Creates new contract. Only users with the Standard Registry role are allowed to make the request.

Request Body

Name
Type
Description

Cancelling Retire Request

Cancel retire request.

DELETE /contracts/retire/requests/{requestId}/cancel

Cancel retire contract request.

Path Parameters

Name
Type
Description

Unsetting Retire Request

Unset retire request.

DELETE /contracts/retire/requests/{requestId}

Unset retire contract request. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Returning all Retired VCs

Return a list of all retire vcs.

GET /contracts/retire

Returns all retire vcs.

Query Parameters

Name
Type
Description

Removing Retire Admin

Remove retire admin.

DELETE /contracts/retire/{contractId}/admin/{hederaId}

Remove retire contract admin. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Removing Wipe Manager

Remove wipe manager

DELETE /contracts/wipe/{contractId}/manager/{hederaId}

Remove wipe contract manager. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Rejecting Wipe Requests

Reject wipe request.

DELETE /contracts/wipe/requests/{requestId}/reject

Reject wipe contract request. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Query Parameters

Name
Type
Description

Removing Wipe Wiper

Remove wipe wiper

DELETE /contracts/wipe/{contractId}/wiper/{hederaId}

Remove wipe contract wiper. Only users with the Standard Registry role are allowed to make the request.

Removing Contract

Remove contract.

DELETE /contracts/{contractId}

Remove smart-contract. Only users with the Standard Registry role are allowed to make the request.

Syncing Retire Pools

Sync retire pools.

POST /contracts/retire/{contractId}/pools/sync

Sync retire contract pools. Only users with the Standard Registry role are allowed to make the request.

Adding Wipe Manager

Add wipe manager.

POST /contracts/wipe/{contractId}/manager/{hederaId}

Add wipe contract manager. Only users with the Standard Registry role are allowed to make the request.

Disabling Wipe Requests

Disable wipe requests.

POST /contracts/wipe/{contractId}/requests/disable

Disable wipe contract requests. Only users with the Standard Registry role are allowed to make the request.

Importing new Contract

Import new Contract

POST /contracts/import

Creates new contract. Only users with the Standard Registry role are allowed to make the request.

Path Parameters
Name
Type
Description

hederaId*

String

Hedera Identifier

contractId*

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'
Path Parameters
Name
Type
Description

contractId*

String

Contract Identifier

content:
            application/json:
              schema:
                type: boolean

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Path Parameters
Name
Type
Description

contractId

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/Date'

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'
Path Parameters
Name
Type
Description

hederaId*

String

Hedera ID

contractId*

String

Contract ID

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'
Path Parameters
Name
Type
Description

contractId

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'
Request Body
Name
Type
Description

contractId*

String

Request Object Parameters.

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

hederaId*

String

Hedera Identifier

contractId*

String

Contract Identifier

requestId*

String

Request Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

contractId*

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

contractID*

String

Contract Identifier

content:
            application/json:
              schema:
                type: number
 content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

hederaId*

String

Hedera Identifier

contractId*

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

hederaId*

String

Hedera Identifier

contractId*

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

contractId

Strng

Contract Identifier

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

requestId*

String

Request Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

poolId

String

Pool Identifier

content:
            application/json:
              schema:
                type: boolean
 content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

contractId

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

poolId

String

Pool Identifier

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

contractId

String

Contract Identifier

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

contractId

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetirePoolDTO'
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

pageIndex

number

The number of pages to skip before starting to collect the result

pageSize

number

The numbers of items to return

contractId

String

Contract Identifier

          headers:
            x-total-count:
              schema:
                type: integer
              description: Total items in the collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WiperRequestDTO'
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

tokens

String

Tokens

contractId

String

Contract Identifier

pageSize

number

The numbers of items to return

pageIndex

number

The number of pages to skip before starting to collect the result set

headers:
            x-total-count:
              schema:
                type: integer
              description: Total items in the collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RetirePoolDTO'
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

*

String

Request Object Parameters.

{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDTO'
}
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'
}

requestId*

String

Request Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

requestId

String

Request Identifier

content:
            application/json:
              schema:
                type: boolean
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

pageSize

String

The numbers of items to return

pageIndex

Sring

The number of pages to skip before starting to collect the result set

headers:
            x-total-count:
              schema:
                type: integer
              description: Total items in the collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/'
content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

hederaId*

String

Hedera Identifier

contractId*

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

hederaId*

String

Hedera Identifier

contractId*

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

requestId*

String

Request Identifier

ban

boolean

Reject and ban

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

Adding Wipe Admin

Add wipe admin.

POST /contracts/wipe/{contractId}/admin/{hederaId}

Add wipe contract admin. Only users with the Standard Registry role are allowed to make the request.

Path Parameters

Name
Type
Description

Returning list of all Retire Requests

Return a list of all retire requests.

GET /contracts/retire/requests

Returns all retire requests.

Query Parameters

Name
Type
Description

Returning all contracts

Returns all contracts.

GET /contracts

Returns all contracts.

Query Parameters

Name
Type
Description

hederaId*

String

Hedera Identifier

contractId*

String

Contract Identifier

content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDTO'

contractId

String

Contract Identifier

pageSize

Number

The numbers of items to return

pageIndex

Number

The number of pages to skip before starting to collect the result set

headers:
            x-total-count:
              schema:
                type: integer
              description: Total items in the collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RetireRequestDTO'

type

String

Contract Type

pageIndex*

Number

The number of pages to skip before starting to collect the result set

pageSize*

Number

The numbers of items to return

{
    headers:
            x-total-count:
              schema:
                type: integer
              description: Total items in the collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Contract'
}
{
   content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
}