HomeDocumentationAPI ReferenceChangelog
Arianee Protocol DocumentationLog In
Documentation

Update Template

Update an existing template using API.

URL

Required rights: admin or certCreate

To fetch and update a specific template, use /smartAssetTemplate/:id.

PUT - https://{url}/smartAssetTemplate/{id}

Body

ParameterTypeMandatoryDescription
deletedBoolean❌The template has been deleted from the NFT Management Platform.
blockchainPropertiesObject❌Transfer settings.
blockchainProperties → isTransferableBoolean❌Set true if the digital passport is claimable.
blockchainProperties → showTranferableOptionBoolean❌Set true to display the Transferable option on the app.
metadataObject❌Metadata of the template.
metadata → nameString❌Name of the product.
metadata → iconString❌Product icon displayed in the app.
contentObject❌JSON Schema with the template content.
After doing the JSON content, stringify it.
attributesObject❌Attributes of the digital passport template.
attributes → field%value%❌Field replaced by the digital passport content.
attributes → labelString❌Label displayed in the app.
attributes → freeEntryBoolean❌The user manually adds values in the app.
attributes → requiredBoolean❌Set to true so the user cannot pass the step.
attributes → typeString❌Identifies the type of component to be displayed.
attributes → optionObject❌

For inputs with the "select" type concerns the set of values that will be proposed.

[ {”label”: string, “value”: string}, {”label”: string, “value”: string}, … ]

attributes → valueString❌Value proposed to the user.
{
    "deleted":false,
    "blockchainProperties": {
      "isTransferable": true,
      "showTransferableOption":true
    },
    "metadata": {
      "name": "Edited ROYAL OAK GRANDE COMPLICATION SQUELETTE",
      "icon": "https://www.audemarspiguet.com/content/dam/ap/com/products/watches/MTR003700.00/importer/watch.png.transform.appdpmain.png"
    },
    "content": "{\n  \"$schema\": \"https://cert.arianee.org/version2/ArianeeProductCertificate-i18n.json\",\n  \"language\": \"fr-FR\",\n  \"name\": \"ROYAL OAK GRANDE COMPLICATION SQUELETTE\",\n  \"category\": \"accessory\",\n  \"subCategory\": \"watch\",\n  \"serialnumber\": [\n    {\n      \"type\": \"serialnumber\",\n      \"value\": \"%serialnumber%\"\n    },\n    {\n      \"type\": \"casenumber\",\n      \"value\": \"%casenumber%\"\n    }\n  ],\n  \"model\": \"Royal Oak\",\n  \"description\": \"\\nCombinant les 3 catégories de complications horlogères (mesure des temps courts, mécanismes de sonnerie et indications astronomiques), ce modèle entraîné par le calibre %calibre% a été entièrement fabriqué à la main par un seul et même maître-horloger de l’atelier Grandes Complications Audemars Piguet.\\n\\nBoîte de %diameter% en %caseMaterial% avec lunette acier, glace et fond saphir, couronne vissée\\n\\nCadran saphir, compteurs fumés, aiguilles Royal Oak en %aiguilleMaterial% avec dépôt luminescent, aiguilles compteurs/seconde/rattrapante blanches, réhaut noir avec minuterie blanche, mouvement couleur ardoise.\",\n  \"externalContents\": [\n    {\n      \"type\": \"website\",\n      \"title\": \"Audemars Piguet Website\",\n      \"url\": \"https://www.audemarspiguet.com/com/fr/home.html\"\n    }\n  ],\n  \"medias\": [\n    {\n      \"mediaType\": \"picture\",\n      \"type\": \"product\",\n      \"url\": \"https://www.audemarspiguet.com/content/dam/ap/com/products/watches/MTR003700.00/importer/watch.png.transform.appdpmain.png\"\n    },\n    {\n      \"mediaType\": \"picture\",\n      \"type\": \"brandItemBackgroundPicture\",\n      \"url\": \"https://www.audemarspiguet.com/content/dam/ap/com/products/watches/MTR003700.00/importer/watch.png.transform.appdpfeaturedcase.png\"\n    },\n    {\n      \"mediaType\": \"picture\",\n      \"type\": \"product\",\n      \"url\": \"https://www.audemarspiguet.com/content/dam/ap/com/products/watches/MTR003700.00/importer/watch.png.transform.appdpfeatureddial.png\"\n    }\n  ]\n}",
    "attributes": [
      {
        "field": "%serialnumber%",
        "label": "Serial number",
        "freeEntry": false,
        "required": true,
        "type": "text",
        "options": []
      },
	{
        "field": "%casenumber%",
        "label": "Case number",
        "freeEntry": false,
        "required": true,
        "type": "text",
        "options": []
      },
      {
        "field": "%diameter%",
        "label": "Diameter",
        "freeEntry": false,
        "required": true,
        "type": "select",
        "options": [{
          "label": "42mm",
          "value": "42mm"
        }, {
          "label": "44mm",
          "value": "44mm"
        }
        ]
      },
      {
        "field": "%caseMaterial%",
        "label": "Case material",
        "freeEntry": false,
        "required": true,
        "type": "select",
        "options": [{
          "label": "Or rose 18k",
          "value": "Or rose 18k"
        },{
          "label": "Or jaune 18k",
          "value": "Or jaune 18k"
        }
        ]
      },
      {
        "field": "%aiguilleMaterial%",
        "label": "Needle material",
        "freeEntry": false,
        "required": true,
        "type": "select",
        "options": [{
          "label": "Or rose 24k",
          "value": "Or rose 24k"
        },{
          "label": "Or jaune 24k",
          "value": "Or jaune 24k"
        }
        ]
      },
      {
        "field": "%media%",
        "label": "Media",
        "required": false,
        "type": "file"
    	}
    ]
  }

Return Payload

Statut CodeDescription
200The template has been updated, data are returned.
{
    "attributes": [
        {
            "field": "%serialnumber%",
            "label": "Serial number",
            "freeEntry": false,
            "required": true,
            "type": "text",
            "options": []
        },
        {
            "field": "%casenumber%",
            "label": "Case number",
            "freeEntry": false,
            "required": true,
            "type": "text",
            "options": []
        },
        {
            "field": "%diameter%",
            "label": "Diameter",
            "freeEntry": false,
            "required": true,
            "type": "select",
            "options": [
                {
                    "label": "42mm",
                    "value": "42mm"
                },
                {
                    "label": "44mm",
                    "value": "44mm"
                }
            ]
        },
        {
            "field": "%caseMaterial%",
            "label": "Case material",
            "freeEntry": false,
            "required": true,
            "type": "select",
            "options": [
                {
                    "label": "Or rose 18k",
                    "value": "Or rose 18k"
                },
                {
                    "label": "Or jaune 18k",
                    "value": "Or jaune 18k"
                }
            ]
        },
        {
            "field": "%aiguilleMaterial%",
            "label": "Needle material",
            "freeEntry": false,
            "required": true,
            "type": "select",
            "options": [
                {
                    "label": "Or rose 24k",
                    "value": "Or rose 24k"
                },
                {
                    "label": "Or jaune 24k",
                    "value": "Or jaune 24k"
                }
            ]
        },
        {
          "field": "%media%",
          "label": "Media",
          "required": false,
          "type": "file"
    		}
    ],
    "_id": "63a5cfee94ea7835457d5800",
    "deleted": false,
    "blockchainProperties": {
        "isTransferable": true,
        "showTransferableOption": true
    },
    "metadata": {
        "name": "Edited ROYAL OAK GRANDE COMPLICATION SQUELETTE",
        "icon": "https://www.audemarspiguet.com/content/dam/ap/com/products/watches/MTR003700.00/importer/watch.png.transform.appdpmain.png"
    },
    "content": "{\n  \"$schema\": \"https://cert.arianee.org/version2/ArianeeProductCertificate-i18n.json\",\n  \"language\": \"fr-FR\",\n  \"name\": \"ROYAL OAK GRANDE COMPLICATION SQUELETTE\",\n  \"category\": \"accessory\",\n  \"subCategory\": \"watch\",\n  \"serialnumber\": [\n    {\n      \"type\": \"serialnumber\",\n      \"value\": \"%serialnumber%\"\n    },\n    {\n      \"type\": \"casenumber\",\n      \"value\": \"%casenumber%\"\n    }\n  ],\n  \"model\": \"Royal Oak\",\n  \"description\": \"\\nCombinant les 3 catégories de complications horlogères (mesure des temps courts, mécanismes de sonnerie et indications astronomiques), ce modèle entraîné par le calibre %calibre% a été entièrement fabriqué à la main par un seul et même maître-horloger de l’atelier Grandes Complications Audemars Piguet.\\n\\nBoîte de %diameter% en %caseMaterial% avec lunette acier, glace et fond saphir, couronne vissée\\n\\nCadran saphir, compteurs fumés, aiguilles Royal Oak en %aiguilleMaterial% avec dépôt luminescent, aiguilles compteurs/seconde/rattrapante blanches, réhaut noir avec minuterie blanche, mouvement couleur ardoise.\",\n  \"externalContents\": [\n    {\n      \"type\": \"website\",\n      \"title\": \"Audemars Piguet Website\",\n      \"url\": \"https://www.audemarspiguet.com/com/fr/home.html\"\n    }\n  ],\n  \"medias\": [\n    {\n      \"mediaType\": \"picture\",\n      \"type\": \"product\",\n      \"url\": \"https://www.audemarspiguet.com/content/dam/ap/com/products/watches/MTR003700.00/importer/watch.png.transform.appdpmain.png\"\n    },\n    {\n      \"mediaType\": \"picture\",\n      \"type\": \"brandItemBackgroundPicture\",\n      \"url\": \"https://www.audemarspiguet.com/content/dam/ap/com/products/watches/MTR003700.00/importer/watch.png.transform.appdpfeaturedcase.png\"\n    },\n    {\n      \"mediaType\": \"picture\",\n      \"type\": \"product\",\n      \"url\": \"https://www.audemarspiguet.com/content/dam/ap/com/products/watches/MTR003700.00/importer/watch.png.transform.appdpfeatureddial.png\"\n    }\n  ]\n}",
    "__v": 0,
    "id": "63a5cfee94ea7835457d5800"
}

Did this page help you?