PUT api/Events/{eventIdentity}

Request Information

URI Parameters

Name	Description	Type	Additional information
eventIdentity		string	Required

Body Parameters

ResourceEventInformation

Name	Type	Additional information
Identity	globally unique identifier	None.
Location	string	None.
Description	string	None.
HostKey	string	None.
Name	string	None.
EventType	string	None.
Owner	string	None.
IsPublished	boolean	None.
LastModified	date	None.
ParentKey	string	None.
ExtraProperties	Collection of ExtraProperty	None.
StatusName	string	None.
Source	string	None.
WeekRanges	string	None.
WeekLabels	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Identity": "280b85e8-633e-4d2f-8bc3-e3c15ecd2237",
  "Location": "sample string 2",
  "Description": "sample string 3",
  "HostKey": "sample string 4",
  "Name": "sample string 5",
  "EventType": "sample string 6",
  "Owner": "sample string 7",
  "IsPublished": true,
  "LastModified": "2024-11-21T08:45:04.8035031+00:00",
  "ParentKey": "sample string 10",
  "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 11",
  "Source": "sample string 12",
  "WeekRanges": "sample string 13",
  "WeekLabels": "sample string 14"
}

application/xml, text/xml

Sample:

<ResourceEventInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <WeekLabels>sample string 14</WeekLabels>
  <WeekRanges>sample string 13</WeekRanges>
  <Description>sample string 3</Description>
  <EventType>sample string 6</EventType>
  <ExtraProperties xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
    <d2p1:ExtraProperty>
      <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Rank>4</d2p1:Rank>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:ExtraProperty>
    <d2p1:ExtraProperty>
      <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Rank>4</d2p1:Rank>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:ExtraProperty>
  </ExtraProperties>
  <HostKey>sample string 4</HostKey>
  <Identity>280b85e8-633e-4d2f-8bc3-e3c15ecd2237</Identity>
  <IsPublished>true</IsPublished>
  <LastModified xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-21T08:45:04.8035031Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastModified>
  <Location>sample string 2</Location>
  <Name>sample string 5</Name>
  <Owner>sample string 7</Owner>
  <ParentKey>sample string 10</ParentKey>
  <Source>sample string 12</Source>
  <StatusName>sample string 11</StatusName>
</ResourceEventInformation>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResourceEvent

Name	Type	Additional information
EventIdentity	globally unique identifier	None.
StartDateTime	date	None.
EndDateTime	date	None.
UserManuallyAddedEvent	boolean	None.
StatusIdentity	globally unique identifier	None.
Status	string	None.
StatusBackgroundColor	string	None.
StatusTextColor	string	None.
Identity	globally unique identifier	None.
Location	string	None.
Description	string	None.
HostKey	string	None.
Name	string	None.
EventType	string	None.
Owner	string	None.
IsPublished	boolean	None.
LastModified	date	None.
ParentKey	string	None.
ExtraProperties	Collection of ExtraProperty	None.
StatusName	string	None.
Source	string	None.
WeekRanges	string	None.
WeekLabels	string	None.

Response Formats

application/json, text/json

Sample:

{
  "EventIdentity": "054a64bb-1c50-4b4a-a0ae-529577cd9cd6",
  "StartDateTime": "2024-11-21T08:45:04.8035031+00:00",
  "EndDateTime": "2024-11-21T08:45:04.8035031+00:00",
  "UserManuallyAddedEvent": true,
  "StatusIdentity": "55852a54-25e5-4bed-b05a-db8de2d29331",
  "Status": "sample string 6",
  "StatusBackgroundColor": "sample string 7",
  "StatusTextColor": "sample string 8",
  "Identity": "805c7a51-0a71-49bf-b4e7-8489ad1ad040",
  "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": "2024-11-21T08:45:04.8035031+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"
}

application/xml, text/xml

Sample:

<ResourceEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <WeekLabels>sample string 22</WeekLabels>
  <WeekRanges>sample string 21</WeekRanges>
  <Description>sample string 11</Description>
  <EventType>sample string 14</EventType>
  <ExtraProperties xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Common.Messages.ObjectModel">
    <d2p1:ExtraProperty>
      <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Rank>4</d2p1:Rank>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:ExtraProperty>
    <d2p1:ExtraProperty>
      <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Rank>4</d2p1:Rank>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:ExtraProperty>
  </ExtraProperties>
  <HostKey>sample string 12</HostKey>
  <Identity>805c7a51-0a71-49bf-b4e7-8489ad1ad040</Identity>
  <IsPublished>true</IsPublished>
  <LastModified xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-21T08:45:04.8035031Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1: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:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-21T08:45:04.8035031Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </EndDateTime>
  <EventIdentity>054a64bb-1c50-4b4a-a0ae-529577cd9cd6</EventIdentity>
  <StartDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-21T08:45:04.8035031Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </StartDateTime>
  <Status>sample string 6</Status>
  <StatusBackgroundColor>sample string 7</StatusBackgroundColor>
  <StatusIdentity>55852a54-25e5-4bed-b05a-db8de2d29331</StatusIdentity>
  <StatusTextColor>sample string 8</StatusTextColor>
  <UserManuallyAddedEvent>true</UserManuallyAddedEvent>
</ResourceEvent>