Edit Asset

Edits an asset in the organizational structure.

 

URL

{RMUrl}/api/Organization/assets/<AssetCode>

 

REQUEST METHOD

PUT

 

URL PARAMETER

AssetCode: This parameter is provided in the URL and does not need to be sent through PUT.

 

FORM CONTENT

Name (Optional): Asset name. Limit of 400 characters.

Responsible (Optional): Person responsible for the asset.

Relevance (Optional): Relevance of the asset. Valid values: whole numbers between 1 and 5, with 1 (Very Low) and 5 (Very High).

Criticality (Optional): Asset criticality. Valid values: whole numbers from 1 to 100.

AnalysisFrequency (Optional): Frequency of the analysis in terms of days. Valid values: positive whole numbers from 0 to 1000.

Description (Optional): Asset description.

Latitude (Optional; Required if the "Longitude" field is completed): Latitude of the asset's location. Valid values: from -90.0 to +90.0. The decimal mark must be represented by a period and not a comma.

Longitude (Optional; Required if the "Latitude" field is completed): Longitude of the asset's location. Valid values: from -180.0 to +180.0. The decimal mark must be represented by a period and not a comma.

GeolocationDescription (Optional): Description of the asset's geographic location. The limit is 1,000 characters.

ZoomLevel (Optional): Zoom level applied to the map of the asset's location. Valid values: whole numbers between 0 and 21.

CustomAttributes (Optional): List of objects with information on asset attributes. Each attribute is referenced by its variable name. Relationship-type attributes can be referenced by the Id field, the Caption field, or both. If both fields are provided, they must refer to the same object. It is recommended to use the Id field whenever possible. See Appendix 2: Format for Completing Attributes for the list of formats for the Id and Caption fields.

 

To move the asset in the organizational structure, the fields below can be used in the form:

Path (Optional): Path in the organizational structure for the asset's new location. The limit is 400 characters for each perimeter in the path.

ParentPerimeter (Optional): ID of the asset's new perimeter.

 

For Technology assets, the following fields can also be sent in the form:

CollectionParameters

HostAddress (Optional): Address of the asset to be collected.

Credentials (Optional): Credentials used to access the target machine.

CollectorServer (Optional): Collector server used to manage the collection.

 

MappingCriteria

NetbiosName (Optional): Name to be mapped to the NetBIOS name identified by a vulnerability scanner. Valid values: Inherited, Disabled, AssetName, HostAddress, or Text attributes created for Technology assets.

IPAddress (Optional): IP address to be mapped to the IP address identified by a vulnerability scanner. Valid values: Inherited, Disabled, AssetName, HostAddress, or Text attributes created for Technology assets.

DNSName (Optional): DNS name to be mapped to the DNS name identified by a vulnerability scanner. Valid values: Inherited, Disabled, AssetName, HostAddress, or Text attributes created for Technology assets.

 

Note: The "null" value in CustomAttributes fields indicates that the inserted values will be deleted. In the other fields, the "null" value means they will be ignored.

 

FORM CONTENT EXAMPLES

Edit a Technology asset:

{

   "Name":"CEOs Tablet",

   "Relevance":3,

   "Criticality":4,

   "AnalysisFrequency":100,

   "Description":"1111",

   "Latitude":-25.761163,

   "Longitude":-33.299314,

   "GeolocationDescription":"Company headquarters",

   "ZoomLevel":8

   "Responsible":{"Name":"John Camden"},

   "CollectionParameters":

   {

    "CollectorServer": "Collector Server",

    "Credentials": "access passwords",

    "HostAddress": " 110.10.1.10"

   },

   "MappingCriteria":

   {

    "IpAddress": null,

    "DnsName": { "Type": "AssetName" },

    "NetbiosName": { "Type": "Attribute","AttributeName": "asset _text" }

   }

   

    "CustomAttributes": {

      "singlerelationship_asset_attribute":{

         "Caption":"Finance Dept > John Smith"},

      "multiplerelationship_group_attribute":[{"Caption":"Finance Dept"},{"Caption":"Information Tech"},{"Caption":"Financial"},{"Caption":"Human Resources"}]

   }

 } 

 

Move an asset in the organizational structure using the Path field:

{

"Path":"Perimeter 03 > Perimeter 04"

}

 

Move an asset in the organizational structure using the ParentPerimeter field:

{

ParentPerimeter:{Id:"dd2fbf95-7bb4-4b3e-9b02-9753909837b6"}

}

 

SUCCESS RESPONSE

HTTP status code 204: NoContent