Valuekeep Developers - Web API Reference

Business Core | Calendar Event Type

Service to manage entities of type 'CalendarEventKind'.

Overview


URL api/{tenantKey}/{orgKey}/businessCore/calendarEventKinds
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET CalendarEventKinds (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See CalendarEventKindResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /businessCore/calendarEventKinds/odata

GET CalendarEventKind by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See CalendarEventKindResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /businessCore/calendarEventKinds/{id}

GET CalendarEventKind by key

Returns the entity record that matches the specified key.

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.

Response:

When successful, the response body contains the entity record. See CalendarEventKindResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /businessCore/calendarEventKinds/{calendarEventTypeKey}

POST Operations

POST CalendarEventKinds

Creates a new entity record.

The following elements are required:

calendarEventKindResource (ApiCalendarEventKindResource) The request body should contain the entity record that should be created.
See ApiCalendarEventKindResource.

The following elements are optional:

customAttributes (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiCalendarEventKindResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /businessCore/calendarEventKinds

PUT Operations

PUT Set CalendarEventTypeKey CalendarEventKind

Updates the value of attribute 'CalendarEventTypeKey' in the specified entity record.

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /businessCore/calendarEventKinds/{calendarEventTypeKey}/calendarEventTypeKey

PUT Set Description CalendarEventKind

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /businessCore/calendarEventKinds/{calendarEventTypeKey}/description

PUT Set IsActive CalendarEventKind

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /businessCore/calendarEventKinds/{calendarEventTypeKey}/isActive

PUT Set IsDefault CalendarEventKind

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /businessCore/calendarEventKinds/{calendarEventTypeKey}/isDefault

PUT Set Remarks CalendarEventKind

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /businessCore/calendarEventKinds/{calendarEventTypeKey}/remarks

PUT Set Custom Attribute CalendarEventKind

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /businessCore/calendarEventKinds/{calendarEventTypeKey}/{customAttributeName}

DELETE Operations

DELETE CalendarEventKind by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /businessCore/calendarEventKinds/{id}

DELETE CalendarEventKind by key

Deletes the entity record that matches the specified key.

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /businessCore/calendarEventKinds/{calendarEventTypeKey}

Resources


ApiCalendarEventKindResource

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.
description (string) Description.

The following elements are optional:

isDefault (bool) Is Default.
remarks (string) Remarks.


CalendarEventKindResource

The following elements are required:

calendarEventTypeKey (string) Calendar Event Type.
description (string) Description.

The following elements are optional:

isDefault (bool) Is Default.
remarks (string) Remarks.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.