Olyn API Registry Template

Introduction

Template resources are used to distribute, define and verify asset tokens before creation. This main resource is used to represent the asset format and verify their creation of them afterwards. Additionally is where rules are defined.
The template resource is composed of three fields.

  • templateInfo, which encapsulates descriptive information for the template itself.
  • assetData, which encapsulates descriptive information of the asset.
  • eventData, which encapsulates data related to 3rd parties or external checks to perform in order to validate the asset creation.

Resources models

List of all models in order to define and fully access the template resource.

Template model

{
        "templateInfo": {
            "templateId": "TEMPALTE-UUID",
            "createdAt": "DAT-OF-CREATION",
            "createdBy": "X-ORG-CODE",
            "name": "TEMPALTE-NAME",
            "description": "TEMPALTE-DESCRIPTION",
            "version": "TEMPLATE-VERSION"
        },
        "assetData": [assetResource],
        "eventData": [assetResource]
    }

Field

Type

Description

templateInfo

Object Hash

Information about the template

templateId

Object Id

Unique identifier for the template

Auto

createdAt

Date

Date when the template was created

Auto

createdBy

String

Identifier of the entity that created the template

Auto

name

String

Name of the template

Set by developer

description

String

Description of the template

Set by developer

version

String

The version of the template

Set by developer

assetData

list[Object Hash]

List of field definitions

eventData

list[Object Hash]

List of field definitions

Field model

{
  "fieldName": "KEY-NAME",
  "isManualInput": bool,
  "isMandatory": bool,
  "fieldType": "FIELD-TYPE",
  "fieldBehaviour": "FIELD-BEHAVIOUR"
}

Field

Type

Description

fieldName

String

Key identifier for this field

Set by developer

isManualInput

Bool

If the value is entered manually or by another system

Set by developer

isMandatory

Bool

If 'True', the value is required to create the asset token

Set by developer

fieldType

String

Data type for the value of the field

Set by developer

fieldBehaviour

String

How this field will be accesed and modified once the asset token is created

Set by developer


Did this page help you?