Skip to main content
API docs by Redocly

Smart Contract Registry (0.0.24)

Download OpenAPI specification:Download

Smart Contract

Get the Smart Contracts available in a project Deprecated

Authorizations:
ApplicationToken
query Parameters
project
required
string

The project that you wish to filter by

resourceId
string
Default: ""

The resourceId of the project that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "SmartContractPage"
}

Registers a new version of a Smart Contract Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
compilationDetails
string
compileVersion
string
contractInstanceID
string
object (ContractSpecification)
id
integer <int64>
ledgerID
string
name
string
Array of objects (Property)
resourceId
string
Array of objects (ContractType)

Responses

Request samples

Content type
application/json
{
  • "compilationDetails": "string",
  • "compileVersion": "string",
  • "contractInstanceID": "string",
  • "contractSpecification": {
    },
  • "id": 0,
  • "ledgerID": "string",
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "types": [
    ]
}

Response samples

Content type
application/json
{
  • "compilationDetails": "string",
  • "compileVersion": "string",
  • "contractInstanceID": "string",
  • "contractSpecification": {
    },
  • "id": 0,
  • "ledgerID": "string",
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "types": [
    ]
}

Delete a Smart Contract by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
smartContractId
required
string

The ID of the Smart Contract that you want to perform actions on

Responses

Get a Smart Contract by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
smartContractId
required
string

The ID of the Smart Contract that you want to perform actions on

Responses

Response samples

Content type
application/json
{
  • "compilationDetails": "string",
  • "compileVersion": "string",
  • "contractInstanceID": "string",
  • "contractSpecification": {
    },
  • "id": 0,
  • "ledgerID": "string",
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "types": [
    ]
}

Deploy a Smart Contract Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
args
list
id
integer <int64>
ledgerId
string
name
string
tag
string
templateId
string
walletId
string
walletPassword
string

Responses

Request samples

Content type
application/json
{
  • "args": null,
  • "id": 0,
  • "ledgerId": "string",
  • "name": "string",
  • "tag": "string",
  • "templateId": "string",
  • "walletId": "string",
  • "walletPassword": "string"
}

Response samples

Content type
application/json
{
  • "compilationDetails": "string",
  • "compileVersion": "string",
  • "contractInstanceID": "string",
  • "contractSpecification": {
    },
  • "id": 0,
  • "ledgerID": "string",
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "types": [
    ]
}

Updates the properties of a Smart Contract Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
compilationDetails
string
compileVersion
string
contractInstanceID
string
object (ContractSpecification)
id
integer <int64>
ledgerID
string
name
string
Array of objects (Property)
resourceId
string
Array of objects (ContractType)

Responses

Request samples

Content type
application/json
{
  • "compilationDetails": "string",
  • "compileVersion": "string",
  • "contractInstanceID": "string",
  • "contractSpecification": {
    },
  • "id": 0,
  • "ledgerID": "string",
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "types": [
    ]
}

Response samples

Content type
application/json
{
  • "compilationDetails": "string",
  • "compileVersion": "string",
  • "contractInstanceID": "string",
  • "contractSpecification": {
    },
  • "id": 0,
  • "ledgerID": "string",
  • "name": "string",
  • "properties": [
    ],
  • "resourceId": "string",
  • "types": [
    ]
}

Smart Contract Specification

Creates a new version of a Smart Contract Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
checksum
string
compilationLanguage
string
compilationSpecification
string
compilationStatus
string
object (ContractTemplate)
dateCreated
integer <int64>
dateUpdated
integer <int64>
description
string
hasPreprocessing
boolean
id
integer <int64>
object (LedgerTechnology)
preCompilationSpecification
string
tag
string
targetCompilationVersion
string

Responses

Request samples

Content type
application/json
{
  • "checksum": "string",
  • "compilationLanguage": "string",
  • "compilationSpecification": "string",
  • "compilationStatus": "string",
  • "contractTemplate": {
    },
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "description": "string",
  • "hasPreprocessing": true,
  • "id": 0,
  • "ledgerTechnology": {
    },
  • "preCompilationSpecification": "string",
  • "tag": "string",
  • "targetCompilationVersion": "string"
}

Response samples

Content type
application/json
{
  • "checksum": "string",
  • "compilationLanguage": "string",
  • "compilationSpecification": "string",
  • "compilationStatus": "string",
  • "contractTemplate": {
    },
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "description": "string",
  • "hasPreprocessing": true,
  • "id": 0,
  • "ledgerTechnology": {
    },
  • "preCompilationSpecification": "string",
  • "tag": "string",
  • "targetCompilationVersion": "string"
}

Gets the Contract Specification in a template by its tag Deprecated

Authorizations:
ApplicationToken
path Parameters
templateId
required
string

The Template Id that you want to perform actions with

tag
required
string

The Tag that you want to perform actions with

Responses

Response samples

Content type
application/json
{
  • "checksum": "string",
  • "compilationLanguage": "string",
  • "compilationSpecification": "string",
  • "compilationStatus": "string",
  • "contractTemplate": {
    },
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "description": "string",
  • "hasPreprocessing": true,
  • "id": 0,
  • "ledgerTechnology": {
    },
  • "preCompilationSpecification": "string",
  • "tag": "string",
  • "targetCompilationVersion": "string"
}

Lists all the contract specifications in a Template Deprecated

Authorizations:
ApplicationToken
path Parameters
templateId
required
string

The Template Id that you want to perform actions with

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Smart Contract Template

Lists all the contract templates in a project Deprecated

Authorizations:
ApplicationToken
query Parameters
project
required
string

The project that you wish to filter by

resourceId
string
Default: ""

The resourceId of the project that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
Example
{
  • "pageContent": [
    ],
  • "contentType": "ContractTemplatePage",
  • "pageElements": 0,
  • "pageNumber": 0,
  • "totalElements": 0,
  • "totalPages": 0
}

Creates a new version of a Contract Template Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
contractTemplateID
string
description
string
id
integer <int64>
name
string
resourceId
string

Responses

Request samples

Content type
application/json
{
  • "contractTemplateID": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "resourceId": "string"
}

Response samples

Content type
application/json
{
  • "contractTemplateID": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "resourceId": "string"
}

Deletes a contract templates by its ID Deprecated

Authorizations:
ApplicationToken
path Parameters
templateId
required
string

The Template Id that you want to perform actions with

Responses

Token

Registers a new Token Deprecated

Authorizations:
ApplicationToken
Request Body schema: application/json
object (SmartContract)
id
integer <int64>
name
string
resourceId
string
ticker
string
tokenID
string

Responses

Request samples

Content type
application/json
{
  • "contractInstance": {
    },
  • "id": 0,
  • "name": "string",
  • "resourceId": "string",
  • "ticker": "string",
  • "tokenID": "string"
}

Response samples

Content type
application/json
{
  • "contractInstance": {
    },
  • "id": 0,
  • "name": "string",
  • "resourceId": "string",
  • "ticker": "string",
  • "tokenID": "string"
}

Get a Token by its Name Deprecated

Authorizations:
ApplicationToken
path Parameters
tokenId
required
string

The tokenId of the token you want to perform and action

Responses

Response samples

Content type
application/json
{
  • "contractInstance": {
    },
  • "id": 0,
  • "name": "string",
  • "resourceId": "string",
  • "ticker": "string",
  • "tokenID": "string"
}

Get all Tokens Deprecated

Authorizations:
ApplicationToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload

Upload smart contract source code Deprecated

Authorizations:
ApplicationToken
path Parameters
templateId
required
string

The Template Id that you want to perform actions with

tag
required
string

The Tag that you want to perform actions with

Request Body schema: multipart/form-data
sourceCode
required
string <binary>

Responses