Event Types

Save PDF

Last UpdatedJul 22, 2024
20 minute read

`List Event Types`

Returns an array of EventTypes in a given namespace and the version ETag in the HTTP response header. The If-Match and If-None-Match headers are supported.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes
?skip={skip}&count={count}&filter={filter}&includeDeleted={includeDeleted}

Parameters

string tenantId

string namespaceId

[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

[optional] string filter
Parameter representing the condition for results to be filtered by. If unspecified, results are not filtered.

[optional] boolean includeDeleted
Parameter indicating whether to include deleted EventType properties. If unspecified, a default value of false is used.

Response

Status Code	Body Type	Description
200	EventType[]	Success.
304	None	Not modified.
400	AdhErrorResponse	Missing or invalid inputs.
403	AdhErrorResponse	Forbidden.
412	AdhErrorResponse	Precondition failed.

Example response body

200 Response

[
  {
    "Id": "SimpleEvent",
    "Name": "SimpleEvent",
    "GraphQLName": "SimpleEvent",
    "State": "Active",
    "Properties": [
      {
        "PropertyTypeCode": "DateTime",
        "Id": "eventStartTime",
        "Name": "eventStartTime",
        "GraphQLName": "eventStartTime",
        "Flags": "None",
        "State": "Active",
        "Description": "The start time of the event."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "eventEndTime",
        "Name": "eventEndTime",
        "GraphQLName": "eventEndTime",
        "Flags": "None",
        "State": "Active",
        "Description": "The end time of the event."
      },
      {
        "PropertyTypeCode": "TimeSpan",
        "Id": "eventDuration",
        "Name": "eventDuration",
        "GraphQLName": "eventDuration",
        "Flags": "None",
        "State": "Active",
        "Description": "The duration of the event."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "id",
        "Name": "id",
        "GraphQLName": "id",
        "Flags": "None",
        "State": "Active",
        "Description": "A unique identifier for the event instance."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "modifiedDate",
        "Name": "modifiedDate",
        "GraphQLName": "modifiedDate",
        "Flags": "None",
        "State": "Active",
        "Description": "The last modified date and time of the event."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "createdDate",
        "Name": "createdDate",
        "GraphQLName": "createdDate",
        "Flags": "None",
        "State": "Active",
        "Description": "The date and time at which the event was created."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "createdByUser",
        "Name": "createdByUser",
        "GraphQLName": "createdByUser",
        "Flags": "None",
        "State": "Active",
        "Description": "The identity of the user that created the event."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "eventType",
        "Name": "eventType",
        "GraphQLName": "eventType",
        "Flags": "None",
        "State": "Active",
        "Description": "The type of the event."
      },
      {
        "PropertyTypeCode": "Enumeration",
        "Id": "eventState",
        "Name": "eventState",
        "GraphQLName": "eventState",
        "Flags": "None",
        "State": "Active",
        "PropertyTypeId": "EventState",
        "RemoteReferenceName": "EventState",
        "Description": "The state of the event."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "authorizationTags",
        "Name": "authorizationTags",
        "GraphQLName": "authorizationTags",
        "Flags": "IsCollection",
        "State": "Active",
        "Description": "The list of tags used to authorize access to the event."
      }
    ],
    "Version": 1,
    "CreatedDate": "0001-01-01T00:00:00Z",
    "ModifiedDate": "0001-01-01T00:00:00Z",
    "DefaultAuthorizationTag": "BaseAuthorizationTag",
    "Description": "This is a simple event type"
  }
]

400 Response (AdhErrorResponse)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "property1": null,
  "property2": null
}

`Create Event Type With Server Generated Id`

Creates a new EventType. Response includes ETag header.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes

Parameters

string tenantId

string namespaceId

Request Body

An EventType.

{
  "Name": "SimpleEvent",
  "Properties": [
    {
      "Id": "eventStartTime",
      "PropertyTypeCode": "DateTime"
    },
    {
      "Id": "eventEndTime",
      "PropertyTypeCode": "DateTime"
    },
    {
      "Id": "eventDuration",
      "PropertyTypeCode": "TimeSpan"
    }
  ]
}

Response

Status Code	Body Type	Description
201	EventType	Created.
400	AdhErrorResponse	Missing or invalid inputs.
403	AdhErrorResponse	Forbidden.
409	AdhErrorResponse	Conflict.

Example response body

201 Response

{
  "Id": "6B29FC40-CA47-1067-B31D-00DD010662DA",
  "Name": "SimpleEvent",
  "GraphQLName": "SimpleEvent",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventStartTime",
      "Name": "eventStartTime",
      "GraphQLName": "eventStartTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The start time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventEndTime",
      "Name": "eventEndTime",
      "GraphQLName": "eventEndTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The end time of the event."
    },
    {
      "PropertyTypeCode": "TimeSpan",
      "Id": "eventDuration",
      "Name": "eventDuration",
      "GraphQLName": "eventDuration",
      "Flags": "None",
      "State": "Active",
      "Description": "The duration of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the event instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the event was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "eventType",
      "Name": "eventType",
      "GraphQLName": "eventType",
      "Flags": "None",
      "State": "Active",
      "Description": "The type of the event."
    },
    {
      "PropertyTypeCode": "Enumeration",
      "Id": "eventState",
      "Name": "eventState",
      "GraphQLName": "eventState",
      "Flags": "None",
      "State": "Active",
      "PropertyTypeId": "EventState",
      "RemoteReferenceName": "EventState",
      "Description": "The state of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the event."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple event type"
}

400 Response (AdhErrorResponse)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "property1": null,
  "property2": null
}

`Get Event Type By Id`

Returns the specified EventType and the version ETag in the HTTP response header. The If-Match and If-None-Match headers are supported.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}
?includeDeleted={includeDeleted}

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

boolean includeDeleted
Parameter indicating whether to include deleted EventType properties. If unspecified, a default value of false is used.

Response

Status Code	Body Type	Description
200	EventType	Success.
304	None	Not modified.
400	AdhErrorResponse	Missing or invalid inputs.
403	AdhErrorResponse	Forbidden.
404	AdhErrorResponse	EventType not found.
412	AdhErrorResponse	Precondition failed.

Example response body

200 Response

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "GraphQLName": "SimpleEvent",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventStartTime",
      "Name": "eventStartTime",
      "GraphQLName": "eventStartTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The start time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventEndTime",
      "Name": "eventEndTime",
      "GraphQLName": "eventEndTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The end time of the event."
    },
    {
      "PropertyTypeCode": "TimeSpan",
      "Id": "eventDuration",
      "Name": "eventDuration",
      "GraphQLName": "eventDuration",
      "Flags": "None",
      "State": "Active",
      "Description": "The duration of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the event instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the event was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "eventType",
      "Name": "eventType",
      "GraphQLName": "eventType",
      "Flags": "None",
      "State": "Active",
      "Description": "The type of the event."
    },
    {
      "PropertyTypeCode": "Enumeration",
      "Id": "eventState",
      "Name": "eventState",
      "GraphQLName": "eventState",
      "Flags": "None",
      "State": "Active",
      "PropertyTypeId": "EventState",
      "RemoteReferenceName": "EventState",
      "Description": "The state of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the event."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple event type"
}

400 Response (AdhErrorResponse)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "property1": null,
  "property2": null
}

`Get Or Create Event Type`

Creates a new EventType or returns the current one if the body is equivalent to what is stored. Response includes ETag header.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

Request Body

An EventType.

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "Properties": [
    {
      "Id": "eventStartTime",
      "PropertyTypeCode": "DateTime"
    },
    {
      "Id": "eventEndTime",
      "PropertyTypeCode": "DateTime"
    },
    {
      "Id": "eventDuration",
      "PropertyTypeCode": "TimeSpan"
    }
  ]
}

Response

Status Code	Body Type	Description
200	EventType	Success.
201	EventType	Created.
302	None	Found.
400	AdhErrorResponse	Missing or invalid inputs.
403	AdhErrorResponse	Forbidden.
409	AdhErrorResponse	Conflict

Example response body

200 Response

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "GraphQLName": "SimpleEvent",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventStartTime",
      "Name": "eventStartTime",
      "GraphQLName": "eventStartTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The start time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventEndTime",
      "Name": "eventEndTime",
      "GraphQLName": "eventEndTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The end time of the event."
    },
    {
      "PropertyTypeCode": "TimeSpan",
      "Id": "eventDuration",
      "Name": "eventDuration",
      "GraphQLName": "eventDuration",
      "Flags": "None",
      "State": "Active",
      "Description": "The duration of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the event instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the event was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "eventType",
      "Name": "eventType",
      "GraphQLName": "eventType",
      "Flags": "None",
      "State": "Active",
      "Description": "The type of the event."
    },
    {
      "PropertyTypeCode": "Enumeration",
      "Id": "eventState",
      "Name": "eventState",
      "GraphQLName": "eventState",
      "Flags": "None",
      "State": "Active",
      "PropertyTypeId": "EventState",
      "RemoteReferenceName": "EventState",
      "Description": "The state of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the event."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple event type"
}

201 Response

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "GraphQLName": "SimpleEvent",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventStartTime",
      "Name": "eventStartTime",
      "GraphQLName": "eventStartTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The start time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventEndTime",
      "Name": "eventEndTime",
      "GraphQLName": "eventEndTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The end time of the event."
    },
    {
      "PropertyTypeCode": "TimeSpan",
      "Id": "eventDuration",
      "Name": "eventDuration",
      "GraphQLName": "eventDuration",
      "Flags": "None",
      "State": "Active",
      "Description": "The duration of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the event instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the event was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "eventType",
      "Name": "eventType",
      "GraphQLName": "eventType",
      "Flags": "None",
      "State": "Active",
      "Description": "The type of the event."
    },
    {
      "PropertyTypeCode": "Enumeration",
      "Id": "eventState",
      "Name": "eventState",
      "GraphQLName": "eventState",
      "Flags": "None",
      "State": "Active",
      "PropertyTypeId": "EventState",
      "RemoteReferenceName": "EventState",
      "Description": "The state of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the event."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple event type"
}

400 Response (AdhErrorResponse)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "property1": null,
  "property2": null
}

`Create Or Update Event Type`

Creates a new EventType or updates an existing and adds its Etag in the HTTP response header. Updating the state of the properties to deleted is supported through this route. Hard Delete of the type however must be done with through the DELETE endpoint. The If-Match header is supported.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

Request Body

An EventType.

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "Properties": [
    {
      "Id": "eventStartTime",
      "PropertyTypeCode": "DateTime"
    },
    {
      "Id": "eventEndTime",
      "PropertyTypeCode": "DateTime"
    },
    {
      "Id": "eventDuration",
      "PropertyTypeCode": "TimeSpan"
    }
  ]
}

Response

Status Code	Body Type	Description
200	EventType	Success.
201	EventType	Created.
400	AdhErrorResponse	Missing or invalid inputs.
403	AdhErrorResponse	Forbidden.
409	AdhErrorResponse	Conflict.
412	AdhErrorResponse	Precondition failed.

Example response body

200 Response

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "GraphQLName": "SimpleEvent",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventStartTime",
      "Name": "eventStartTime",
      "GraphQLName": "eventStartTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The start time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventEndTime",
      "Name": "eventEndTime",
      "GraphQLName": "eventEndTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The end time of the event."
    },
    {
      "PropertyTypeCode": "TimeSpan",
      "Id": "eventDuration",
      "Name": "eventDuration",
      "GraphQLName": "eventDuration",
      "Flags": "None",
      "State": "Active",
      "Description": "The duration of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the event instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the event was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "eventType",
      "Name": "eventType",
      "GraphQLName": "eventType",
      "Flags": "None",
      "State": "Active",
      "Description": "The type of the event."
    },
    {
      "PropertyTypeCode": "Enumeration",
      "Id": "eventState",
      "Name": "eventState",
      "GraphQLName": "eventState",
      "Flags": "None",
      "State": "Active",
      "PropertyTypeId": "EventState",
      "RemoteReferenceName": "EventState",
      "Description": "The state of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the event."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple event type"
}

201 Response

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "GraphQLName": "SimpleEvent",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventStartTime",
      "Name": "eventStartTime",
      "GraphQLName": "eventStartTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The start time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventEndTime",
      "Name": "eventEndTime",
      "GraphQLName": "eventEndTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The end time of the event."
    },
    {
      "PropertyTypeCode": "TimeSpan",
      "Id": "eventDuration",
      "Name": "eventDuration",
      "GraphQLName": "eventDuration",
      "Flags": "None",
      "State": "Active",
      "Description": "The duration of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the event instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the event was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "eventType",
      "Name": "eventType",
      "GraphQLName": "eventType",
      "Flags": "None",
      "State": "Active",
      "Description": "The type of the event."
    },
    {
      "PropertyTypeCode": "Enumeration",
      "Id": "eventState",
      "Name": "eventState",
      "GraphQLName": "eventState",
      "Flags": "None",
      "State": "Active",
      "PropertyTypeId": "EventState",
      "RemoteReferenceName": "EventState",
      "Description": "The state of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the event."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple event type"
}

400 Response (AdhErrorResponse)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "property1": null,
  "property2": null
}

`Delete Event Type By Id`

Deletes the EventType.

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

Response

Status Code	Body Type	Description
204	None	Deleted.
400	AdhErrorResponse	Missing or invalid inputs.
403	AdhErrorResponse	Forbidden.
404	AdhErrorResponse	EventType not found.
409	AdhErrorResponse	Conflict.

`Bulk Create Event Type`

Creates multiple new EventType and returns a list of any errors along with the created objects. Response includes ETag header.

Request

POST /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/EventTypes

Parameters

string tenantId

string namespaceId

Request Body

A list of EventType objects.

Response

Status Code	Body Type	Description
200	EventType	Success.
207	MultiStatusResultOfEventTypeAndAdhErrorResponse	Partial.
400	AdhErrorResponse	Missing or invalid inputs.
403	AdhErrorResponse	Forbidden.
409	AdhErrorResponse	Conflict.

Example response body

200 Response

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "GraphQLName": "SimpleEvent",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventStartTime",
      "Name": "eventStartTime",
      "GraphQLName": "eventStartTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The start time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventEndTime",
      "Name": "eventEndTime",
      "GraphQLName": "eventEndTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The end time of the event."
    },
    {
      "PropertyTypeCode": "TimeSpan",
      "Id": "eventDuration",
      "Name": "eventDuration",
      "GraphQLName": "eventDuration",
      "Flags": "None",
      "State": "Active",
      "Description": "The duration of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the event instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the event was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "eventType",
      "Name": "eventType",
      "GraphQLName": "eventType",
      "Flags": "None",
      "State": "Active",
      "Description": "The type of the event."
    },
    {
      "PropertyTypeCode": "Enumeration",
      "Id": "eventState",
      "Name": "eventState",
      "GraphQLName": "eventState",
      "Flags": "None",
      "State": "Active",
      "PropertyTypeId": "EventState",
      "RemoteReferenceName": "EventState",
      "Description": "The state of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the event."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple event type"
}

207 Response (MultiStatusResultOfEventTypeAndAdhErrorResponse)

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SimpleEvent",
      "Name": "SimpleEvent",
      "GraphQLName": "SimpleEvent",
      "State": "Active",
      "Properties": [
        {
          "PropertyTypeCode": "DateTime",
          "Id": "eventStartTime",
          "Name": "eventStartTime",
          "GraphQLName": "eventStartTime",
          "Flags": "None",
          "State": "Active",
          "Description": "The start time of the event."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "eventEndTime",
          "Name": "eventEndTime",
          "GraphQLName": "eventEndTime",
          "Flags": "None",
          "State": "Active",
          "Description": "The end time of the event."
        },
        {
          "PropertyTypeCode": "TimeSpan",
          "Id": "eventDuration",
          "Name": "eventDuration",
          "GraphQLName": "eventDuration",
          "Flags": "None",
          "State": "Active",
          "Description": "The duration of the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "id",
          "Name": "id",
          "GraphQLName": "id",
          "Flags": "None",
          "State": "Active",
          "Description": "A unique identifier for the event instance."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "modifiedDate",
          "Name": "modifiedDate",
          "GraphQLName": "modifiedDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The last modified date and time of the event."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "createdDate",
          "Name": "createdDate",
          "GraphQLName": "createdDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The date and time at which the event was created."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "createdByUser",
          "Name": "createdByUser",
          "GraphQLName": "createdByUser",
          "Flags": "None",
          "State": "Active",
          "Description": "The identity of the user that created the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "eventType",
          "Name": "eventType",
          "GraphQLName": "eventType",
          "Flags": "None",
          "State": "Active",
          "Description": "The type of the event."
        },
        {
          "PropertyTypeCode": "Enumeration",
          "Id": "eventState",
          "Name": "eventState",
          "GraphQLName": "eventState",
          "Flags": "None",
          "State": "Active",
          "PropertyTypeId": "EventState",
          "RemoteReferenceName": "EventState",
          "Description": "The state of the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "authorizationTags",
          "Name": "authorizationTags",
          "GraphQLName": "authorizationTags",
          "Flags": "IsCollection",
          "State": "Active",
          "Description": "The list of tags used to authorize access to the event."
        }
      ],
      "Version": 1,
      "CreatedDate": "0001-01-01T00:00:00Z",
      "ModifiedDate": "0001-01-01T00:00:00Z",
      "DefaultAuthorizationTag": "BaseAuthorizationTag",
      "Description": "This is a simple event type"
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Reason": "string",
      "Resolution": "string",
      "property1": null,
      "property2": null
    }
  ]
}

`Bulk Delete Event Type`

Deletes multiple EventTypes and returns an Ok if successful. In the case where a deletion is invalid, it will be added to a child errors list while the ones that were successful will be returned in the data.

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Bulk/EventTypes

Parameters

string tenantId

string namespaceId

Request Body

A list of EventType object ids.

Response

Status Code	Body Type	Description
200	EventType[]	Success.
207	MultiStatusResultOfEventTypeAndAdhErrorResponse	Partial.
400	AdhErrorResponse	Missing or invalid inputs.
403	AdhErrorResponse	Forbidden.
409	AdhErrorResponse	Conflict.

Example response body

200 Response

[
  {
    "Id": "SimpleEvent",
    "Name": "SimpleEvent",
    "GraphQLName": "SimpleEvent",
    "State": "Active",
    "Properties": [
      {
        "PropertyTypeCode": "DateTime",
        "Id": "eventStartTime",
        "Name": "eventStartTime",
        "GraphQLName": "eventStartTime",
        "Flags": "None",
        "State": "Active",
        "Description": "The start time of the event."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "eventEndTime",
        "Name": "eventEndTime",
        "GraphQLName": "eventEndTime",
        "Flags": "None",
        "State": "Active",
        "Description": "The end time of the event."
      },
      {
        "PropertyTypeCode": "TimeSpan",
        "Id": "eventDuration",
        "Name": "eventDuration",
        "GraphQLName": "eventDuration",
        "Flags": "None",
        "State": "Active",
        "Description": "The duration of the event."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "id",
        "Name": "id",
        "GraphQLName": "id",
        "Flags": "None",
        "State": "Active",
        "Description": "A unique identifier for the event instance."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "modifiedDate",
        "Name": "modifiedDate",
        "GraphQLName": "modifiedDate",
        "Flags": "None",
        "State": "Active",
        "Description": "The last modified date and time of the event."
      },
      {
        "PropertyTypeCode": "DateTime",
        "Id": "createdDate",
        "Name": "createdDate",
        "GraphQLName": "createdDate",
        "Flags": "None",
        "State": "Active",
        "Description": "The date and time at which the event was created."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "createdByUser",
        "Name": "createdByUser",
        "GraphQLName": "createdByUser",
        "Flags": "None",
        "State": "Active",
        "Description": "The identity of the user that created the event."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "eventType",
        "Name": "eventType",
        "GraphQLName": "eventType",
        "Flags": "None",
        "State": "Active",
        "Description": "The type of the event."
      },
      {
        "PropertyTypeCode": "Enumeration",
        "Id": "eventState",
        "Name": "eventState",
        "GraphQLName": "eventState",
        "Flags": "None",
        "State": "Active",
        "PropertyTypeId": "EventState",
        "RemoteReferenceName": "EventState",
        "Description": "The state of the event."
      },
      {
        "PropertyTypeCode": "String",
        "Id": "authorizationTags",
        "Name": "authorizationTags",
        "GraphQLName": "authorizationTags",
        "Flags": "IsCollection",
        "State": "Active",
        "Description": "The list of tags used to authorize access to the event."
      }
    ],
    "Version": 1,
    "CreatedDate": "0001-01-01T00:00:00Z",
    "ModifiedDate": "0001-01-01T00:00:00Z",
    "DefaultAuthorizationTag": "BaseAuthorizationTag",
    "Description": "This is a simple event type"
  }
]

207 Response (MultiStatusResultOfEventTypeAndAdhErrorResponse)

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SimpleEvent",
      "Name": "SimpleEvent",
      "GraphQLName": "SimpleEvent",
      "State": "Active",
      "Properties": [
        {
          "PropertyTypeCode": "DateTime",
          "Id": "eventStartTime",
          "Name": "eventStartTime",
          "GraphQLName": "eventStartTime",
          "Flags": "None",
          "State": "Active",
          "Description": "The start time of the event."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "eventEndTime",
          "Name": "eventEndTime",
          "GraphQLName": "eventEndTime",
          "Flags": "None",
          "State": "Active",
          "Description": "The end time of the event."
        },
        {
          "PropertyTypeCode": "TimeSpan",
          "Id": "eventDuration",
          "Name": "eventDuration",
          "GraphQLName": "eventDuration",
          "Flags": "None",
          "State": "Active",
          "Description": "The duration of the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "id",
          "Name": "id",
          "GraphQLName": "id",
          "Flags": "None",
          "State": "Active",
          "Description": "A unique identifier for the event instance."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "modifiedDate",
          "Name": "modifiedDate",
          "GraphQLName": "modifiedDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The last modified date and time of the event."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "createdDate",
          "Name": "createdDate",
          "GraphQLName": "createdDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The date and time at which the event was created."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "createdByUser",
          "Name": "createdByUser",
          "GraphQLName": "createdByUser",
          "Flags": "None",
          "State": "Active",
          "Description": "The identity of the user that created the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "eventType",
          "Name": "eventType",
          "GraphQLName": "eventType",
          "Flags": "None",
          "State": "Active",
          "Description": "The type of the event."
        },
        {
          "PropertyTypeCode": "Enumeration",
          "Id": "eventState",
          "Name": "eventState",
          "GraphQLName": "eventState",
          "Flags": "None",
          "State": "Active",
          "PropertyTypeId": "EventState",
          "RemoteReferenceName": "EventState",
          "Description": "The state of the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "authorizationTags",
          "Name": "authorizationTags",
          "GraphQLName": "authorizationTags",
          "Flags": "IsCollection",
          "State": "Active",
          "Description": "The list of tags used to authorize access to the event."
        }
      ],
      "Version": 1,
      "CreatedDate": "0001-01-01T00:00:00Z",
      "ModifiedDate": "0001-01-01T00:00:00Z",
      "DefaultAuthorizationTag": "BaseAuthorizationTag",
      "Description": "This is a simple event type"
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Reason": "string",
      "Resolution": "string",
      "property1": null,
      "property2": null
    }
  ]
}

`Get Event Type Acl By Id`

Returns the AccessControlList for the specified EventType.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}/AccessControl

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

Response

Status Code	Body Type	Description
200	AccessControlList	Success.
403	AdhErrorResponse	Forbidden.
404	AdhErrorResponse	EventType not found.

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

`Update Event Type Acl By Id`

Updates and returns the AccessControlList for the specified EventType.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}/AccessControl

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

Request Body

An AccessControlList.

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "11111111-1111-1111-1111-111111111111"
      },
      "AccessType": 0,
      "AccessRights": 3
    },
    {
      "Trustee": {
        "Type": 3,
        "ObjectId": "22222222-2222-2222-1111-111111111111"
      },
      "AccessType": 0,
      "AccessRights": 15
    }
  ]
}

Response

Status Code	Body Type	Description
200	AccessControlList	Success.
403	AdhErrorResponse	Forbidden.
404	AdhErrorResponse	EventType not found.

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

`Get Event Type Owner By Id`

Returns the Trustee for the specified EventType.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}/Owner

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

Response

Status Code	Body Type	Description
200	Trustee	Success.
403	AdhErrorResponse	Forbidden.
404	AdhErrorResponse	EventType not found.

Example response body

200 Response (Trustee)

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

`Update Event Type Owner By Id`

Updates and returns the Trustee for the specified EventType.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}/Owner

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

Request Body

A Trustee.

{
  "Type": 1,
  "TenantId": "55555555-5555-5555-5555-555555555555",
  "ObjectId": "44444444-4444-4444-4444-444444444444"
}

Response

Status Code	Body Type	Description
200	Trustee	Success.
403	AdhErrorResponse	Forbidden.
404	AdhErrorResponse	EventType not found.

Example response body

200 Response (Trustee)

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

`List Event Type Access Rights By Id`

Returns a list of CommonAccessRights for the specified EventType.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/EventTypes/{id}/AccessRights

Parameters

string tenantId

string namespaceId

string id
The id of the EventType.

Response

Status Code	Body Type	Description
200	Inline	Success.
403	AdhErrorResponse	Forbidden.
404	AdhErrorResponse	EventType not found.

Definitions

EventType

Represents an EventType object.

Properties

Property Name	Data Type	Required	Nullable	Description
Name	string	false	true	The name of this object
GraphQLName	string	false	true	The name of this object as it appears in GraphQL
Version	int32	false	false	The current version number of this object
Id	string	false	true	The id which is used in lookup
State	LifeCycleState	false	false	The lifecycle state of this object
CreatedDate	date-time	false	true	Date this object was created
ModifiedDate	date-time	false	true	The last time this object was modified
Description	string	false	true	Description of what this object is
Properties	[TypeProperty]	false	true	List of TypeProperty associated with this EventType
DefaultAuthorizationTag	string	false	true	The authorization tag that will be added to all instances of nodes based on the type

{
  "Id": "SimpleEvent",
  "Name": "SimpleEvent",
  "GraphQLName": "SimpleEvent",
  "State": "Active",
  "Properties": [
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventStartTime",
      "Name": "eventStartTime",
      "GraphQLName": "eventStartTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The start time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "eventEndTime",
      "Name": "eventEndTime",
      "GraphQLName": "eventEndTime",
      "Flags": "None",
      "State": "Active",
      "Description": "The end time of the event."
    },
    {
      "PropertyTypeCode": "TimeSpan",
      "Id": "eventDuration",
      "Name": "eventDuration",
      "GraphQLName": "eventDuration",
      "Flags": "None",
      "State": "Active",
      "Description": "The duration of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "id",
      "Name": "id",
      "GraphQLName": "id",
      "Flags": "None",
      "State": "Active",
      "Description": "A unique identifier for the event instance."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "modifiedDate",
      "Name": "modifiedDate",
      "GraphQLName": "modifiedDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The last modified date and time of the event."
    },
    {
      "PropertyTypeCode": "DateTime",
      "Id": "createdDate",
      "Name": "createdDate",
      "GraphQLName": "createdDate",
      "Flags": "None",
      "State": "Active",
      "Description": "The date and time at which the event was created."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "createdByUser",
      "Name": "createdByUser",
      "GraphQLName": "createdByUser",
      "Flags": "None",
      "State": "Active",
      "Description": "The identity of the user that created the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "eventType",
      "Name": "eventType",
      "GraphQLName": "eventType",
      "Flags": "None",
      "State": "Active",
      "Description": "The type of the event."
    },
    {
      "PropertyTypeCode": "Enumeration",
      "Id": "eventState",
      "Name": "eventState",
      "GraphQLName": "eventState",
      "Flags": "None",
      "State": "Active",
      "PropertyTypeId": "EventState",
      "RemoteReferenceName": "EventState",
      "Description": "The state of the event."
    },
    {
      "PropertyTypeCode": "String",
      "Id": "authorizationTags",
      "Name": "authorizationTags",
      "GraphQLName": "authorizationTags",
      "Flags": "IsCollection",
      "State": "Active",
      "Description": "The list of tags used to authorize access to the event."
    }
  ],
  "Version": 1,
  "CreatedDate": "0001-01-01T00:00:00Z",
  "ModifiedDate": "0001-01-01T00:00:00Z",
  "DefaultAuthorizationTag": "BaseAuthorizationTag",
  "Description": "This is a simple event type"
}

LifeCycleState

Enumerated Values

Property	Value
Active	0
Deprecated	1
Deleted	2

TypeProperty

Properties

Property Name	Data Type	Required	Nullable	Description
PropertyTypeCode	PropertyTypeCode	false	false	Code that explains what kind of typeProperty this is
Id	string	false	true	The id; used in lookup
Name	string	false	true	The name of this TypeProperty
GraphQLName	string	false	true	The name of this TypeProperty as it appears in GraphQL
Flags	PropertyTypeFlags	false	false	Flag that denotes what special attributes this property has
State	LifeCycleState	false	false	The lifecycle state of this TypeProperty
PropertyTypeId	string	false	true	The id of the type that this property points to
RemoteReferenceName	string	false	true	The name of the invisible property that is generated in GraphQL type schema if the ReverseLookup flag is set that points to this TypeProperty
Description	string	false	true	Description of what this TypeProperty is
Uom	string	false	true	The unit of measure for the type property. This property is only present/valid for numeric PropertyTypeCodes

{
  "PropertyTypeCode": 0,
  "Id": "string",
  "Name": "string",
  "GraphQLName": "string",
  "Flags": 0,
  "State": 0,
  "PropertyTypeId": "string",
  "RemoteReferenceName": "string",
  "Description": "string",
  "Uom": "string"
}

PropertyTypeCode

Enumerated Values

Property	Value
Empty	0
Boolean	3
Int32	9
Int64	11
Double	14
DateTime	16
String	18
TimeSpan	21
Event	10000
Enumeration	10001
ReferenceData	10002
Asset	10003

PropertyTypeFlags

Enumerated Values

Property	Value
None	0
NoReverseLookup	1
Indexed	2
Required	4
IsCollection	8
NoUom	16
NoAggregation	32

AdhErrorResponse

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	false	true	An optional unique string used to identify an operation
Error	string	false	true	Description of the error
Reason	string	false	true	Short blurb on why the error occured
Resolution	string	false	true	Short blurb on how to fix the error

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "property1": null,
  "property2": null
}

MultiStatusResultOfEventTypeAndAdhErrorResponse

Properties

Property Name	Data Type	Required	Nullable	Description
Reason	string	false	false	Short blurb on why the error occured
Error	string	false	false	Description of the error
OperationId	string	false	false	An optional unique string used to identify an operation
Data	[EventType]	false	false	List of data returned from the multi-calls
ChildErrors	[AdhErrorResponse]	false	false	List of errors from all the multi-calls

{
  "Reason": "string",
  "Error": "string",
  "OperationId": "string",
  "Data": [
    {
      "Id": "SimpleEvent",
      "Name": "SimpleEvent",
      "GraphQLName": "SimpleEvent",
      "State": "Active",
      "Properties": [
        {
          "PropertyTypeCode": "DateTime",
          "Id": "eventStartTime",
          "Name": "eventStartTime",
          "GraphQLName": "eventStartTime",
          "Flags": "None",
          "State": "Active",
          "Description": "The start time of the event."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "eventEndTime",
          "Name": "eventEndTime",
          "GraphQLName": "eventEndTime",
          "Flags": "None",
          "State": "Active",
          "Description": "The end time of the event."
        },
        {
          "PropertyTypeCode": "TimeSpan",
          "Id": "eventDuration",
          "Name": "eventDuration",
          "GraphQLName": "eventDuration",
          "Flags": "None",
          "State": "Active",
          "Description": "The duration of the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "id",
          "Name": "id",
          "GraphQLName": "id",
          "Flags": "None",
          "State": "Active",
          "Description": "A unique identifier for the event instance."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "modifiedDate",
          "Name": "modifiedDate",
          "GraphQLName": "modifiedDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The last modified date and time of the event."
        },
        {
          "PropertyTypeCode": "DateTime",
          "Id": "createdDate",
          "Name": "createdDate",
          "GraphQLName": "createdDate",
          "Flags": "None",
          "State": "Active",
          "Description": "The date and time at which the event was created."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "createdByUser",
          "Name": "createdByUser",
          "GraphQLName": "createdByUser",
          "Flags": "None",
          "State": "Active",
          "Description": "The identity of the user that created the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "eventType",
          "Name": "eventType",
          "GraphQLName": "eventType",
          "Flags": "None",
          "State": "Active",
          "Description": "The type of the event."
        },
        {
          "PropertyTypeCode": "Enumeration",
          "Id": "eventState",
          "Name": "eventState",
          "GraphQLName": "eventState",
          "Flags": "None",
          "State": "Active",
          "PropertyTypeId": "EventState",
          "RemoteReferenceName": "EventState",
          "Description": "The state of the event."
        },
        {
          "PropertyTypeCode": "String",
          "Id": "authorizationTags",
          "Name": "authorizationTags",
          "GraphQLName": "authorizationTags",
          "Flags": "IsCollection",
          "State": "Active",
          "Description": "The list of tags used to authorize access to the event."
        }
      ],
      "Version": 1,
      "CreatedDate": "0001-01-01T00:00:00Z",
      "ModifiedDate": "0001-01-01T00:00:00Z",
      "DefaultAuthorizationTag": "BaseAuthorizationTag",
      "Description": "This is a simple event type"
    }
  ],
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Reason": "string",
      "Resolution": "string",
      "property1": null,
      "property2": null
    }
  ]
}

AccessControlList

Properties

Property Name	Data Type	Required	Nullable	Description
RoleTrusteeAccessControlEntries	[AccessControlEntry]	false	true	None

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

AccessControlEntry

Properties

Property Name	Data Type	Required	Nullable	Description
Trustee	Trustee	false	true	None
AccessType	AccessType	false	false	None
AccessRights	int64	false	false	None

{
  "Trustee": {
    "Type": 1,
    "ObjectId": "string",
    "TenantId": "string"
  },
  "AccessType": 0,
  "AccessRights": 0
}

Trustee

Properties

Property Name	Data Type	Required	Nullable	Description
Type	TrusteeType	false	false	None
ObjectId	string	false	true	None
TenantId	string	false	true	None

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

TrusteeType

Enumerated Values

Property	Value
User	1
Client	2
Role	3

AccessType

Enumerated Values

Property	Value
Allowed	0
Denied	1

CONNECT data services developer documentation

Event Types

List Event Types

Request

Parameters

Response

Example response body

Create Event Type With Server Generated Id

Request

Parameters

Request Body

Response

Example response body

Get Event Type By Id

Request

Parameters

Response

Example response body

Get Or Create Event Type

Request

Parameters

Request Body

Response

Example response body

Create Or Update Event Type

Request

Parameters

Request Body

Response

Example response body

Delete Event Type By Id

Request

Parameters

Response

Bulk Create Event Type

Request

Parameters

Request Body

Response

Example response body

Bulk Delete Event Type

Request

Parameters

Request Body

Response

Example response body

Get Event Type Acl By Id

Request

Parameters

Response

Example response body

Update Event Type Acl By Id

Request

Parameters

Request Body

Response

Example response body

Get Event Type Owner By Id

Request

Parameters

Response

Example response body

Update Event Type Owner By Id

Request

Parameters

Request Body

Response

Example response body

List Event Type Access Rights By Id

Request

Parameters

Response

Definitions

EventType

Properties

LifeCycleState

Enumerated Values

TypeProperty

Properties

PropertyTypeCode

`List Event Types`

`Create Event Type With Server Generated Id`

`Get Event Type By Id`

`Get Or Create Event Type`

`Create Or Update Event Type`

`Delete Event Type By Id`

`Bulk Create Event Type`

`Bulk Delete Event Type`

`Get Event Type Acl By Id`

`Update Event Type Acl By Id`

`Get Event Type Owner By Id`

`Update Event Type Owner By Id`

`List Event Type Access Rights By Id`