POST api/Events/Filter?pageNumber={pageNumber}&itemsPerPage={itemsPerPage}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
pageNumber | integer |
Default value is 1 |
|
itemsPerPage | integer |
Default value is 10 |
Body Parameters
EventFilterName | Description | Type | Additional information |
---|---|---|---|
IsPublished | boolean |
None. |
|
StartDateTime | date |
None. |
|
EndDateTime | date |
None. |
|
EventCategories | Collection of CategoryValue |
None. |
|
Term | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "IsPublished": true, "StartDateTime": "2025-07-06T22:53:04.5562832+00:00", "EndDateTime": "2025-07-06T22:53:04.5562832+00:00", "EventCategories": [ { "Identity": "5a8d752d-84f5-443c-ab2b-1d73faacd2d2", "Values": [ "d3d6f700-a99d-4f3d-8e98-e44bfd498c2a", "15bd1cad-331e-46ec-a231-72ca28bf0e53" ] }, { "Identity": "5a8d752d-84f5-443c-ab2b-1d73faacd2d2", "Values": [ "d3d6f700-a99d-4f3d-8e98-e44bfd498c2a", "15bd1cad-331e-46ec-a231-72ca28bf0e53" ] } ], "Term": "sample string 1" }
application/xml, text/xml
Sample:
<EventFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <EndDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-07-06T22:53:04.5562832Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </EndDateTime> <EventCategories> <CategoryValue> <Identity>5a8d752d-84f5-443c-ab2b-1d73faacd2d2</Identity> <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:guid>d3d6f700-a99d-4f3d-8e98-e44bfd498c2a</d4p1:guid> <d4p1:guid>15bd1cad-331e-46ec-a231-72ca28bf0e53</d4p1:guid> </Values> </CategoryValue> <CategoryValue> <Identity>5a8d752d-84f5-443c-ab2b-1d73faacd2d2</Identity> <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:guid>d3d6f700-a99d-4f3d-8e98-e44bfd498c2a</d4p1:guid> <d4p1:guid>15bd1cad-331e-46ec-a231-72ca28bf0e53</d4p1:guid> </Values> </CategoryValue> </EventCategories> <IsPublished>true</IsPublished> <StartDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-07-06T22:53:04.5562832Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </StartDateTime> <Term>sample string 1</Term> </EventFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PaginatedResultsOfResourceEventName | Description | Type | Additional information |
---|---|---|---|
TotalPages | integer |
None. |
|
CurrentPage | integer |
None. |
|
Results | Collection of ResourceEvent |
None. |
|
Count | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalPages": 1, "CurrentPage": 2, "Results": [ { "EventIdentity": "fcd9dfce-4fbb-49fb-b401-70770a792b75", "StartDateTime": "2025-07-06T22:53:04.5562832+00:00", "EndDateTime": "2025-07-06T22:53:04.5562832+00:00", "UserManuallyAddedEvent": true, "StatusIdentity": "9837b857-ee19-45b4-b23e-136f7ffeac28", "Status": "sample string 6", "StatusBackgroundColor": "sample string 7", "StatusTextColor": "sample string 8", "Identity": "68a46193-5580-4dcc-a8c2-0dd4dcb43106", "Location": "sample string 10", "Description": "sample string 11", "HostKey": "sample string 12", "Name": "sample string 13", "EventType": "sample string 14", "Owner": "sample string 15", "IsPublished": true, "LastModified": "2025-07-06T22:53:04.5562832+00:00", "ParentKey": "sample string 18", "ExtraProperties": [ { "Name": "sample string 1", "DisplayName": "sample string 2", "Value": "sample string 3", "Rank": 4 }, { "Name": "sample string 1", "DisplayName": "sample string 2", "Value": "sample string 3", "Rank": 4 } ], "StatusName": "sample string 19", "Source": "sample string 20", "WeekRanges": "sample string 21", "WeekLabels": "sample string 22" }, { "EventIdentity": "fcd9dfce-4fbb-49fb-b401-70770a792b75", "StartDateTime": "2025-07-06T22:53:04.5562832+00:00", "EndDateTime": "2025-07-06T22:53:04.5562832+00:00", "UserManuallyAddedEvent": true, "StatusIdentity": "9837b857-ee19-45b4-b23e-136f7ffeac28", "Status": "sample string 6", "StatusBackgroundColor": "sample string 7", "StatusTextColor": "sample string 8", "Identity": "68a46193-5580-4dcc-a8c2-0dd4dcb43106", "Location": "sample string 10", "Description": "sample string 11", "HostKey": "sample string 12", "Name": "sample string 13", "EventType": "sample string 14", "Owner": "sample string 15", "IsPublished": true, "LastModified": "2025-07-06T22:53:04.5562832+00:00", "ParentKey": "sample string 18", "ExtraProperties": [ { "Name": "sample string 1", "DisplayName": "sample string 2", "Value": "sample string 3", "Rank": 4 }, { "Name": "sample string 1", "DisplayName": "sample string 2", "Value": "sample string 3", "Rank": 4 } ], "StatusName": "sample string 19", "Source": "sample string 20", "WeekRanges": "sample string 21", "WeekLabels": "sample string 22" } ], "Count": 3 }
application/xml, text/xml
Sample:
<PaginatedResultsOfResourceEventqMSKJDOU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <Count>3</Count> <CurrentPage>2</CurrentPage> <Results> <ResourceEvent> <WeekLabels>sample string 22</WeekLabels> <WeekRanges>sample string 21</WeekRanges> <Description>sample string 11</Description> <EventType>sample string 14</EventType> <ExtraProperties xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel"> <d4p1:ExtraProperty> <d4p1:DisplayName>sample string 2</d4p1:DisplayName> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Rank>4</d4p1:Rank> <d4p1:Value>sample string 3</d4p1:Value> </d4p1:ExtraProperty> <d4p1:ExtraProperty> <d4p1:DisplayName>sample string 2</d4p1:DisplayName> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Rank>4</d4p1:Rank> <d4p1:Value>sample string 3</d4p1:Value> </d4p1:ExtraProperty> </ExtraProperties> <HostKey>sample string 12</HostKey> <Identity>68a46193-5580-4dcc-a8c2-0dd4dcb43106</Identity> <IsPublished>true</IsPublished> <LastModified xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-07-06T22:53:04.5562832Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </LastModified> <Location>sample string 10</Location> <Name>sample string 13</Name> <Owner>sample string 15</Owner> <ParentKey>sample string 18</ParentKey> <Source>sample string 20</Source> <StatusName>sample string 19</StatusName> <EndDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-07-06T22:53:04.5562832Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </EndDateTime> <EventIdentity>fcd9dfce-4fbb-49fb-b401-70770a792b75</EventIdentity> <StartDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-07-06T22:53:04.5562832Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </StartDateTime> <Status>sample string 6</Status> <StatusBackgroundColor>sample string 7</StatusBackgroundColor> <StatusIdentity>9837b857-ee19-45b4-b23e-136f7ffeac28</StatusIdentity> <StatusTextColor>sample string 8</StatusTextColor> <UserManuallyAddedEvent>true</UserManuallyAddedEvent> </ResourceEvent> <ResourceEvent> <WeekLabels>sample string 22</WeekLabels> <WeekRanges>sample string 21</WeekRanges> <Description>sample string 11</Description> <EventType>sample string 14</EventType> <ExtraProperties xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel"> <d4p1:ExtraProperty> <d4p1:DisplayName>sample string 2</d4p1:DisplayName> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Rank>4</d4p1:Rank> <d4p1:Value>sample string 3</d4p1:Value> </d4p1:ExtraProperty> <d4p1:ExtraProperty> <d4p1:DisplayName>sample string 2</d4p1:DisplayName> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:Rank>4</d4p1:Rank> <d4p1:Value>sample string 3</d4p1:Value> </d4p1:ExtraProperty> </ExtraProperties> <HostKey>sample string 12</HostKey> <Identity>68a46193-5580-4dcc-a8c2-0dd4dcb43106</Identity> <IsPublished>true</IsPublished> <LastModified xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-07-06T22:53:04.5562832Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </LastModified> <Location>sample string 10</Location> <Name>sample string 13</Name> <Owner>sample string 15</Owner> <ParentKey>sample string 18</ParentKey> <Source>sample string 20</Source> <StatusName>sample string 19</StatusName> <EndDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-07-06T22:53:04.5562832Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </EndDateTime> <EventIdentity>fcd9dfce-4fbb-49fb-b401-70770a792b75</EventIdentity> <StartDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-07-06T22:53:04.5562832Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </StartDateTime> <Status>sample string 6</Status> <StatusBackgroundColor>sample string 7</StatusBackgroundColor> <StatusIdentity>9837b857-ee19-45b4-b23e-136f7ffeac28</StatusIdentity> <StatusTextColor>sample string 8</StatusTextColor> <UserManuallyAddedEvent>true</UserManuallyAddedEvent> </ResourceEvent> </Results> <TotalPages>1</TotalPages> </PaginatedResultsOfResourceEventqMSKJDOU>