JSON File Formats for Exporting Data
NOTE "Contacts" in the JSON files refer to the Users entity.
You can use the information is this section to understand the JSON formats that are used to export existing Sentinel EMS data for customers, users (referred to as contacts in the JSON file), features, products, product suites, entitlements, or downloads.
JSON File Format for Customers
The following is a sample JSON file format for exporting customer data. In the JSON file, "contact" refers to the user entity.
{
"customers":{
"count":1,
"customer":[
{
"id":"4c851fa3-99fb-4e51-b36a-0ab172983afd",
"creationDate":"2024-04-15 04:32",
"lastModifiedDate":"",
"name":"TestCustomer_0122316",
"description":"Sample customer data",
"identifier":"b6abfaf8-0b0c-4bbd-ac1f-116f7596594d",
"externalId":"",
"refId":"",
"crmId":"",
"timeZoneId":"UTC",
"state":"ENABLE",
"customAttributes":{
"customAttribute":[
{
"name":"ABCD",
"value":""
}
]
},
"contacts":{
"contact":[
{
"id":"b64def34-2a39-4ddb-8668-1194945feaf1",
"emailId":"TestContact.661350@test.com"
}
]
},
"fingerprints":null
}
]
}
}
JSON File Format for Users (also known as Contacts)
The following is a sample JSON file format for exporting contact data. In the JSON file, "contact" refers to the user entity.
{
"contacts":{
"count":1,
"contact":[
{
"id":"d3748d1c-09ef-46d7-a6c5-bee088524386",
"creationDate":"<MadCap:variable name="Default.Year-in-topics" />-04-15 07:06",
"externalId": "",
"lastModifiedDate":"",
"name":"Test_Contact",
"emailId":"mycontact@example.com",
"phoneNumber":"9999999999",
"defaultLocale":"en",
"refId1":"ref1",
"refId2":"ref2",
"customer":null,
"identityProvider": {
"name": "SentinelIDP",
"displayName": "Sentinel IDP"
},
"state":"ENABLE",
"customAttributes":{
"customAttribute":[
{
"name":"Address Line 1",
"value":"SampleAddress"
},
{
"name":"City",
"value":"SampleCityName"
},
{
"name":"Company",
"value":""
},
{
"name":"Company Website",
"value":""
},
{
"name":"Country",
"value":"SampleCountryName"
},
{
"name":"Fax",
"value":""
},
{
"name":"First Name",
"value":"Customer_01"
},
{
"name":"Last Name",
"value":""
},
{
"name":"Phone",
"value":""
},
{
"name":"State/Province",
"value":"UP"
},
{
"name":"Zip/Postal",
"value":""
}
]
},
"shippingDetails":{
"address":"SampleAddress",
"city":"SampleCity",
"state":"SampleState",
"country":"SampleCountryName",
"zip":"999999"
},
"billingDetails":{
"address":"SampleAddress",
"city":"SampleCity",
"state":"SampleState",
"country":"SampleCountryName",
"zip":"999999"
}
}
]
}
}
JSON File Format for Features
The following is a sample JSON file format for exporting feature data:
{
"features":{
"count":1,
"feature":[
{
"namespace":{
"id":"4e4e626f-09ac-4759-8082-b01dc142894f",
"name":"MySampleNamespace"
},
"externalId":"",
"id":"4a2e1c86-62b9-421a-97e4-1805ae31035c",
"creationDate":"2024-04-15 06:07",
"lastModifiedDate":"",
"identifier":25,
"nameVersion":{
"name":"Feature1",
"version":""
},
"refId1":"",
"refId2":"",
"description":"",
"deployed":true,
"featureLicenseModels":{
"featureLicenseModel":[
{
"enforcement":{
"id":"7e6a6d18-5f34-11e9-8747-063bb33bcbca",
"name":"Sentinel RMS",
"version":"9.5"
},
"licenseModel":{
"id":"7e7b5fa4-5f34-11e9-8747-063bb33bcbca",
"name":"Commuter"
},
"isDefault":false
},
{
"enforcement":{
"id":"7e6a6d18-5f34-11e9-8747-063bb33bcbca",
"name":"Sentinel RMS",
"version":"9.5"
},
"licenseModel":{
"id":"7e7ab980-5f34-11e9-8747-063bb33bcbca",
"name":"Trial Network"
},
"isDefault":true
}
]
},
"customAttributes":null
}
]
}
}
JSON File Format for Products
The following is a sample CSV file format for importing product data:
{
"products":{
"count":1,
"product":[
{
"namespace":{
"id":"2d1b86f9-ced6-4dd9-9548-2c11bbead173",
"name":"NMhsNUAm"
},
"id":"c2831e49-4369-4e2c-bea9-f0c959ec7475",
"creationDate":"2024-04-15 06:05",
"lastModifiedDate":"",
"externalId":"Ext529310",
"nameVersion":{
"name":"Aaa48261",
"version":"V88"
},
"deployed":false,
"description":"DesccawGLUUgaORyHmtCcjvBLSFIWzMqiVbtwgXkrAECQYrKQeoGecPuXzSRgLNyObBiAmMPOcVtMvtIUZovmcoNznKsLFLSBDwHTbZR",
"state":"ENABLE",
"refId1":"Ref148261",
"refId2":"Ref248261",
"family":{
"familyId":"ad4bcaae-5169-4e83-bbc5-ed9fad5d8d16",
"familyName":"newfamily"
},
"activationMethod":"FIXED",
"productType":"DEFAULT",
"fixedQuantity":0,
"productFeatures":{
"productFeature":[
{
"feature":{
"id":"ab458da4-b5b3-4703-93b1-ce19c6ee4207",
"externalId":"",
"identifier":"",
"nameVersion":{
"name":"paWvgn",
"version":"7379"
}
},
"state":"Optional_DefaultOn",
"defaultLicenseModel":{
"enforcement":{
"id":"7e6a6d18-5f34-11e9-8747-063bb33bcbca",
"name":"Sentinel RMS",
"version":"9.5"
},
"licenseModel":{
"id":"7e7b5d59-5f34-11e9-8747-063bb33bcbca",
"name":"Standalone Node Locked"
},
"isFixed":false
}
}
]
},
"customAttributes":{
"customAttribute":[
{
"name":"NmUTqDhVJL",
"value":""
},
{
"name":"NmYmNPYMpk",
"value":""
},
{
"name":"NmwaDccHCs",
"value":""
},
{
"name":"SM01AvUWvoFP",
"value":"BashTagsAvUWvoFP"
},
{
"name":"SM01KyVChCPP",
"value":"BashTagsKyVChCPP"
},
{
"name":"SM01NQxuEIhu",
"value":"BashTagsNQxuEIhu"
},
{
"name":"SM01WChTQcvD",
"value":"BashTagsOhHn"
},
{
"name":"SM01kiKKetYz",
"value":"BashTagsPvkx"
},
{
"name":"SM01lAuZkHNP",
"value":"BashTagsklqy"
}
]
},
"productAttributes":null,
"parentProduct":null
}
]
}
}
JSON File Format for Product Suites
The following is a sample JSON file format for exporting product suite data:
{
"productSuites": {
"count": 1,
"productSuite": [
{
"namespace": {
"id": "",
"name": "General"
},
"id": "",
"creationDate": "2023-08-17 05:37",
"lastModifiedDate": "2023-08-17 05:37",
"externalId": "501a",
"nameVersion": {
"name": "Example_product_suite",
"version": "1.0"
},
"deployed": false,
"description": "",
"state": "ENABLE",
"refId1": "",
"refId2": "",
"activationMethod": "SAOT",
"fixedQuantity": 0,
"products": {
"product": [
{
"id": "",
"identifier": "7",
"externalId": "369a",
"nameVersion": {
"name": "Easiest E-Editor",
"version": "1"
}
},
{
"id": "",
"identifier": "2",
"externalId": "428b",
"nameVersion": {
"name": "Spreadsheet-4U",
"version": "1.0"
}
}
]
},
"customAttributes": null
}
]
}
}
JSON File Format for Entitlements
The following is a sample JSON file format for exporting entitlement data:
{
"entitlements":{
"count":1,
"entitlement":[
{
"externalId":"",
"creationDate":"2024-04-15 05:48",
"lastModifiedDate":"2024-04-15 05:48",
"entitlementAsWhole":false,
"eId":"Eid_4214",
"id":"9a1ce483-5310-4dc8-93ac-1e85e006d775",
"startDate":"2024-04-15",
"expiry":{
"neverExpires":true
},
"customer":null,
"contact":null,
"entitlementPartners":null,
"userRegistration":"OPTIONAL",
"refId1":"",
"refId2":"",
"activationAllowed":true,
"revocationAllowed":true,
"state":"DRAFT",
"sendNotification":true,
"ccEmail":"",
"isTest":false,
"customAttributes":null,
"productKeys":{
"productKey":[
{
"pkId":"13dea76b-6a82-44d3-b032-2501ea11cba1",
"creationDate":"2024-04-15 05:48",
"lastModifiedDate":"2024-04-15 05:48",
"startDate":"2024-04-15",
"expiry":{
"neverExpires":true
},
"id":"28b491ee-88d2-40f6-88c2-5258c039892a",
"enforcement":{
"id":"7e6a6d18-5f34-11e9-8747-063bb33bcbca",
"name":"Sentinel RMS",
"version":"9.5"
},
"totalQuantity":12,
"availableQuantity":12,
"splittedQuantity":0,
"activationMethod":"FIXED",
"fixedQuantity":2,
"state":"DRAFT",
"item":{
"itemProduct":{
"product":{
"externalId":"Ext968589",
"id":"ecdbd483-8279-4eaa-b376-42c47d62e116",
"nameVersion":{
"name":"Aaa96607",
"version":"V82"
}
},
"itemProductFeatures":{
"itemProductFeature":[
{
"feature":{
"externalId":"",
"id":"34787b2b-c34d-4b62-84f8-7246f26a39b7",
"identifier":"",
"nameVersion":{
"name":"CvJisT",
"version":"1869"
}
},
"itemFeatureLicenseModel":{
"licenseModel":{
"id":"7e7b5d59-5f34-11e9-8747-063bb33bcbca",
"name":"Standalone Node Locked"
},
"attributes":{
"attribute":[
{
"name":"DEPLOYMENT_TYPE",
"value":"0",
"displayText":"On-premise Served"
},
{
"name":"LICENSE_TYPE",
"value":"1",
"displayText":"Standalone"
},
{
"name":"START_LICENSE_FROM_ACTIVATION_DATE",
"value":"FALSE"
},
{
"name":"LICENSE_DURATION_IN_DAYS",
"value":"365"
},
{
"name":"START_DATE",
"value":"2024-01-01 00:00"
},
{
"name":"END_DATE",
"value":"2020-01-01 00:00"
},
{
"name":"LICENSE_GENERATION_TIME",
"value":""
},
{
"name":"FLOATING_USER_LIMIT",
"value":"1"
},
{
"name":"FLOATING_SOFT_USER_LIMIT",
"value":"4294967294"
},
{
"name":"KEY_LIFETIME_MINUTES",
"value":"5"
},
{
"name":"TRIAL_DURATION_DAYS",
"value":"0"
},
{
"name":"TRIAL_DURATION_HOURS",
"value":"0"
},
{
"name":"ALLOW_COMMUTER",
"value":"FALSE"
},
{
"name":"ALLOW_GRACE",
"value":"0",
"displayText":"Disallowed"
},
{
"name":"GRACE_PERIOD_DAYS",
"value":"0"
},
{
"name":"GRACE_PERIOD_ELAPSED_HOURS",
"value":"0"
},
{
"name":"COMMUTER_MAX_CHECKOUT_DAYS",
"value":"0"
},
{
"name":"SHARING_CRITERIA",
"value":"0",
"displayText":"No Sharing"
},
{
"name":"SHARING_LIMIT",
"value":"0"
},
{
"name":"HOLDING_CRITERIA",
"value":"0",
"displayText":"No Hold Time"
},
{
"name":"KEY_HOLDTIME_MINUTES",
"value":"0"
},
{
"name":"OUTPUT_TYPE",
"value":"0",
"displayText":"Encrypted"
},
{
"name":"ENFORCE_LICENSE_EXCLUSIVE",
"value":"1",
"displayText":"Exclusive"
},
{
"name":"ENFORCE_CLOCK_TAMPERED",
"value":"TRUE"
},
{
"name":"LOG_ENCRYPT_LEVEL",
"value":"0",
"displayText":"End User Defined"
},
{
"name":"ALLOW_REDUNDANCY",
"value":"FALSE"
},
{
"name":"ENFORCE_REDUNDANCY_MAJORITY",
"value":"FALSE"
},
{
"name":"IS_TRIAL",
"value":"FALSE"
},
{
"name":"KEY_TYPE",
"value":"1"
},
{
"name":"NUMERIC_TYPE",
"value":"0"
},
{
"name":"ELAN_KEY_FLAG",
"value":"0"
},
{
"name":"USE_AUTH_CODE",
"value":"0"
},
{
"name":"CAPACITY",
"value":"0"
},
{
"name":"CAPACITY_FLAG",
"value":"0",
"displayText":"No Capacity"
},
{
"name":"LOCKING_MODE",
"value":"3",
"displayText":"Client locked"
},
{
"name":"NUM_SUBNET",
"value":"0"
},
{
"name":"LOCAL_REQUEST_LOCKCRIT_FLAG",
"value":"0",
"displayText":"Default"
},
{
"name":"CODE_TYPE",
"value":"1",
"displayText":"Long licenses"
},
{
"name":"LOCAL_REQUEST_LOCKCRIT_REQUIRED",
"value":"4"
},
{
"name":"LOCAL_REQUEST_LOCKCRIT_FLOAT",
"value":"0"
},
{
"name":"LOCAL_REQUEST_LOCKCRIT_MIN_NUM",
"value":"1"
},
{
"name":"CLIENT_1_INFO",
"value":"4"
},
{
"name":"CLIENT_2_INFO",
"value":"4"
},
{
"name":"CLIENT_3_INFO",
"value":"4"
},
{
"name":"CLIENT_4_INFO",
"value":"4"
},
{
"name":"CLIENT_5_INFO",
"value":"4"
},
{
"name":"CLIENT_6_INFO",
"value":"4"
},
{
"name":"CLIENT_7_INFO",
"value":"4"
},
{
"name":"SITE_LIC_2_INFO",
"value":""
},
{
"name":"SITE_LIC_1_INFO",
"value":""
},
{
"name":"SITE_LIC_4_INFO",
"value":""
},
{
"name":"SITE_LIC_3_INFO",
"value":""
},
{
"name":"SITE_LIC_5_INFO",
"value":""
},
{
"name":"SITE_LIC_6_INFO",
"value":""
},
{
"name":"SITE_LIC_7_INFO",
"value":""
},
{
"name":"VENDOR_PRIVATE_INFO",
"value":""
},
{
"name":"VENDOR_PUBLIC_INFO",
"value":""
},
{
"name":"VENDOR_COMMENTS",
"value":""
},
{
"name":"VENDOR_NUM_OF_SECRETS",
"value":"0"
},
{
"name":"VENDOR_SECRETS_1",
"value":""
},
{
"name":"VENDOR_SECRETS_2",
"value":""
},
{
"name":"VENDOR_SECRETS_3",
"value":""
},
{
"name":"VENDOR_SECRETS_4",
"value":""
},
{
"name":"VENDOR_SECRETS_5",
"value":""
},
{
"name":"VENDOR_SECRETS_6",
"value":""
},
{
"name":"VENDOR_SECRETS_7",
"value":""
},
{
"name":"LICENSE_VENDOR_INFO",
"value":""
}
]
}
},
"itemFeatureState":"INCLUDED"
}
]
}
}
},
"commonLicenseAttributes":[
{
"commonLicenseAttribute":[
{
"name":"LICENSE_VERSION",
"value":"20",
"displayText":"20 - RMS 9.5"
},
{
"name":"NUM_CLIENT_LOCKED",
"value":"1"
},
{
"name":"ALLOW_VM_DETECTION",
"value":"0",
"displayText":"Disabled"
},
{
"name":"CLIENT_1_CRITERIA",
"value":"4",
"displayText":"Disk ID "
}
]
},
{
"commonLicenseAttribute":[
{
"name":"LICENSE_VERSION",
"value":"20",
"displayText":"20 - RMS 9.5"
},
{
"name":"NUM_CLIENT_LOCKED",
"value":"1"
},
{
"name":"ALLOW_VM_DETECTION",
"value":"0",
"displayText":"Disabled"
},
{
"name":"CLIENT_1_CRITERIA",
"value":"4",
"displayText":"Disk ID "
}
]
}
],
"activationAttributes":[
{
"activationAttribute":[
{
"groupName":"LOCKING",
"subGroupName":"",
"name":"CLIENT_1_CRITERIA",
"value":"4",
"readOnly":true,
"mandatory":false,
"associatedAttribute":{
"name":"CLIENT_1_INFO",
"value":"",
"readOnly":false,
"mandatory":true
}
}
]
},
{
"activationAttribute":[
{
"groupName":"LOCKING",
"subGroupName":"",
"name":"CLIENT_1_CRITERIA",
"value":"4",
"readOnly":true,
"mandatory":false,
"associatedAttribute":{
"name":"CLIENT_1_INFO",
"value":"",
"readOnly":false,
"mandatory":true
}
}
]
}
]
}
]
},
"entitlementAttributes":null
}
]
}
}
JSON File Format for Downloads
The following is a sample JSON file format for exporting download data:
{
"downloads":{
"count":1,
"download":[
{
"id":"d95768fc-2781-4c7c-90bf-4e6c8d487a24",
"identifier":"",
"creationDate":"2024-04-15 05:13",
"lastModifiedDate":"2024-04-15 05:13",
"nameVersion":{
"name":"test1",
"version":""
},
"releaseDate":"2024-04-15",
"description":"",
"state":"ENABLE",
"isAttachable":false,
"file":{
"name":"ems",
"size":"",
"logo":"",
"url":"https://emsqa02.ems.engg-services.com/ui-ems/ems",
"signedURL":""
},
"associatedDownloads":null,
"associatedProducts":{
"associatedProduct":[
{
"product":{
"externalId":"",
"id":"b27faa41-42ee-4b9a-aa7f-64f07a899a61",
"nameVersion":{
"name":"Product0799698",
"version":"prodVer7178"
}
},
"state":"ENABLE"
}
]
},
"associatedCustomers":null,
"customAttributes":null
}
]
}
}