Skip to main content
GET
/
platform
/
admin
/
audit_registry
/
{smartContractImplementationBlockchainsDeployId}
/
add
Get add implementation preparation data
curl --request GET \
  --url https://api.example.com/platform/admin/audit_registry/{smartContractImplementationBlockchainsDeployId}/add
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Fetches preparation data required to add a new audit registry implementation entry. This endpoint provides available smart contracts, blockchain information, and validation rules needed for the registration process.

​
Input

  • smartContractImplementationBlockchainsDeployId (long, required) — The deployment identifier of the audit registry contract that will receive the new implementation record.

​
Output

Returns a GetAddImplementationToAuditRegistryDto object containing:
  • auditRegistryDeployId (long) — The audit registry deployment identifier.
  • blockchainName (string) — Name of the blockchain where the audit registry is deployed.
  • availableImplementations (array) — List of smart contract implementations that can be registered.
  • validationRules (object) — Rules and constraints for audit URL format and other fields.

​
Examples

Request 
GET /api/platform/audit-registry/42/add-implementation
Response (200 OK) 
{
  "auditRegistryDeployId": 42,
  "blockchainName": "Ethereum Mainnet",
  "availableImplementations": [
    {
      "deployId": 77,
      "contractName": "TokenContract",
      "version": "1.0.0"
    },
    {
      "deployId": 88,
      "contractName": "StakingContract",
      "version": "2.1.0"
    }
  ],
  "validationRules": {
    "auditUrlMaxLength": 500,
    "requiredProtocol": "https"
  }
}

​
Errors

  • 401 Unauthorized: Caller is not authenticated.
  • 403 Forbidden: Caller lacks platform administration permissions.
  • 404 Not Found: The specified audit registry deployment does not exist.
  • 500 Internal Server Error: Unexpected error occurred during retrieval.

​
Notes

This endpoint is typically called before presenting a form to add new audit registry entries. It provides the necessary context and options for successful registration.

Path Parameters

​
smartContractImplementationBlockchainsDeployId
integer<int64>
required

The audit registry deployment identifier.

Query Parameters

​
api-version
string | null

Response

Successfully retrieved preparation data.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.