POST api/CategoryEvents/filter?startDate={startDate}&endDate={endDate}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
startDate | date |
Required |
|
endDate | date |
Required |
Body Parameters
CategoryEventSearchFilterName | Description | Type | Additional information |
---|---|---|---|
CategoryIdentities | Collection of globally unique identifier |
None. |
|
PermissionGroupIdentities | Collection of globally unique identifier |
None. |
|
UsePermissionGroupStatusCache | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "CategoryIdentities": [ "689efae4-c05b-4817-b626-7d5c1cb1f7bb", "16125983-ecde-4714-a8f1-eb0e7a1a6a53" ], "PermissionGroupIdentities": [ "03f1ee0d-856c-4094-b701-8b5489e208d9", "ec7c1ba9-a3c7-4932-b301-e4b14327eccf" ], "UsePermissionGroupStatusCache": true }
application/xml, text/xml
Sample:
<CategoryEventSearchFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <CategoryIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>689efae4-c05b-4817-b626-7d5c1cb1f7bb</d2p1:guid> <d2p1:guid>16125983-ecde-4714-a8f1-eb0e7a1a6a53</d2p1:guid> </CategoryIdentities> <PermissionGroupIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>03f1ee0d-856c-4094-b701-8b5489e208d9</d2p1:guid> <d2p1:guid>ec7c1ba9-a3c7-4932-b301-e4b14327eccf</d2p1:guid> </PermissionGroupIdentities> <UsePermissionGroupStatusCache>true</UsePermissionGroupStatusCache> </CategoryEventSearchFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of CategoryWithEventsName | Description | Type | Additional information |
---|---|---|---|
Identity | globally unique identifier |
None. |
|
Name | string |
None. |
|
Results | Collection of ResourceEvent |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Identity": "56af9e44-7ee4-4853-a4c3-fd9d1f19e353", "Name": "sample string 2", "Results": [ { "EventIdentity": "dd75876e-e03d-4708-a2e2-118623e50318", "StartDateTime": "2025-03-31T04:59:33.7425767+00:00", "EndDateTime": "2025-03-31T04:59:33.7425767+00:00", "UserManuallyAddedEvent": true, "StatusIdentity": "586941c9-9b08-483c-97a9-22a2d3cfa2b9", "Status": "sample string 6", "StatusBackgroundColor": "sample string 7", "StatusTextColor": "sample string 8", "Identity": "b1fffd8d-0b77-4da9-afb2-fd33c8554dc6", "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-31T04:59:33.7425767+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" }, { "EventIdentity": "dd75876e-e03d-4708-a2e2-118623e50318", "StartDateTime": "2025-03-31T04:59:33.7425767+00:00", "EndDateTime": "2025-03-31T04:59:33.7425767+00:00", "UserManuallyAddedEvent": true, "StatusIdentity": "586941c9-9b08-483c-97a9-22a2d3cfa2b9", "Status": "sample string 6", "StatusBackgroundColor": "sample string 7", "StatusTextColor": "sample string 8", "Identity": "b1fffd8d-0b77-4da9-afb2-fd33c8554dc6", "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-31T04:59:33.7425767+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" } ] }, { "Identity": "56af9e44-7ee4-4853-a4c3-fd9d1f19e353", "Name": "sample string 2", "Results": [ { "EventIdentity": "dd75876e-e03d-4708-a2e2-118623e50318", "StartDateTime": "2025-03-31T04:59:33.7425767+00:00", "EndDateTime": "2025-03-31T04:59:33.7425767+00:00", "UserManuallyAddedEvent": true, "StatusIdentity": "586941c9-9b08-483c-97a9-22a2d3cfa2b9", "Status": "sample string 6", "StatusBackgroundColor": "sample string 7", "StatusTextColor": "sample string 8", "Identity": "b1fffd8d-0b77-4da9-afb2-fd33c8554dc6", "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-31T04:59:33.7425767+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" }, { "EventIdentity": "dd75876e-e03d-4708-a2e2-118623e50318", "StartDateTime": "2025-03-31T04:59:33.7425767+00:00", "EndDateTime": "2025-03-31T04:59:33.7425767+00:00", "UserManuallyAddedEvent": true, "StatusIdentity": "586941c9-9b08-483c-97a9-22a2d3cfa2b9", "Status": "sample string 6", "StatusBackgroundColor": "sample string 7", "StatusTextColor": "sample string 8", "Identity": "b1fffd8d-0b77-4da9-afb2-fd33c8554dc6", "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-31T04:59:33.7425767+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" } ] } ]
application/xml, text/xml
Sample:
<ArrayOfCategoryWithEvents xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <CategoryWithEvents> <Identity>56af9e44-7ee4-4853-a4c3-fd9d1f19e353</Identity> <Name>sample string 2</Name> <Results> <ResourceEvent> <Description>sample string 11</Description> <EventType>sample string 14</EventType> <ExtraProperties xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel"> <d5p1:ExtraProperty> <d5p1:DisplayName>sample string 2</d5p1:DisplayName> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Rank>4</d5p1:Rank> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:ExtraProperty> <d5p1:ExtraProperty> <d5p1:DisplayName>sample string 2</d5p1:DisplayName> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Rank>4</d5p1:Rank> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:ExtraProperty> </ExtraProperties> <HostKey>sample string 12</HostKey> <Identity>b1fffd8d-0b77-4da9-afb2-fd33c8554dc6</Identity> <IsPublished>true</IsPublished> <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </LastModified> <Location>sample string 10</Location> <Name>sample string 13</Name> <Owner>sample string 15</Owner> <ParentKey>sample string 18</ParentKey> <StatusName>sample string 19</StatusName> <EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </EndDateTime> <EventIdentity>dd75876e-e03d-4708-a2e2-118623e50318</EventIdentity> <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </StartDateTime> <Status>sample string 6</Status> <StatusBackgroundColor>sample string 7</StatusBackgroundColor> <StatusIdentity>586941c9-9b08-483c-97a9-22a2d3cfa2b9</StatusIdentity> <StatusTextColor>sample string 8</StatusTextColor> <UserManuallyAddedEvent>true</UserManuallyAddedEvent> </ResourceEvent> <ResourceEvent> <Description>sample string 11</Description> <EventType>sample string 14</EventType> <ExtraProperties xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel"> <d5p1:ExtraProperty> <d5p1:DisplayName>sample string 2</d5p1:DisplayName> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Rank>4</d5p1:Rank> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:ExtraProperty> <d5p1:ExtraProperty> <d5p1:DisplayName>sample string 2</d5p1:DisplayName> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Rank>4</d5p1:Rank> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:ExtraProperty> </ExtraProperties> <HostKey>sample string 12</HostKey> <Identity>b1fffd8d-0b77-4da9-afb2-fd33c8554dc6</Identity> <IsPublished>true</IsPublished> <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </LastModified> <Location>sample string 10</Location> <Name>sample string 13</Name> <Owner>sample string 15</Owner> <ParentKey>sample string 18</ParentKey> <StatusName>sample string 19</StatusName> <EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </EndDateTime> <EventIdentity>dd75876e-e03d-4708-a2e2-118623e50318</EventIdentity> <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </StartDateTime> <Status>sample string 6</Status> <StatusBackgroundColor>sample string 7</StatusBackgroundColor> <StatusIdentity>586941c9-9b08-483c-97a9-22a2d3cfa2b9</StatusIdentity> <StatusTextColor>sample string 8</StatusTextColor> <UserManuallyAddedEvent>true</UserManuallyAddedEvent> </ResourceEvent> </Results> </CategoryWithEvents> <CategoryWithEvents> <Identity>56af9e44-7ee4-4853-a4c3-fd9d1f19e353</Identity> <Name>sample string 2</Name> <Results> <ResourceEvent> <Description>sample string 11</Description> <EventType>sample string 14</EventType> <ExtraProperties xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel"> <d5p1:ExtraProperty> <d5p1:DisplayName>sample string 2</d5p1:DisplayName> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Rank>4</d5p1:Rank> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:ExtraProperty> <d5p1:ExtraProperty> <d5p1:DisplayName>sample string 2</d5p1:DisplayName> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Rank>4</d5p1:Rank> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:ExtraProperty> </ExtraProperties> <HostKey>sample string 12</HostKey> <Identity>b1fffd8d-0b77-4da9-afb2-fd33c8554dc6</Identity> <IsPublished>true</IsPublished> <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </LastModified> <Location>sample string 10</Location> <Name>sample string 13</Name> <Owner>sample string 15</Owner> <ParentKey>sample string 18</ParentKey> <StatusName>sample string 19</StatusName> <EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </EndDateTime> <EventIdentity>dd75876e-e03d-4708-a2e2-118623e50318</EventIdentity> <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </StartDateTime> <Status>sample string 6</Status> <StatusBackgroundColor>sample string 7</StatusBackgroundColor> <StatusIdentity>586941c9-9b08-483c-97a9-22a2d3cfa2b9</StatusIdentity> <StatusTextColor>sample string 8</StatusTextColor> <UserManuallyAddedEvent>true</UserManuallyAddedEvent> </ResourceEvent> <ResourceEvent> <Description>sample string 11</Description> <EventType>sample string 14</EventType> <ExtraProperties xmlns:d5p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel"> <d5p1:ExtraProperty> <d5p1:DisplayName>sample string 2</d5p1:DisplayName> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Rank>4</d5p1:Rank> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:ExtraProperty> <d5p1:ExtraProperty> <d5p1:DisplayName>sample string 2</d5p1:DisplayName> <d5p1:Name>sample string 1</d5p1:Name> <d5p1:Rank>4</d5p1:Rank> <d5p1:Value>sample string 3</d5p1:Value> </d5p1:ExtraProperty> </ExtraProperties> <HostKey>sample string 12</HostKey> <Identity>b1fffd8d-0b77-4da9-afb2-fd33c8554dc6</Identity> <IsPublished>true</IsPublished> <LastModified xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </LastModified> <Location>sample string 10</Location> <Name>sample string 13</Name> <Owner>sample string 15</Owner> <ParentKey>sample string 18</ParentKey> <StatusName>sample string 19</StatusName> <EndDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </EndDateTime> <EventIdentity>dd75876e-e03d-4708-a2e2-118623e50318</EventIdentity> <StartDateTime xmlns:d5p1="http://schemas.datacontract.org/2004/07/System"> <d5p1:DateTime>2025-03-31T04:59:33.7425767Z</d5p1:DateTime> <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes> </StartDateTime> <Status>sample string 6</Status> <StatusBackgroundColor>sample string 7</StatusBackgroundColor> <StatusIdentity>586941c9-9b08-483c-97a9-22a2d3cfa2b9</StatusIdentity> <StatusTextColor>sample string 8</StatusTextColor> <UserManuallyAddedEvent>true</UserManuallyAddedEvent> </ResourceEvent> </Results> </CategoryWithEvents> </ArrayOfCategoryWithEvents>