CUSTOM PROPERTIES

Custom Properties are additional custom metadata that can exist on an Event. They provide a means for storing any additional Event-based information which is suitable elsewhere in the VIS.


Custom Property Object

{
    "id": "70e36204-e3ba-409e-9d8d-2dcba525d55c",
    "key": "Key-Here",
    "category": "Category-Here",
    "value": "Value-Here"
}

Supported Actions

POST /customproperty/

Add or Update a Custom Property.

Request Body:

{
  "CustomPropertyId": null,
  "EventId": "66bbeef8-2dc8-436e-bd88-4411c86b7b76",
  "Category": "category-here",
  "Key": "key-here",
  "Value": "value-here"
}

If the Id is specified then it will perform an Update, else it will Add a new one, as long as the Category and Key does not already exist - if they do, it will be updated to the new value.

Response: 200 OK


GET /custompropery/{id}

Get a Custom Property by Id.

Response: 200 OK and JSON containing the Custom Property object.


GET /customproperty/event/{id}

Get all Custom Properties for an Event by Id.

Response: 200 OK and a JSON array containing multiple Custom Property objects.


GET /customproperty/event/{id}/category/{category}

Get all Custom Properties for a given Event and Category.

Response: 200 OK and a JSON array containing multiple Custom Property objects.


GET /customproperty/event/{id}/key/{key}

Get all Custom Properties for a given Event and Key.

Response: 200 OK and a JSON array containing multiple Custom Property objects.


GET /customproperty/event/{id}/category/{category}/key/{key}

Get all Custom Properties for a given Event, Category, and Key.

Response: 200 OK and a JSON array containing multiple Custom Property objects.


GET /customproperty/event/clone/

Clone the Custom Properties of one Event to another.

Query Parameters:

SourceEventId: {Guid} - Event Id of the source Event.

TargetEventId: {Guid} - Event Id of the target Event.

RemoveSource: {bool} - Set to True to remove the properties from the source.

Response: 200 OK


DEL /customproperty/{id}

Delete a Custom Property by Id.

Response: 200 OK


DEL /customproperty/event/{id}/key{key}

Delete Custom Properties for an Event with a given Key.

Response: 200 OK