Edit Dynamic Memory Properties

Updates the properties of a Dynamic Memory file. Consider the following points before editing:

>If the Dynamic Memory file has not been included in any Product—you can edit the Dynamic Memory file and modify all of its attributes.

>If the Dynamic Memory file has been included in one or more Products—you can only edit Ref ID 1, Ref ID 2 and Description.

Method Type URI
POST v90/ws/dynamicMemory/{dynamicMemoryId}.ws

URI Parameters

Parameter Description Type
dynamicMemoryId Identifier of the Dynamic Memory file as stored in database. Integer

Sample Request

See Sample XML for Dynamic Memory Web Services. The XML element names are self-explanatory. However, some of the important element are as follows:

NOTE   The XML must comply with the schema provided for Dynamic Memory. (See XSD for Dynamic Memory)

XML Elements Description Type
memoryName (Required) Specify the dynamic memory file name. String
fileId (Required) Specify the file ID. Integer
size

(Optional) Specify the file size in bytes.

>Maximum file size for Sentinel HL key version 4.x keys: 25944 bytes

>Maximum file size for Sentinel HL key version 6.x keys: 65535 bytes per file out of a total memory of 390304 bytes. You can create nearly six dynamic memory files using the maximum file size for each.

>Maximum file size for Sentinel SL keys: 65535 bytes

Integer
lifeCycleStage

(Optional) Specify the status of dynamic memory.

>Obsolete: Dynamic memory is disabled and it cannot be included with any product.

>Restore: Dynamic memory is enabled (previously Obsolete) and it can now be included with one or more products.

 String
action

(Required). Used for dynamic memory file management. Valid values:

>Set: The new data segment is added to the dynamic memory file. Existing information remains unchanged.

>Overwrite: The new data segment will overwrite the existing information in the file.

>Cancel: The dynamic memory file attached to the specified license is permanently deleted.

 

 

 

String
memorySegment

(Optional) Specify data for the Dynamic Memory.

>offset—(Required) The hexadecimal starting point of the memory segment. Supported range in bytes:

•Sentinel HL key version 4.x keys: 0 to 25943

•Sentinel HL key version 6.x keys: 0 to 65534

•Sentinel SL keys: 0 to 65534

NOTE   The combined value of offset and size must not exceed:

>Sentinel HL key version 4.x keys: 25944 bytes

>Sentinel HL key version 6.x keys: 65535 bytes

>Sentinel SL keys: 65535 bytes

>size—(Required) Size of the segment in bytes. Supported range:

•Sentinel HL key version 4.x keys: 1 to 25944

•Sentinel HL key version 6.x keys: 1 to 65535

•Sentinel SL keys:1 to 65535

>color—Hexadecimal color code.

>name—(Required) The name of the memory segment.

>description—Description for the memory segment.

>saot—Whether the memory data can be defined during Entitlement generation. Valid values: TRUE/FALSE

>content—Specify as a BASE 16 (hexadecimal) encoded string.

Example of memory segment in a Product XML:

<memorySegment>
            <offset>0x0000</offset>
            <size>10</size>
            <color>#9f22bf</color>
            <name>first memory segment</name>
            <description> description for memory segment</description>
            <saot>true</saot>
            <content>memory content</content>
        </memorySegment>
 
memoryType

Specify memory type as:

>1 (Read/Write): Data that can be updated at run-time.

>2 (Read Only): Data to be read at run-time.

>3 (Write Once): Data that can be updated only once at run-time and then is treated as Read Only.

  

Sample Response

Success

HTTP Status Code: 200

Response Body:

<dynamicMemory>
	<memoryName>TestDM</memoryName>
	<memoryId>89</memoryId>
	<fileId>1</fileId>
	<size>100</size>
	<lifeCycleStage>DEPLOYED</lifeCycleStage>
	<memoryDescription></memoryDescription>
	<refId1></refId1>
	<refId2></refId2>
	<action>NONE</action>
	    <memories>
	       <memorySegment>
		<name>seg1</name>
		<description></description>
		<offset>0x0001</offset>
		<size>1</size>
		<content>00</content>
		<color>#fd2f66</color>
		<saot>false</saot>
	       </memorySegment>
               <memorySegment>
		<name>seg2</name>
		<description></description>
		<offset>0x0005</offset>
		<size>5</size>
		<content>0000000000</content>
		<color>#20cc42</color>
		<saot>false</saot>
	       </memorySegment>
	   </memories>
	<memoryType>2</memoryType>
</dynamicMemory>

Failure

HTTP Status Code: 404

Response Body: Dynamic memory name already exists.