Sign in now

Managed Apps

Last updated: May 29, 2019

XLDB

Xooa Ledger Database (XLDB) is comprised of two databases: A mutable document datastore called the State Database, i.e. World State, and an immutable database called the Transaction Database, or simply the Ledger. The Ledger is an append-only, and is cryptographically protected against modifications using blockchain technology.

XLDB World State

World State provides:

  • Access to the state database of XLDB.
  • Ability to search the state database using key or value.
  • Create a new transaction. It will create a new key-value pair and reflect in the World State.
  • Check the history of values for the associated key from the world state.
  • Modify or delete the key and its associated value from the world state.

XLDB Transactions

The transactions tab allows you to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction ID and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • tx ID

      A unique transaction ID of the current transaction.

XLDB API

Sandbox

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • API Explorer

    Test the API endpoints for XLDB upon authorizing use for the identity API token.

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

XLDB Activities

Provides a history of activity related to the app. Activities include redeploying the app, identity-related actions, and upgrades.

XLDB Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • Delete identities: Available only for identities not generated from XLDB integrations
  • Update identities: Available only for identities not generated from XLDB integrations
  • Regenerate an API key for an identity: Available only for identities not generated from XLDB integrations
  • Identity ID

    A unique identifier for the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Updates the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.

XLDB Manage

Endorsement Policy (Only for hyperledger fabric apps)

Defining a custom endorsement policy will allow External Peers to endorse transactions for the app.

Add Principal

Add an organization taking part in the endorsement under the same AND/OR expression.

Add Expression

Add a different condition of endorsement.

AND expression will allow the transaction to be committed only when endorsing peers from all the added organizations endorses the transaction.

OR expression will allow the transaction to be committed when endorsing peers from any of the added organizations endorses the transaction.

Apply endorsement policy

Applying the endorsement policy will upgrade the app and the new policy will take effect immediately.

Asset Management

The Asset Management is a Xooa managed smart contract app. It provides the APIs to maintain the assets and their ownership. An asset is comprised of mutable and immutable components which are asset details and asset properties respectively.

Asset World State

World State provides:

  • Access to the state database of Asset Management ledger. It includes the latest owners and asset details.
  • Ability to search the state database using a key or value.
  • Check the history of values for the associated key in the world state.

Asset Transactions

The transactions tab allows you to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, and date range
    • Key

      The key can be an owner or asset ID.

    • Value

      The value contains the details about the asset and the owner.

    • Updated At

      The time at which the transaction was made.

    • tx ID

      A unique transaction ID for the current transaction.

Asset API

Sandbox

  • API Endpoint

    Endpoint for calling functions in the smart contract for managing assets.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • API Explorer

    Test the API endpoints for managing assets upon authorizing an identity’s API token

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

Asset Activities

Provides a history of activity related to the app. Activities include redeploying the app, identity-related actions, and upgrades.

Asset Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Delete identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.
  • Public Key

    A public identifier of the identity. Use the public key to share with other participants to get assets transfered to you.

Asset Manage

Endorsement Policy (Only for hyperledger fabric apps)

Defining a custom endorsement policy will allow External Peers to endorse transactions for the app.

Add Principal

Add an organization taking part in the endorsement under the same AND/OR expression.

Add Expression

Add a different condition of endorsement.

AND expression will allow the transaction to be committed only when endorsing peers from all the added organizations endorses the transaction.

OR expression will allow the transaction to be committed when endorsing peers from any of the added organizations endorses the transaction.

Apply endorsement policy

Applying the endorsement policy will upgrade the app and the new policy will take effect immediately.

Custom Smart Contracts

SC Details

The Details tab provides information about your app. Some of the information is descriptive and some of it is needed to identify the API endpoint for executing functions in the smart contract.

  • App ID

    Unique ID for this app.

  • App Name

    The display name of your app. The default value is in the Xooa.yaml file, but can be overridden.

  • Description

    Optional description. The default value is in the Xooa.yaml file, but can be overridden.

  • Readme

    Optional. The default value is in the Xooa.yaml file, but can be overridden.

  • Branch

    The GitHub branch from which the smart contract has been deployed.

  • Deployed Version

    A counter registering each upgrade of the app.

  • Blockchain Network

    Blockchain technology used to deploy your smart contract.

  • Smart Contract Language

    Programming language of the smart contract. The default value is in the Xooa.yaml file, but can be overridden.

SC World State

World State provides:

  • Access to the state database of the custom smart contract.
  • Ability to search the state database using key or value.
  • Check the history of values for the associated key of world state.

SC Transactions

The transactions tab allows you to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction ID, and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • tx ID

      A unique transaction ID of the current transaction.

SC API

Sandbox

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • API Explorer

    Test the API endpoints for the custom smart contract upon authorizing using identity API token

     

    Swagger

    Swagger is used to simplify API development and is used by Xooa for defining REST APIs. Using swagger Xooa provides you an interface to make API requests. Place swagger.json file along with your Smart Contract and Xooa will pick it up while deploying and will integrate it with your app.

    Once the app is deployed or upgraded successfully, Navigate to API tab and select Sandbox option and there you will find API Explorer.

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which the API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

SC Activities

Provides a history of activity related to the app. Activities include redeploying the app, identity-related actions, and upgrades.

SC Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Delete identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.

SC Logs

View smart contract logs from the last 10 minutes. What events are logged depends on how you have coded your smart contract. Click here for details on Hyperledger Fabric’s logging.

SC Manage

Delete your app from Xooa or update your app from your GitHub repository or local directory.

Upgrade App

Refresh the app with the smart contract code currently in the GitHub repository used for creating this app or in your local directory.

Delete App

Deleting the app will remove the end point and related chaincode from Xooa. This operation is irreversible and you will never be able to access the app data again on Xooa. If you need to download the data, use an External Peer. External peers are not affected by this operation.

Endorsement Policy (Only for hyperledger fabric apps)

Defining a custom endorsement policy will allow External Peers to endorse transactions for the app.

Add Principal

Add an organization taking part in the endorsement under the same AND/OR expression.

Add Expression

Add a different condition of endorsement.

AND expression will allow the transaction to be committed only when endorsing peers from all the added organizations endorses the transaction.

OR expression will allow the transaction to be committed when endorsing peers from any of the added organizations endorses the transaction.

Apply endorsement policy

Applying the endorsement policy will upgrade the app and the new policy will take effect immediately.

ERC20 and ERC721

The ERC20 and ERC721 are Xooa managed smart contract apps deployed on Hyperledger Fabric. It provides the APIs to create the tokens and transfer them between participants.

ERC20 & ERC721 World State

World State provides:

  • Access to the state database of ERC20. It includes the current balances of participants and the token details.
  • Ability to search the state database using key or value.
  • Check the history of values for the associated key of world state.

ERC20 & ERC721 Transactions

The transactions tab allows to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction ID and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • Tx ID

      A unique transaction ID of the current transaction.

ERC20 & ERC721 API

Sandbox

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • API Explorer

    Test the API endpoints for ERC20 upon authorizing using identity API token. Use these APIs to transfer tokens, approve the transfer of tokens, or get various details and limits.

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

ERC20 & ERC721 Activities

Provides a history of activity related to the app. Activities include redeploying the app, identity-related actions, and upgrades.

ERC20 & ERC721 Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Delete identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.
  • Public Key

    A public identifier of the identity. Use the public key to share with other participants to receive tokens.

ERC20 & ERC721 Manage

Delete App

Deleting the app will remove the endpoint and token from Xooa. This operation is irreversible and you will never be able to access the app and token data again on Xooa. If you need to download the data, use an External Peer. External peers are not affected by this operation.

Endorsement Policy (Only for hyperledger fabric apps)

Defining a custom endorsement policy will allow External Peers to endorse transactions for the app.

Add Principal

Add an organization taking part in the endorsement under the same AND/OR expression.

Add Expression

Add a different condition of endorsement.

AND expression will allow the transaction to be committed only when endorsing peers from all the added organizations endorses the transaction.

OR expression will allow the transaction to be committed when endorsing peers from any of the added organizations endorses the transaction.

Apply endorsement policy

Applying the endorsement policy will upgrade the app and the new policy will take effect immediately.

Bonds

Bonds is a Xooa managed smart contract app deployed on Hyperledger Fabric. It provides the APIs to:

  • Create and manage bond offers. Each offer consistes of:
    • Currency - Currency in which cost of each bond is defined
    • Amount - Value of each bond
    • Quantity - Number of bonds available on offer
    • Maturity period - Number of months the bonds are offered for
    • Coupon rate - Rate of interest (in percent) payable on bond value
    • Coupon period - Interval at which the interest is payable by the issuer to the investor
  • Purchase the bond from an offer
  • Fetch various details about transactions and bonds
  • Manage wallets provided for each unique user

Bonds World State

World State provides:

  • Access to the state database of Bonds. It includes the wallet transactions, bonds offerings, and purchases.
  • Ability to search the state database using key or value.
  • Check the history of values for the associated key of world state.

Bonds Transactions

The transactions tab allows you to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction ID, and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • Tx ID

      A unique transaction ID of the current transaction.

Bonds API

Sandbox

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • API Explorer

    Test the API endpoints for bonds upon authorizing using identity API token. Use these APIs to transfer tokens, approve the transfer of tokens or get various details and limits.

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which the API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

Bonds Activities

Provides a history of activity related to the app. Activities include redeploying the app, identity-related actions, and upgrades.

Bonds Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always create identities with write access to the ledger.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
  • Public Key

    A public identifier of the identity.

Bonds Manage

Delete App

Deleting the app will remove the endpoint and token from Xooa. This operation is irreversible and you will never be able to access the app and token data again on Xooa. If you need to download the data, use an External Peer. External peers are not affected by this operation.

Endorsement Policy

Defining a custom endorsement policy will allow External Peers to endorse transactions for the app.

Add Principal

Add an organization taking part in the endorsement under the same AND/OR expression.

Add Expression

Add a different condition of endorsement.

AND expression will allow the transaction to be committed only when endorsing peers from all the added organizations endorses the transaction.

OR expression will allow the transaction to be committed when endorsing peers from any of the added organizations endorses the transaction.

Apply endorsement policy

Applying the endorsement policy will upgrade the app and the new policy will take effect immediately.

Voting

Voting is a Xooa managed smart contract app deployed on Hyperledger Fabric. It provides the APIs to vote for a candidate or an option for the vote created in Xooa.

A voting app can be an election or a referendum. Each election is comprised of election name, candidates’ name, start date, and end date of voting. Each referendum is comprised of a statement, options to vote for, start date, and end date of voting.

A voter will be allowed just once to vote between the start date and the end date. The start date and end date should be entered in the local timezone of the user deploying the app.

Voting Embed

It provides the user with a script which one can be embeded on their own website. The user can provide various parameters to <div> tag to customize the interaction. The user can customize:

  • xooa-widget-width

    Width of the iframe in which the widget will be loaded.

  • xooa-widget-height

    Height of the iframe in which the widget will be loaded.

  • apiToken

    API token of a user can be added to avoid user from entering the token and directly proceeding to vote.

Voting World State

World State provides:

  • Access to the state database of Voting. It includes the current tally of the votes and users who have voted without knowing the option/ candidate user has voted for.
  • Ability to search the state database using key or value.
  • Check the history of values for the associated key of world state.

Voting Transactions

The transactions tab allows to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction ID and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • Tx ID

      A unique transaction ID of the current transaction.

Voting API

Sandbox

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • API Explorer

    Test the API endpoints for Voting upon authorizing using identity API token. Use these APIs to vote, get the tally after the voting has ended, enroll the voters, or get various details about voting.

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

Voting Activities

Provides a history of activity related to the app. Activities include redeploying the app, identity-related actions, and upgrades.

Voting Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Delete identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

     

    Note

    An identity authorized to manage other identities can always enroll voters.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.
  • Public Key

    A public identifier of the identity. This is used to ensure only a single vote is casted by a user.

Voting Manage

Delete App

Deleting the app will remove the endpoint and token from Xooa. This operation is irreversible and you will never be able to access the app and token data again on Xooa. If you need to download the data, use an External Peer. External peers are not affected by this operation.

Endorsement Policy

Defining a custom endorsement policy will allow External Peers to endorse transactions for the app.

Add Principal

Add an organization taking part in the endorsement under the same AND/OR expression.

Add Expression

Add a different condition of endorsement.

AND expression will allow the transaction to be committed only when endorsing peers from all the added organizations endorses the transaction.

OR expression will allow the transaction to be committed when endorsing peers from any of the added organizations endorses the transaction.

Apply endorsement policy

Applying the endorsement policy will upgrade the app and the new policy will take effect immediately.

RMS

Record Management System or RMS allows you to manage records on multiple cloud storage platforms such as Dropbox, Google Drive(coming soon) or OneDrive(coming soon). You can keep track of records and make it verifiable in your own private blockchain ledger.

An application type can be defined for each record management app to maintain collection of all the records of similar type.

RMS Integration

Cloud integration

Connect your account with the cloud storage provider of your choice such as Dropbox, Google Drive(coming soon) or OneDrive(coming soon).

Automatic tracking

Include or exclude the relative path of folders in the cloud storage account that you would like to track on the private blockchain ledger in addition to the Xooa folder. You can add comma separated paths or regular expressions.

 

Records-tracking

By default a folder named Xooa will be created on the cloud storage and tracked. All records uploaded through Xooa Platform will be uploaded to this folder. You must upload at least one file from Xooa to enable the automatic tracking.

RMS Records

Record operations

Upload

Upload the records that you would like to track on the private blockchain ledger. These records will be stored in the Xooa folder of your cloud storage account.

Subject Id

Add a unique Id of the subject to which the record belongs. Each subject has a separate subdirectory that stores its corresponding records. You can fetch all records associated with a subject using APIs or through the Records tab. It is a mandatory field.

Metadata

Add JSON formatted metadata associated with the record. You can use this feature to save additional information about the record. It is an optional field. The metadata will also be stored in your cloud storage account under the metadata directory.

 

Ledger-update

Expect 1-2 minute delay of getting record details on the Xooa ledger after uploading the record.

Verify

Upload the record to verify its existence in RMS. Get the details like content hash, path of the record, id, name, created and modified date, etc.

World State provides:

  • Access to the state database of RMS. It includes the details of current records being tracked on RMS.
  • Ability to search the state database using key or value.
  • Check the history of values for the associated key of world state.

RMS Transactions

The transactions tab allows to browse activity in the ledger. You can:

  • Browse through the history of transactions
  • Search and filter the transactions by key, value, transaction ID and date range
    • Key

      The key used to save the data in the ledger.

    • Value

      The value saved in the ledger.

    • Is Deleted

      Denotes if the transaction was to delete the value from the ledger.

    • Updated At

      The time at which the transaction was made.

    • Tx ID

      A unique transaction ID of the current transaction.

RMS API

Sandbox

  • API Endpoint

    Endpoint for calling functions in the smart contract.

  • API Documentation and Testing

    URL for testing API endpoints. You can also test smart contract function calls.

  • API Explorer

    Test the API endpoints for RMS upon authorizing using identity API token. Use these APIs to upload records, get the record details, fetch the history of records, verify records, fetch or change tracked paths.

Monitoring

The history of API calls that have been made to the app filtered by the date range specified.

  • Time

    The time at which API call was made.

  • Method

    Request method for the API call.

  • Path

    The endpoint called.

  • Response time

    The time taken to get the response for the API call.

  • Response code

    The response code received by the user for the API call.

  • Client IP

    The IP address from where the API call was generated.

  • Identity ID

    Identity used to make the API call.

RMS Activities

Provides a history of activity related to the app. Activities include redeploying the app, connected cloud accounts, identity-related actions, and upgrades.

RMS Identities

An identity is someone with an API token and a given set of permissions to access the APIs for the app. From the Identities tab, you can perform actions such as:

  • Add identities
  • View identities
  • Delete identities
  • Update identities
  • Regenerate an API key for an identity
  • Identity ID

    A unique identifier of the identity. This is not the API token of the identity.

  • Name

    A descriptive name for the identity. Notice that the name does not need to be unique.

  • Access

    Determines if an identity with the API token can only read the ledger or also write to it.

  • Manage Identities

    Determines if the API token for this identity authorizes them to create other identities. Typically, such an identity represents an administrator.

  • Token Generated On

    Local date and time for when a token was last generated for the identity.

  • Actions

    Perform actions on the identity such as:

    • View: View the identity details such as access permissions and public key.
    • Regenerate: Generates a new API token and revokes the previous token.
    • Update: Update the access permissions of the identity.
    • Delete: Deletes the identity and revokes its API token.
  • Public Key

    A public identifier of the identity.

RMS Manage

Delete App

Deleting the app will remove the endpoint and token from Xooa. This operation is irreversible and you will never be able to access the app and token data again on Xooa. If you need to download the data, use an External Peer. External peers are not affected by this operation.

Endorsement Policy

Defining a custom endorsement policy will allow External Peers to endorse transactions for the app.

Add Principal

Add an organization taking part in the endorsement under the same AND/OR expression.

Add Expression

Add a different condition of endorsement.

AND expression will allow the transaction to be committed only when endorsing peers from all the added organizations endorses the transaction.

OR expression will allow the transaction to be committed when endorsing peers from any of the added organizations endorses the transaction.

Apply endorsement policy

Applying the endorsement policy will upgrade the app and the new policy will take effect immediately.