GET api/organizations/current/users/current/notification-events?entityDefinitionId={entityDefinitionId}&entityCategoryId={entityCategoryId}&entityAttributeId={entityAttributeId}&entityInstanceId={entityInstanceId}&notificationEventScope={notificationEventScope}&notificationEventType={notificationEventType}&notificationEventSubject={notificationEventSubject}&notificationEventActionType={notificationEventActionType}

Gets a collection of NotificationEvents corresponding to the specified filters.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityDefinitionId

The id of the EntityDefinition the NotificationEvents to get must be related to.

integer

Required

entityCategoryId

The id of the EntityCategory the NotificationEvents to get must be related to.

integer

Required

entityAttributeId

The id of the EntityAttribute the NotificationEvents to get must be related to.

integer

Required

entityInstanceId

The id of the EntityInstance the NotificationEvents to get must be related to.

integer

Required

notificationEventScope

The NotificationEventScope of the NotificationEvents to get.

NotificationEventScope

Required

notificationEventType

The type of NotificationEvents to get.

NotificationEventType

Required

notificationEventSubject

The subject of the NotificationEvents to get.

NotificationEventSubject

Required

notificationEventActionType

The type of the action that is to be executed.

NotificationEventActionType

Required



Body Parameters

None.



Response Information

Resource Description

The requested NotificationEvent collection.

Collection of NotificationEventViewModel

NameDescriptionTypeAdditional information
EmailSubscribers

Collection of string

None.

EntityAttributeId

integer

None.

EntityCategoryId

integer

None.

EntityDefinitionId

integer

None.

EntityInstanceId

integer

None.

Id

integer

None.

NotificationEventActionTypeId

integer

None.

NotificationEventScopeId

integer

None.

NotificationEventSubjectId

integer

None.

NotificationEventTypeId

integer

None.

PostconditionCriteria

Collection of EntityCriteriaListCriteriaViewModel

None.

PreconditionCriteria

Collection of EntityCriteriaListCriteriaViewModel

None.

UpcomingEventDayOffset

integer

None.

UserSubscribers

Collection of globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "EmailSubscribers": [
      "sample string 1",
      "sample string 2"
    ],
    "EntityAttributeId": 1,
    "EntityCategoryId": 1,
    "EntityDefinitionId": 1,
    "EntityInstanceId": 1,
    "Id": 1,
    "NotificationEventActionTypeId": 2,
    "NotificationEventScopeId": 3,
    "NotificationEventSubjectId": 4,
    "NotificationEventTypeId": 5,
    "PostconditionCriteria": [
      {
        "CompareValue": "sample string 1",
        "EntityAttributeId": 2,
        "IsDateOfToday": true,
        "DateOfTodayDayOffset": 4,
        "ModifierId": 5,
        "RecursionPath": [
          1,
          2
        ]
      },
      {
        "CompareValue": "sample string 1",
        "EntityAttributeId": 2,
        "IsDateOfToday": true,
        "DateOfTodayDayOffset": 4,
        "ModifierId": 5,
        "RecursionPath": [
          1,
          2
        ]
      }
    ],
    "PreconditionCriteria": [
      {
        "CompareValue": "sample string 1",
        "EntityAttributeId": 2,
        "IsDateOfToday": true,
        "DateOfTodayDayOffset": 4,
        "ModifierId": 5,
        "RecursionPath": [
          1,
          2
        ]
      },
      {
        "CompareValue": "sample string 1",
        "EntityAttributeId": 2,
        "IsDateOfToday": true,
        "DateOfTodayDayOffset": 4,
        "ModifierId": 5,
        "RecursionPath": [
          1,
          2
        ]
      }
    ],
    "UpcomingEventDayOffset": 1,
    "UserSubscribers": [
      "c5407f59-2817-4557-855c-eee133d2995a",
      "ed5de57e-cce2-4242-a7ea-9eadd4bed518"
    ]
  },
  {
    "EmailSubscribers": [
      "sample string 1",
      "sample string 2"
    ],
    "EntityAttributeId": 1,
    "EntityCategoryId": 1,
    "EntityDefinitionId": 1,
    "EntityInstanceId": 1,
    "Id": 1,
    "NotificationEventActionTypeId": 2,
    "NotificationEventScopeId": 3,
    "NotificationEventSubjectId": 4,
    "NotificationEventTypeId": 5,
    "PostconditionCriteria": [
      {
        "CompareValue": "sample string 1",
        "EntityAttributeId": 2,
        "IsDateOfToday": true,
        "DateOfTodayDayOffset": 4,
        "ModifierId": 5,
        "RecursionPath": [
          1,
          2
        ]
      },
      {
        "CompareValue": "sample string 1",
        "EntityAttributeId": 2,
        "IsDateOfToday": true,
        "DateOfTodayDayOffset": 4,
        "ModifierId": 5,
        "RecursionPath": [
          1,
          2
        ]
      }
    ],
    "PreconditionCriteria": [
      {
        "CompareValue": "sample string 1",
        "EntityAttributeId": 2,
        "IsDateOfToday": true,
        "DateOfTodayDayOffset": 4,
        "ModifierId": 5,
        "RecursionPath": [
          1,
          2
        ]
      },
      {
        "CompareValue": "sample string 1",
        "EntityAttributeId": 2,
        "IsDateOfToday": true,
        "DateOfTodayDayOffset": 4,
        "ModifierId": 5,
        "RecursionPath": [
          1,
          2
        ]
      }
    ],
    "UpcomingEventDayOffset": 1,
    "UserSubscribers": [
      "c5407f59-2817-4557-855c-eee133d2995a",
      "ed5de57e-cce2-4242-a7ea-9eadd4bed518"
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfNotificationEventViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <NotificationEventViewModel>
    <EmailSubscribers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EmailSubscribers>
    <EntityAttributeId>1</EntityAttributeId>
    <EntityCategoryId>1</EntityCategoryId>
    <EntityDefinitionId>1</EntityDefinitionId>
    <EntityInstanceId>1</EntityInstanceId>
    <Id>1</Id>
    <NotificationEventActionTypeId>2</NotificationEventActionTypeId>
    <NotificationEventScopeId>3</NotificationEventScopeId>
    <NotificationEventSubjectId>4</NotificationEventSubjectId>
    <NotificationEventTypeId>5</NotificationEventTypeId>
    <PostconditionCriteria>
      <EntityCriteriaListCriteriaViewModel>
        <CompareValue>sample string 1</CompareValue>
        <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
        <EntityAttributeId>2</EntityAttributeId>
        <IsDateOfToday>true</IsDateOfToday>
        <ModifierId>5</ModifierId>
        <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </RecursionPath>
      </EntityCriteriaListCriteriaViewModel>
      <EntityCriteriaListCriteriaViewModel>
        <CompareValue>sample string 1</CompareValue>
        <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
        <EntityAttributeId>2</EntityAttributeId>
        <IsDateOfToday>true</IsDateOfToday>
        <ModifierId>5</ModifierId>
        <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </RecursionPath>
      </EntityCriteriaListCriteriaViewModel>
    </PostconditionCriteria>
    <PreconditionCriteria>
      <EntityCriteriaListCriteriaViewModel>
        <CompareValue>sample string 1</CompareValue>
        <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
        <EntityAttributeId>2</EntityAttributeId>
        <IsDateOfToday>true</IsDateOfToday>
        <ModifierId>5</ModifierId>
        <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </RecursionPath>
      </EntityCriteriaListCriteriaViewModel>
      <EntityCriteriaListCriteriaViewModel>
        <CompareValue>sample string 1</CompareValue>
        <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
        <EntityAttributeId>2</EntityAttributeId>
        <IsDateOfToday>true</IsDateOfToday>
        <ModifierId>5</ModifierId>
        <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </RecursionPath>
      </EntityCriteriaListCriteriaViewModel>
    </PreconditionCriteria>
    <UpcomingEventDayOffset>1</UpcomingEventDayOffset>
    <UserSubscribers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>c5407f59-2817-4557-855c-eee133d2995a</d3p1:guid>
      <d3p1:guid>ed5de57e-cce2-4242-a7ea-9eadd4bed518</d3p1:guid>
    </UserSubscribers>
  </NotificationEventViewModel>
  <NotificationEventViewModel>
    <EmailSubscribers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </EmailSubscribers>
    <EntityAttributeId>1</EntityAttributeId>
    <EntityCategoryId>1</EntityCategoryId>
    <EntityDefinitionId>1</EntityDefinitionId>
    <EntityInstanceId>1</EntityInstanceId>
    <Id>1</Id>
    <NotificationEventActionTypeId>2</NotificationEventActionTypeId>
    <NotificationEventScopeId>3</NotificationEventScopeId>
    <NotificationEventSubjectId>4</NotificationEventSubjectId>
    <NotificationEventTypeId>5</NotificationEventTypeId>
    <PostconditionCriteria>
      <EntityCriteriaListCriteriaViewModel>
        <CompareValue>sample string 1</CompareValue>
        <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
        <EntityAttributeId>2</EntityAttributeId>
        <IsDateOfToday>true</IsDateOfToday>
        <ModifierId>5</ModifierId>
        <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </RecursionPath>
      </EntityCriteriaListCriteriaViewModel>
      <EntityCriteriaListCriteriaViewModel>
        <CompareValue>sample string 1</CompareValue>
        <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
        <EntityAttributeId>2</EntityAttributeId>
        <IsDateOfToday>true</IsDateOfToday>
        <ModifierId>5</ModifierId>
        <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </RecursionPath>
      </EntityCriteriaListCriteriaViewModel>
    </PostconditionCriteria>
    <PreconditionCriteria>
      <EntityCriteriaListCriteriaViewModel>
        <CompareValue>sample string 1</CompareValue>
        <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
        <EntityAttributeId>2</EntityAttributeId>
        <IsDateOfToday>true</IsDateOfToday>
        <ModifierId>5</ModifierId>
        <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </RecursionPath>
      </EntityCriteriaListCriteriaViewModel>
      <EntityCriteriaListCriteriaViewModel>
        <CompareValue>sample string 1</CompareValue>
        <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
        <EntityAttributeId>2</EntityAttributeId>
        <IsDateOfToday>true</IsDateOfToday>
        <ModifierId>5</ModifierId>
        <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </RecursionPath>
      </EntityCriteriaListCriteriaViewModel>
    </PreconditionCriteria>
    <UpcomingEventDayOffset>1</UpcomingEventDayOffset>
    <UserSubscribers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>c5407f59-2817-4557-855c-eee133d2995a</d3p1:guid>
      <d3p1:guid>ed5de57e-cce2-4242-a7ea-9eadd4bed518</d3p1:guid>
    </UserSubscribers>
  </NotificationEventViewModel>
</ArrayOfNotificationEventViewModel>