Custom Properties

• Custom Property Object
• Supported Actions
  • POST /customproperty/
  • POST /customproperty/bulk/event/{id}
  • GET /customproperty/
  • GET /custompropery/{id}
  • GET /customproperty/event/clone/
  • DEL /customproperty/{id}
  • DEL /customproperty/

---

As for ChapterPoints and Categories, Events can have Custom Properties too. They provide a means for storing any additional information which does not have a suitable location elsewhere in the system.

---

Custom Property Object

{
    "id": "70e36204-e3ba-409e-9d8d-2dcba525d55c",
    "key": "key-here",
    "category": "category-gere",
    "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"
}

Note: Category & Key combinations are unique within the system and will update existing values if re-sent.

Response: 200 OK

---

POST /customproperty/bulk/event/{id}

Add or Update a Custom Properties for the given Event ID.

Request Body:

[
  {
    "id": null,
    "category": "category-here",
    "key": "key-here",
    "value": "value-here"
  },
  {
    "id": null,
    "category": "category2-here",
    "key": "key2-here",
    "value": "value2-here"
  }
]

_Note: id is a GUID and can be null. If null is specified it will be automatically generated.

Note: Category & Key combinations are unique within the system and will update existing values if re-sent.

Response: 200 OK

---

GET /customproperty/

Get many Custom Properties.

Query Parameters:

Name	Type	Required	Description
eventId	Guid	No	The Id of the Event to filter to.
category	String	No	The Category value to filter to.
key	String	No	The Key value to filter to.
value	String	No	The Value value to filter to.

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

---

GET /custompropery/{id}

Get a Custom Property by Id.

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

---

GET /customproperty/event/clone/

Clone the Custom Properties of one Event to another.

Query Parameters:

Name	Type	Required	Description
sourceEventId	Guid	Yes	The source Event Id to copy from.
targetEventId	Guid	Yes	The target Event Id to copy to.
removeSource	bool	No	Whether or not to remove the Custom Properties from the source Event. Defaults to False.

Response: 200 OK

---

DEL /customproperty/{id}

Delete a Custom Property by Id.

Response: 200 OK

---

DEL /customproperty/

Delete many Custom Properties.

Query Parameters:

Name	Type	Required	Description
eventId	Guid	No	The Id of the Event to filter to.
category	String	No	The Category value to filter to.
key	String	No	The Key value to filter to.
value	String	No	The Value value to filter to.

Note: at least 1 parameter must be provided otherwise you will receive a 400 Bad Request response.

Response: 200 OK