You can get all extra fields in your domain as a list using this API
| URL | {{BASE_URL}}/metadata/v1/get_metadata_definition_list |
| Method | GET |
| Parameters | |
| Sample Request JSON | |
| Sample Response JSON |
{ "status": "ok", "isvalid": true, "isadmin": true, "domid": "d7e19951-6990-402e-a1f3-357bd375ee61", "metadatadefinition": [ { "nidmetadatadefinition": 3, "ndomain": 4, "sfieldname": "Manufacturer", "sfielddescription": "Who created this machine ?", "nfieldtype": 3, "ismaintabdisplayed": false, "ischildtransferred": false, "ismergetransferred": false, "isblockchainauthorized": false, "displayorder": 1, "token_short": "00000000-0000-0000-0000-000000000000", "isreadonly": true }, { "nidmetadatadefinition": 13, "ndomain": 2, "sfieldname": "Certificate number", "sfielddescription": "Parcel certificate", "nfieldtype": 3, "ismaintabdisplayed": true, "ischildtransferred": true, "ismergetransferred": true, "isblockchainauthorized": true, "displayorder": 1, "token_short": "00000000-0000-0000-0000-000000000000", "isreadonly": false } ] } |
| Response Codes | 200: ok |
You can add a new Extra Field to your domain using this API.
| URL | {{BASE_URL}}/metadata/v1/insert_metadata_definition |
| Method | POST |
| Parameters |
fielddescription, string fieldname, string fieldtype, integer domain, integer bisblockchain, boolean bischildtransferred, boolean bismergetransferred, boolean bismaintabdisplayed, boolean ndisplayorder, integer |
| Sample Request JSON |
{ "fielddescription":"Test Extra Field", "fieldname":"Test", "fieldtype":3, "domain":2, "bisblockchain":"true", "bischildtransferred":"true", "bismergetransferred":"true", "bismaintabdisplayed":"true", "ndisplayorder":3 } |
| Sample Response JSON |
{ "status": "ok", "isvalid": true, "idmetadatadefinition": 106 } |
| Response Codes | 200: ok |
You can update an Extra Field in your domain using this API.
| URL | {{BASE_URL}}/metadata/v1/update_metadata_definition |
| Method | POST |
| Parameters |
idmetadatadefinition, integer fielddescription, string fieldname, string fieldtype, integer domain, integer bisblockchain, boolean bischildtransferred, boolean bismergetransferred, boolean bismaintabdisplayed, boolean ndisplayorder, integer |
| Sample Request JSON |
{ “idmetadatadefinition”: 106, "fielddescription":"Test", "fieldname":"Test", "fieldtype":3, "domain":2, "bisblockchain":"true", "bischildtransferred":"true", "bismergetransferred":"true", "bismaintabdisplayed":"true", "ndisplayorder":3 } |
| Sample Response JSON |
{ "status": "ok", "isvalid": true, "idmetadatadefinition": 106 } |
| Response Codes |
200: ok E156: Cannot change a read-only object |
You can delete an extra field from your domain using this API.
| URL | {{BASE_URL}}/metadata/v1/delete_metadata_definition/{nIdmetadef} |
| Method | GET |
| Parameters | |
| Sample Request JSON | |
| Sample Response JSON |
{ "status": "ok" } |
| Response Codes | 200: ok |