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
EventFilter| Name | 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-03-25T06:19:03.052738+00:00",
"EndDateTime": "2025-03-25T06:19:03.052738+00:00",
"EventCategories": [
{
"Identity": "4f61dfdd-abbb-4877-af53-96cee745941f",
"Values": [
"122b7f36-5c6e-4b30-a326-e51377a22b1c",
"b2d2a10c-1bc2-45b5-82e6-7d152f2c7c55"
]
},
{
"Identity": "4f61dfdd-abbb-4877-af53-96cee745941f",
"Values": [
"122b7f36-5c6e-4b30-a326-e51377a22b1c",
"b2d2a10c-1bc2-45b5-82e6-7d152f2c7c55"
]
}
],
"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-03-25T06:19:03.052738Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EndDateTime>
<EventCategories>
<CategoryValue>
<Identity>4f61dfdd-abbb-4877-af53-96cee745941f</Identity>
<Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>122b7f36-5c6e-4b30-a326-e51377a22b1c</d4p1:guid>
<d4p1:guid>b2d2a10c-1bc2-45b5-82e6-7d152f2c7c55</d4p1:guid>
</Values>
</CategoryValue>
<CategoryValue>
<Identity>4f61dfdd-abbb-4877-af53-96cee745941f</Identity>
<Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>122b7f36-5c6e-4b30-a326-e51377a22b1c</d4p1:guid>
<d4p1:guid>b2d2a10c-1bc2-45b5-82e6-7d152f2c7c55</d4p1:guid>
</Values>
</CategoryValue>
</EventCategories>
<IsPublished>true</IsPublished>
<StartDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-03-25T06:19:03.052738Z</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
PaginatedResultsOfResourceEvent| Name | 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": "e77833b2-5158-4b1a-a497-fd3f860f495f",
"StartDateTime": "2025-03-25T06:19:03.052738+00:00",
"EndDateTime": "2025-03-25T06:19:03.052738+00:00",
"UserManuallyAddedEvent": true,
"StatusIdentity": "436e5754-c3f5-4986-8008-de2fc99f5796",
"Status": "sample string 6",
"StatusBackgroundColor": "sample string 7",
"StatusTextColor": "sample string 8",
"Identity": "061349e7-452b-4260-a6f4-c18ff38e26d4",
"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-03-25T06:19:03.052738+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": "e77833b2-5158-4b1a-a497-fd3f860f495f",
"StartDateTime": "2025-03-25T06:19:03.052738+00:00",
"EndDateTime": "2025-03-25T06:19:03.052738+00:00",
"UserManuallyAddedEvent": true,
"StatusIdentity": "436e5754-c3f5-4986-8008-de2fc99f5796",
"Status": "sample string 6",
"StatusBackgroundColor": "sample string 7",
"StatusTextColor": "sample string 8",
"Identity": "061349e7-452b-4260-a6f4-c18ff38e26d4",
"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-03-25T06:19:03.052738+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>061349e7-452b-4260-a6f4-c18ff38e26d4</Identity>
<IsPublished>true</IsPublished>
<LastModified xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2025-03-25T06:19:03.052738Z</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-03-25T06:19:03.052738Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</EndDateTime>
<EventIdentity>e77833b2-5158-4b1a-a497-fd3f860f495f</EventIdentity>
<StartDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2025-03-25T06:19:03.052738Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</StartDateTime>
<Status>sample string 6</Status>
<StatusBackgroundColor>sample string 7</StatusBackgroundColor>
<StatusIdentity>436e5754-c3f5-4986-8008-de2fc99f5796</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>061349e7-452b-4260-a6f4-c18ff38e26d4</Identity>
<IsPublished>true</IsPublished>
<LastModified xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2025-03-25T06:19:03.052738Z</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-03-25T06:19:03.052738Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</EndDateTime>
<EventIdentity>e77833b2-5158-4b1a-a497-fd3f860f495f</EventIdentity>
<StartDateTime xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2025-03-25T06:19:03.052738Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</StartDateTime>
<Status>sample string 6</Status>
<StatusBackgroundColor>sample string 7</StatusBackgroundColor>
<StatusIdentity>436e5754-c3f5-4986-8008-de2fc99f5796</StatusIdentity>
<StatusTextColor>sample string 8</StatusTextColor>
<UserManuallyAddedEvent>true</UserManuallyAddedEvent>
</ResourceEvent>
</Results>
<TotalPages>1</TotalPages>
</PaginatedResultsOfResourceEventqMSKJDOU>