POST /config/event_sources/custom_properties/property_xml_expressions
Creates a new Ariel property XML expression.
Creates a new Ariel property XML expression.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
fields |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
data |
Object |
application/json |
Required - A XML representation of the Ariel property XML expression object
|
{ "creation_date": 42, "enabled": true, "expression": "String", "id": 42, "identifier": "String", "log_source_id": 42, "log_source_type_id": 42, "low_level_category_id": 42, "modification_date": 42, "payload": "String", "qid": 42, "regex_property_identifier": "String", "username": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
201 |
A new ariel property XML expression was created. |
|
422 |
1005 |
One or more request parameter are invalid in request. |
500 |
1020 |
An error occurred during the attempt to create a new ariel property XML expression. |
Response Description
- id - Integer - The sequence ID of the Ariel property XML expression.
- identifier - String - The ID of the Ariel property XML expression.
- regex_property_identifier - String - The identifier of the event regex property that this expression belongs to.
- enabled - Boolean - Flag that indicates whether this expression is enabled.
- expression - String - The XML expression path to find the property value from the XML payload.
- payload - String - Test payload. This parameter is only used in the UI so that you can verify your expression matches the expected payload.
- log_source_type_id - Integer - The expression is only applied to events for this log source type.
- log_source_id - Integer - The expression is only applied to events for this log source (more specific than type alone).
- qid - Integer - The expression is only applied to events associated with this QID record.
- low_level_category_id - Integer - The expression is only applied to events with this low level category.
- username - String - The owner of the Ariel property XML expression.
Response Sample
{
"creation_date": 42,
"enabled": true,
"expression": "String",
"id": 42,
"identifier": "String",
"log_source_id": 42,
"log_source_type_id": 42,
"low_level_category_id": 42,
"modification_date": 42,
"payload": "String",
"qid": 42,
"regex_property_identifier": "String",
"username": "String"
}