PUT api/consumer/v1/calendarEvents/{calendarEventId}

Update an existing Calendar Event

Request Information

URI Parameters

NameDescriptionTypeAdditional information
calendarEventId

ID of the Calendar Event

 integer

Required

Body Parameters

New Calendar Event information

CalendarEventEditDto
NameDescriptionTypeAdditional information
Entity

Entity

 integer

None
EntityFullName

Typology of entity

 string

None
CategoryId

Category of element

 integer

None
TimesheetId

Timesheet of element

 integer

None
OwnerUserId

Owner of element

 integer

None
StartDate

Start date of element

 date

None
EndDate

End date of element

 date

None
Progress

progress of element (range of values between 1-100)

 integer

None
StateId

State of element

 integer

None
Priority

Priority of element (range of values 1-3)

 integer

None
Recurrence

Recurrence of element

 string

None
Reminder

Reminder of element

 string

None
Location

Location of element

 string

None
TimeZoneId

Time zone of element

 integer

None
Typology

Typology of the element (required)

 integer

None
IsDay

Yes if Calendar Event is in day

 boolean

None
EventShareTypeId

Event Share Type (required)

 integer

None
CalendarUserId

Id of the user owner of the current calendar

 integer

None
IsArchived

Yes if Calendar Event is archived

 boolean

None
Complexity

Card complexity (optional)

 integer

None
Params

Extra params (for internal use)

 string

None
Code

The short code of the element

 string

None
Description

The description of the element

 string

None
IsActive

True if the element is active, false otherwise

 boolean

None
Id

Unique ID

 integer

None

Request Formats

application/json, text/json

Sample: 
{
  "Entity": 1,
  "EntityFullName": "sample string 1",
  "CategoryId": 1,
  "TimesheetId": 1,
  "OwnerUserId": 2,
  "StartDate": "2024-11-01T14:22:32.7912706+01:00",
  "EndDate": "2024-11-01T14:22:32.7912706+01:00",
  "Progress": 3,
  "StateId": 1,
  "Priority": 4,
  "Recurrence": "sample string 5",
  "Reminder": "sample string 6",
  "Location": "sample string 7",
  "TimeZoneId": 1,
  "Typology": 8,
  "IsDay": true,
  "EventShareTypeId": 10,
  "CalendarUserId": 1,
  "IsArchived": true,
  "Complexity": 1,
  "Params": "sample string 12",
  "Code": "sample string 13",
  "Description": "sample string 14",
  "IsActive": true,
  "Id": 16
}

application/xml, text/xml

Sample: 
<CalendarEventEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <Id>16</Id>
  <Code>sample string 13</Code>
  <Description>sample string 14</Description>
  <IsActive>true</IsActive>
  <CalendarUserId>1</CalendarUserId>
  <CategoryId>1</CategoryId>
  <Complexity>1</Complexity>
  <EndDate>2024-11-01T14:22:32.7912706+01:00</EndDate>
  <Entity>1</Entity>
  <EntityFullName>sample string 1</EntityFullName>
  <EventShareTypeId>10</EventShareTypeId>
  <IsArchived>true</IsArchived>
  <IsDay>true</IsDay>
  <Location>sample string 7</Location>
  <OwnerUserId>2</OwnerUserId>
  <Params>sample string 12</Params>
  <Priority>4</Priority>
  <Progress>3</Progress>
  <Recurrence>sample string 5</Recurrence>
  <Reminder>sample string 6</Reminder>
  <StartDate>2024-11-01T14:22:32.7912706+01:00</StartDate>
  <StateId>1</StateId>
  <TimeZoneId>1</TimeZoneId>
  <TimesheetId>1</TimesheetId>
  <Typology>8</Typology>
</CalendarEventEditDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None
Content

HttpContent

None
StatusCode

HttpStatusCode

None
ReasonPhrase

string

None
Headers

Collection of Object

None
RequestMessage

HttpRequestMessage

None
IsSuccessStatusCode

boolean

None