Define Memory

NOTE   Memory files are relevant only for Sentinel LDK.

You can define data files, called memory files, to store strings in a product key. In this guide, we will create a memory file, TestFile.

You can create a memory file by using the following API endpoint:

POST /ems/api/v5/memory

Create a Memory File

To create a memory fileTestFile, set the following parameters in the input:

Parameter

Value

Meaning

Namespace    
name

Vendor-specific batch code

Name of the namespace (batch code) to which the memory file belongs.
Memory File

fileName

TestFile

Name of the memory file.

fileId

123

Integer to identify the memory file in your application.

state ACTIVE State of the memory file. You can associate only active memory files with a product.
text 73616d706c652074657874 Data in the hexadecimal format that you want to store in the memory file. The 73616d706c652074657874 value given here will be shown as "sample text" in Sentinel EMS Vendor Portal.

Sample Input

Use the following JSON to create the memory file TestFile:

{
  "memory": {
    "namespace": {
      "name": "DEMOMA"
    },
    "fileName": "TestFile",
    "fileId": 123,
    "text": "73616d706c652074657874",
    "state": "ACTIVE"
  }
}

NOTE   In the above sample input, replace DEMOMA with your vendor-specific batch code.

Sample Response (Success)

Response Body
{
  "memory": {
    "id": "67c6c4d9-358e-430c-a6f2-45ff5df9c993",
    "fileName": "TestFile",
    "fileId": 123,
    "description": "",
    "refId1": "",
    "refId2": "",
    "state": "ACTIVE",
    "deployed": false,
    "fileType": "READ_ONLY",
    "fileSize": null,
    "segmentName": "",
    "size": null,
    "offset": "0x000000",
    "text": "73616d706c652074657874",
    "creationDate": "2025-01-31 05:11",
    "lastModifiedDate": "2025-01-31 05:11",
    "defaultMemory": false,
    "namespace": {
      "name": "DEMOMA"
    }
  }
}
HTTP Status Code

201 (Created)

Response Header

The auto-generated unique identifier (id) of the new memory file is returned in the response header. For example:

/api/v5/memory/xxxxx-xxxxx-xxxxx-xxxxx