Creates an asset in the organizational structure.
URL
{RMUrl}/api/Organization/assets
REQUEST METHOD
POST
URL PARAMETERS
This feature does not have parameters.
FORM CONTENT
AssetType (Required): Type of asset to be created. Valid values: Person, Process, Environment, and Technology.
Name (Required): Name of the asset to be created. Limit of 400 characters.
Path (Optional if the ParentPerimeter is provided): Path in the organizational structure where the asset will be created. Limit of 400 characters for each perimeter in the path.
ParentPerimeter (Optional if the Path is provided): ID of the perimeter where the asset will be created.
Responsible (Optional): Person responsible for the asset to be created.
Relevance (Required): Relevance of the asset to be created. Valid values: whole numbers between 1 and 5, with 1 (Very Low) and 5 (Very High).
Criticality (Optional): Criticality of the asset to be created. Valid values: whole numbers from 1 to 100.
AnalysisFrequency (Optional): Frequency of the analysis in terms of the number of days. Valid values: positive whole numbers from 0 to 1000.
Description (Optional): Description of the asset to be created.
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 location. Limit of 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.
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 matched to the DNS name identified by a vulnerability scanner. Valid values: Inherited, Disabled, AssetName, HostAddress, or Text attributes created for Technology assets.
FORM CONTENT EXAMPLES
Create an Environment asset using the Path field:
{
"Name":"Asset 1",
"Path":"API",
"AssetType":"Environment"
}
Create an Environment asset using the ParentPerimeter field:
{
"Name": "Asset 2",
"AssetType":"Environment",
"ParentPerimeter": {
"Id": "bc1f6287-6264-4fd7-8b95-db60fae887a3"
}
}
Create an Environment asset with a Relationship attribute using the Caption field:
{
"Name":"Datacenter",
"Path":"Network Administration",
"AssetType":"Environment",
"Description":"Company data processing center",
"Criticality":1.0,
"AnalysisFrequency":30,
"Relevance":5,
"Responsible":{"Name":"John Camden"},
"Latitude":-25.761163,
"Longitude":-33.299314,
"GeolocationDescription":"Company headquarters",
"ZoomLevel":15
"CustomAttributes": {
"singlerelationship_asset_attribute":{
"Caption":"Finance Dept > John Smith"},
"multiplerelationship_group_attribute":[{"Caption":"Finance Dept"},{"Caption":"Information Tech"},{"Caption":"Financial"},{"Caption":"Human Resources"}]
}
Create a Technology asset with its specific fields:
{
"Name":"CEOs Laptop",
"Path":"Marketing",
"AssetType":"Technology",
"Description":"CEO John Camdens laptop",
"Criticality":5.0,
"AnalysisFrequency":10,
"Relevance":5,
"Responsible":{"Name":"John Camden"},
"Latitude":-23.761163,
"Longitude":-53.299314,
"GeolocationDescription":"Company headquarters",
"ZoomLevel":15,
"CollectionParameters":
{
"CollectorServer": "New server",
"Credentials": "jcamdenscomputer",
"HostAddress": " 110.10.1.10"
},
"MappingCriteria":
{
"DnsName": { "Type": "Disabled" },
"IpAddress": { "Type": "AssetName" },
"NetbiosName": { "Type": "Attribute", "AttributeVariableName": "asset_custom_text" }
},
"CustomAttributes": {
"datetime_attribute":"\/Date(1320335183486)\/",
"email_attribute":"info@example.com",
"link_attribute":"http://www.example.com",
"number_attribute":"999",
"paragraph_attribute":"Important information",
"text_attribute":"Attribute content",
"singleselection_attribute":"singleoption",
"multipleselection_attribute":["option1","option2"],
"outline_attribute":["option1","option2"]
"singlerelationship_asset_attribute":{
"Id":"90a849c8-eb27-46e7-9b23-13c6ac26a694"},
"multiplerelationship_group_attribute":[{"Caption":"Finance Dept"},{"Caption":"Information Tech"},{"Caption":"Financial"},{"Caption":"Human Resources"}]
}
}
SUCCESS RESPONSE
The code of the newly created asset. Returns a String.