...
Property | UI Field Name | Description | Specifications | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
businessDays | Business Days | Comma-separated list of days. | Valid values:
Optional: useDefaultIfBlank attribute. Boolean; Valid values: true/false. The Read a Calendar web service will return useDefaultIfBlank only if | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | comments - CC | comments - CC | Description | User-defined; description for the calendar. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | excludeRelated - CC | excludeRelated - CC | n/a | Specification for whether or not to exclude related records (Custom Days, Local Custom Days) from an update, even if they are provided in the request. | Valid values: true/false (default is false). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | exportReleaseLevel - CC | exportReleaseLevel - CC | n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | exportTable - CC | exportTable - CC | n/a | Record table information. | read only | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | firstDayOfWeek - CC | firstDayOfWeek - CC | First Day Of Week | Day that is considered the start of the week. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | name - CC | name - CC | Name | Name used within the Controller to identify this calendar. | Maximum 40 alphanumerics. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | opswiseGroups - CC | opswiseGroups - CC | Member of Business Services | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | retainSysIds - CC | retainSysIds - CC | n/a |
Note | ||
---|---|---|
| ||
In XML web services, |
Valid values: true/false (default is true).
N
sysId
n/a
System ID field in the database for this Calendar record.
Persisted only if retainSysIds is set to true.
N
firstQuarterStart
1st Quarter Start
To specify the start of the 1st Quarter, a day and month must be specified as shown below.
XML
<firstQuarterStart>
<day>15</day>
<month>01</month>
</firstQuarterStart>
JSON
"firstQuarterStart": {
"day": "15",
"month": "Jan"
}
Valid values:
month:
integer value between 1-12
string value 3 letter month
Jan
Feb
Mar
Apr
May
Jun
Jul
Aug
Sep
Oct
Nov
Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.
If any other Quarter is specified then this property is also required.
secondQuarterStart
2nd Quarter Start
To specify the start of the 1st Quarter, a day and month must be specified as shown below.
XML
- If
businessDays
is blank or is not specified in the Request,businessDays
defaults to Monday,Tuesday,Wednesday,Thursday,Friday. To disable this behavior, set useDefaultIfBlank to false. That is, to setbusinessDays
to blank when a calendar contains "Business Day" Custom Day(s), specify:<businessDays useDefaultIfBlank="false"></businessDays>
. - If
businessDays
is blank and the useDefaultIfBlank attribute is not included in the Request (<businessDays />
),businessDays
defaults to Monday,Tuesday,Wednesday,Thursday,Friday. - If
businessDays
is not blank, useDefaultIfBlank is ignored. - If useDefaultIfBlank is set to true (
<businessDays useDefaultIfBlank="true"></businessDays>
),businessDays
defaults to Monday,Tuesday,Wednesday,Thursday,Friday. - If useDefaultIfBlank is set to false (
<businessDays useDefaultIfBlank="false"></businessDays>
), business days are not set.
The Read a Calendar web service will return useDefaultIfBlank only if businessDays
is empty; useDefaultIfBlank will be set to false.
N
Anchor | ||||
---|---|---|---|---|
|
comments
Description
User-defined; description for the calendar.
N
Anchor | ||||
---|---|---|---|---|
|
excludeRelated
n/a
Specification for whether or not to exclude related records (Custom Days, Local Custom Days) from an update, even if they are provided in the request.
Valid values: true/false (default is false).
N
Anchor | ||||
---|---|---|---|---|
|
exportReleaseLevel
Universal Controller release that the record was exported from.
Anchor | ||||
---|---|---|---|---|
|
exportTable
Anchor | ||||
---|---|---|---|---|
|
firstDayOfWeek
First Day Of Week
Day that is considered the start of the week.
Valid values:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
N
Anchor | ||||
---|---|---|---|---|
|
name
Name
Name used within the Controller to identify this calendar.
Maximum 40 alphanumerics.
Y
Anchor | ||||
---|---|---|---|---|
|
opswiseGroups
Member of Business Services
List of Business Services:
XML
Panel |
---|
<opswiseGroups>
<opswiseGroup>test</opswiseGroup>
</opswiseGroups> |
JSON
Panel |
---|
"opswiseGroups": [
"test"
] |
N
Anchor | ||||
---|---|---|---|---|
|
retainSysIds
n/a
- If retainSysIds="true" and
sysId
is included in the request/response,sysId
will be persisted to the database.
- If retainSysIds="false" and
sysId
is included in the request/response,sysId
will be ignored; it will be autogenerated by the Controller.
Note | ||
---|---|---|
| ||
In XML web services, |
Valid values: true/false (default is true).
N
Anchor | ||||
---|---|---|---|---|
|
sysId
n/a
System ID field in the database for this Calendar record.
Persisted only if retainSysIds is set to true.
N
firstQuarterStart
1st Quarter Start
To specify the start of the 1st Quarter, a day and month must be specified as shown below.
XML
<firstQuarterStart>
<day>15</day>
<month>Apr<<month>01</month>
</secondQuarterStart>
firstQuarterStart>
JSON
"secondQuarterStartfirstQuarterStart": {
"day": "1415",
"month": "AprJan"
}
Valid values:
month:
integer value between 1-12
string value 3 letter month
Jan
Feb
Mar
Apr
May
Jun
Jul
Aug
Sep
Oct
Nov
Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.
If any other Quarter is specified then this property is also required.
thirdQuarterStartsecondQuarterStart
3rd 2nd Quarter Start
To specify the start of the 1st Quarter, a day and month must be specified as shown below.
XML
<thirdQuarterStart><secondQuarterStart>
<day>16<<day>14</day>
<month>Jul<<month>Apr</month>
</thirdQuarterStart>secondQuarterStart>
JSON
"thirdQuarterStartsecondQuarterStart": {
"day": "1614",
"month": "JulApr"
}
Valid values:
month:
integer value between 1-12
string value 3 letter month
Jan
Feb
Mar
Apr
May
Jun
Jul
Aug
Sep
Oct
Nov
Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.
If any other Quarter is specified then this property is also required.
fourthQuarterStartthirdQuarterStart
4th 3rd Quarter Start
To specify the start of the 1st Quarter, a day and month must be specified as shown below.
XML
<fourthQuarterStart><thirdQuarterStart>
<day>13<<day>16</day>
<month>10<<month>Jul</month>
</fourthQuarterStart>thirdQuarterStart>
JSON
"fourthQuarterStartthirdQuarterStart": {
"day": "1316",
"month": "OctJul"
}
Valid values:
month:
integer value between 1-12
string value 3 letter month
Jan
Feb
Mar
Apr
May
Jun
Jul
Aug
Sep
Oct
Nov
Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.
If any other Quarter is specified then this property is also required.
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Name
...
Name used within the Controller to identify this Custom Day.
...
Maximum 40 alphanumerics.
...
Y
...
n/a
...
sysId of the Calendar-to-Custom Day relationship.
...
N
fourthQuarterStart | 4th Quarter Start | To specify the start of the 1st Quarter, a day and month must be specified as shown below.
JSON
| Valid values:
| If any other Quarter is specified then this property is also required. |
Anchor | ||||
---|---|---|---|---|
|
...
|
...
Custom Day Properties
Property | UI Field Name | Description | Specifications | RequiredMutually Exclusive With | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
adjustment name | Adjustment | If | N | ||||||||||||||||||||||
Anchor | adjustmentAmount - LCD | adjustmentAmount - LCD | Adjustment Amount | If | Default is 1. | N | |||||||||||||||||||
Anchor | adjustmentType - LCD | adjustmentType - LCD | Adjustment Type | If | Valid values: Default is Day (1Name | Name used within the Controller to identify this Custom Day. | Maximum 40 alphanumerics. | Y | |||||||||||||||||
sysId | n/a | sysId of the Calendar-to-Custom Day relationship. | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
adjustment | Adjustment | If | Valid values:
Default is None (0). | N | |||||||
|
|
|
category
Valid values:
Default is Day (1)
|
Category
Category of this Local Custom Day.
Adjustment Amount | If | Default is 1. | N | |
|
|
|
comments
Type
|
Description
Description of this Local Custom Day.
N
ctype
Type
Adjustment Type | If | Valid values:
Default is Day (1). | N | ||||||
category | Category | Category of this Local Custom Day. | Valid values:
Default is |
Day ( |
1). | N | |
|
|
|
date
Specific date for
|
Date
Description | Description of this Local Custom Day |
Format: yyyy-mm-dd.
Y
(if ctype
=
Single Date. )
datelist
. | N | |||
|
|
dateList
Multiple specific dates for
|
Dates
Type | Type of this Local Custom Day. |
XML
JSON
Y
(if ctype
is List of Dates.)
date
day
Day
Day of the month.
Valid values:
Default is Single Date (0). | N | |||||||||
date | Date | Specific date for this Local Custom Day | Format: yyyy-mm-dd. | Y |
Single Date. ) |
|
|
|
|
dayofweek
month
Month
Month of the year.
Valid values:
Default is Jan (0).
|
Day Of Week
Day of the week.
Valid values:
Default is Mon (2).
Y
(if ctype
is Relative Repeating Date)
Dates | Multiple specific dates for this Local Custom Day. | XML
| Y |
Relative Repeating Date
or
Absolute Repeating Date)
List of Dates.) |
| |||
|
|
name
|
Day |
Day of the month. | Integer; Valid values: 1-31. | Y | |
|
|
Valid day of week values:
- Sun, Mon, Tue, Wed, Thu, Fri, Sat
N
relfreq
When
Occurrence of this day in the month.
Valid values:
Default is 1st (1).
Y(
|
observedRules
Observed Rules
If category
is Holiday (3) and ctype
is Relative Repeating Date (1) or Absolute Repeating Date (2); Rules for when the holiday will be observed.
XML
JSON
| Day Of Week | Day of the week. | Valid values:
Default is Mon (2). | Y | |
|
|
|
sysId
|
n/a
System ID in the database for this Local Custom Day.
Persisted only if retainSysIds is set to true.
Y
(if retainSysIds
is true.)
...
Description
...
URI
...
HTTP Method
...
DELETE
...
Description
...
Deletes the specified Calendar.
...
URI Parameters
...
See Delete a Calendar: URI Parameters, below.
...
Example URI
...
- http://localhost:8080/uc/resources/calendar?calendarname=testCalendar
- http://localhost:8080/uc/resources/calendar?calendarid=f87848b00a0001037f43e7c81c8ec969
...
Authentication
...
HTTP Basic
...
Example Response
...
- Status 200 /OK
Calendar deleted successfully. - Status 404 /Not Found
A calendar with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
...
Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
calendarid
...
Unique ID for this Calendar.
...
Y
(unless calendarname
is specified)
...
calendarname
...
calendarname
...
Name used within the Controller to identify this Calendar.
...
Maximum 40 alphanumerics.
...
Y
(unless calendarid
is specified)
...
calendarid
...
Description
...
URI
...
HTTP Method
...
GET
...
Description
...
Retrieves information on all Calendar.
...
Example URI
...
Authentication
...
HTTP Basic
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/xml, application/json
...
Example Response
...
See List Calendars: Example Response, below.
...
Calendar Properties
...
See Create a Calendar: Calendar Properties.
...
Custom Day Properties
...
See Create a Calendar: Custom Day Properties.
...
Local Custom Day Properties
...
See Create a Calendar: Local Custom Day Properties.
...
XML Response
JSON Response
title | XML Response |
---|
Month | Month of the year. | Valid values:
Default is Jan (0). | Y | |||||||||
name | Name | Name of this Local Custom Day. | Y | |||||||||
observedRules | Observed Rules | If
|
|
|
|
<firstQuarterStart><localCustomDays> <localCustomDay> <adjustment>None</adjustment> <adjustmentAmount>1</adjustmentAmount> <adjustmentType>Day</adjustmentType> <category>Holiday</category> <comments/> <ctype>Single Date</ctype> <date>2017-08-23</date> <dateList /> <day>1</day> <dayofweek>Sun</dayofweek> <month>Jan</month> <name>local custom day</name> <relfreq>1st</relfreq> <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId> </localCustomDay> </localCustomDays> <firstDayOfWeek>Sunday</firstDayOfWeek> <name>System Default</name> <opswiseGroups /> <sysId>77171434c0a801c9016d5b2b5d17ddee</sysId> </calendar> <calendar exportReleaseLevel="7.2.0.0" exportTable="ops_calendar" version="2">
<day>15</day>
<month>Jan</month>
</firstQuarterStart>
<firstQuarterStart>
<day>15</day>
<month>Jan</month>
</firstQuarterStart>
| Valid day of week values:
| N | |||||||||
relfreq | When | Occurrence of this day in the month. | Valid values:
Default is 1st (1). | Y | |||||||
sysId | n/a | System ID in the database for this Local Custom Day. | Persisted only if retainSysIds is set to true. | Y |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/calendar |
HTTP Method | DELETE |
Description | Deletes the specified Calendar. |
URI Parameters | See Delete a Calendar: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Calendar. | Y |
| |
| Name used within the Controller to identify this Calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/calendar/list |
HTTP Method | GET |
Description | Retrieves information on all Calendar. |
Example URI | http://localhost:8080/uc/resources/calendar/list |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List Calendars: Example Response, below. |
Calendar Properties | |
Custom Day Properties | |
Local Custom Day Properties |
Anchor | ||||
---|---|---|---|---|
|
XML Response | JSON Response | ||||
---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
title | JSON Response |
---|
[ { "businessDays": { "value": "Monday,Tuesday,Wednesday,Thursday,Friday" }, "comments": "Default System Calendar", "customDays": [ { "name": "uc - Memorial Day", "sysId": "daf16d70c0a801650040c4d58a3feebd" }, { "name": "uc - Thanksgiving Day USA", "sysId": "b355ca6ea2c94aaa9a8895d496396e57" } ],
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_calendar",
"firstDayOfWeek": "Sunday", "localCustomDays": [ { "adjustment": "None", "adjustmentAmount": 1, "adjustmentType": "Day", "category": "Holiday", "comments": null, "ctype": "Single Date", "date": "2017-08-23", "dateList": " "day": 1, "dayofweek": "Sun", "month": "Jan", "name": "local custom day", "relfreq": "1st", "sysId": "616ec15e7a5e40dbaae421e3688a25e5" } ], "name": "System Default", "opswiseGroups: [], "sysId": "77171434c0a801c9016d5b2b5d17ddee", "version": 6 }, { "businessDays": { "value": "Monday,Tuesday,Wednesday,Thursday,Friday" }, "comments": "American Calendar", "customDays": [],
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_calendar",
"firstDayOfWeek": "Sunday", "localCustomDays": [ { "adjustment": "None", "adjustmentAmount": 1, "adjustmentType": "Day", "category": "Holiday", "comments": null, "ctype": "Single Date", "date": "2017-08-23", "dateList": null, "day": 1, "dayofweek": "Sun", "month": "Jan", "name": "local custom day", "relfreq": "1st", "sysId": "616ec15e7a5e40dbaae421e3688a25e5" } ], "name": "uc - American Calendar", "opswiseGroups": [], "sysId": "da24b953c0a8016501fbcb18464d8328", "version": 2 } ]
...
Description
...
URI
...
...
HTTP Method
...
GET
...
Description
...
Retrieves information on Qualifying Dates for a specific Local Custom Day.
...
URI Parameters
...
See List Local Custom Day Qualifying Dates URI Parameters: URI Parameters, below.
...
Example URI
...
Authentication
...
HTTP Basic
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/xml, application/json
...
Example Response
...
See List Local Custom Day Qualifying Dates: Example Response, below.
...
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on Qualifying Dates for a specific Local Custom Day. |
URI Parameters | See List Local Custom Day Qualifying Dates URI Parameters: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/calendar/localcustomdays/qualifyingdates?customdayname=testLocalCustomDay&calendarname=testCalendar |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List Local Custom Day Qualifying Dates: Example Response, below. |
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Name used within the Controller to identify this Local Custom Day. | Maximum 40 alphanumerics. | Y | |
| Unique ID for this calendar. | Y |
| |
| Name used within the Controller to identify this calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on Qualifying Periods for a specific Local Custom Day. |
URI Parameters | See List Local Custom Day Qualifying Periods URI Parameters: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/calendar/localcustomdays/qualifyingperiods?customdayname=testLocalCustomDay&calendarname=testCalendar |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List Local Custom Day Qualifying Periods: Example Response, below. |
Anchor | ||||
---|---|---|---|---|
|
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Name used within the Controller to identify this Local Custom Day. | Maximum 40 alphanumerics. | Y | |
| Unique ID for this calendar. | Y |
| |
| Name used within the Controller to identify this calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor |
---|
...
XML Response
...
JSON Response
...
title | XML Response |
---|
<qualifyingDates>
<qualifyingDate>Mon, Jan 1, 2018</qualifyingDate>
<qualifyingDate>Tue, Jan 1, 2019</qualifyingDate>
<qualifyingDate>Wed, Jan 1, 2020</qualifyingDate>
<qualifyingDate>Fri, Jan 1, 2021</qualifyingDate>
<qualifyingDate>Sat, Jan 1, 2022</qualifyingDate>
<qualifyingDate>Sun, Jan 1, 2023</qualifyingDate>
<qualifyingDate>Mon, Jan 1, 2024</qualifyingDate>
<qualifyingDate>Wed, Jan 1, 2025</qualifyingDate>
<qualifyingDate>Thu, Jan 1, 2026</qualifyingDate>
<qualifyingDate>Fri, Jan 1, 2027</qualifyingDate>
<qualifyingDate>Sat, Jan 1, 2028</qualifyingDate>
<qualifyingDate>Mon, Jan 1, 2029</qualifyingDate>
<qualifyingDate>Tue, Jan 1, 2030</qualifyingDate>
<qualifyingDate>Wed, Jan 1, 2031</qualifyingDate>
<qualifyingDate>Thu, Jan 1, 2032</qualifyingDate>
<qualifyingDate>Sat, Jan 1, 2033</qualifyingDate>
<qualifyingDate>Sun, Jan 1, 2034</qualifyingDate>
<qualifyingDate>Mon, Jan 1, 2035</qualifyingDate>
<qualifyingDate>Tue, Jan 1, 2036</qualifyingDate>
<qualifyingDate>Thu, Jan 1, 2037</qualifyingDate>
<qualifyingDate>Fri, Jan 1, 2038</qualifyingDate>
<qualifyingDate>Sat, Jan 1, 2039</qualifyingDate>
<qualifyingDate>Sun, Jan 1, 2040</qualifyingDate>
<qualifyingDate>Tue, Jan 1, 2041</qualifyingDate>
<qualifyingDate>Wed, Jan 1, 2042</qualifyingDate>
<qualifyingDate>Thu, Jan 1, 2043</qualifyingDate>
<qualifyingDate>Fri, Jan 1, 2044</qualifyingDate>
<qualifyingDate>Sun, Jan 1, 2045</qualifyingDate>
<qualifyingDate>Mon, Jan 1, 2046</qualifyingDate>
<qualifyingDate>Tue, Jan 1, 2047</qualifyingDate>
</qualifyingDates>
...
title | JSON Response |
---|
[
"Mon, Jan 1, 2018",
"Tue, Jan 2, 2019",
"Wed, Jan 1, 2020",
"Fri, Jan 1, 2021"
]
...
Description
...
URI
...
...
HTTP Method
...
GET
...
Description
...
Retrieves information on Qualifying Periods for a specific Local Custom Day.
...
URI Parameters
...
See List Local Custom Day Qualifying Periods URI Parameters: URI Parameters, below.
...
Example URI
...
Authentication
...
HTTP Basic
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/xml, application/json
...
Example Response
...
See List Local Custom Day Qualifying Periods: Example Response, below.
...
XML Response
...
JSON Response
...
title | XML Response |
---|
...
|
Description | |
---|---|
URI | |
HTTP Method | PUT |
Description | Modifies the Calendar specified by the |
Example URI | http://localhost:8080/uc/resources/calendar |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Modify a Calendar: Example Request, below. |
Calendar Properties | |
Custom Day Properties | |
Local Custom Day Properties | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
The excludeRelated property is included in the XML as an attribute.
XML Request | JSON Request | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
...
Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
customdayname
...
Name used within the Controller to identify this Local Custom Day.
...
Maximum 40 alphanumerics.
...
Y
...
calendarid
...
Unique ID for this calendar.
...
Y
(unless calendarname
is specified)
...
calendarname
...
calendarname
...
Name used within the Controller to identify this calendar.
...
Maximum 40 alphanumerics.
...
Y
(unless calendarid
is specified)
...
calendarid
...
Description
...
URI
...
...
HTTP Method
...
PUT
...
Description
...
Modifies the Calendar specified by the sysId
.
To modify Calendar properties without modifying related records, see the excludeRelated property.
...
Example URI
...
Consumes Content-Type
...
application/xml, application/json
...
Produces Content-Type
...
n/a
...
Example Request
...
See Modify a Calendar: Example Request, below.
...
Calendar Properties
...
See Create a Calendar: Calendar Properties.
...
Custom Day Properties
...
See Create a Calendar: Custom Day Properties.
...
Local Custom Day Properties
...
See Create a Calendar: Local Custom Day Properties.
...
Example Response
...
- Status 200 /OK
Successfully updated the calendar with sysId <sysId> to version <version>.
...
The excludeRelated property is included in the XML as an attribute.
...
XML Request
...
JSON Request
...
title | XML Request |
---|
<calendar> <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays> <customDays> <customDay> <name>uc - Christmas</name> <sysId>daf16d70c0a801650040c4d58a3feebd</sysId> </customDay> <customDay> <name>uc - Flag Day</name> <sysId>daf16d8fc0a801650040c4d54b2432fb</sysId> </customDay> </customDays> <comments>American Calendar</comments> <firstDayOfWeek>Sunday</firstDayOfWeek> <localCustomDays> <localCustomDay> <adjustment>None</adjustment> <adjustmentAmount>1</adjustmentAmount> <adjustmentType>Day</adjustmentType> <category>Holiday</category> <comments/> <ctype>Single Date</ctype> <date>2017-08-23</date> <dateList/> <day>1</day> <dayofweek>Sun</dayofweek> <month>Jan</month> <name>local custom day</name> <relfreq>1st</relfreq> <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId> </localCustomDay> </localCustomDays> <name>uc - American Calendar</name> <opswiseGroups /> <sysId>da24b953c0a8016501fbcb18464d8328</sysId> </calendar>
...
title | JSON Request |
---|
{ "businessDays": { "value": "Monday,Tuesday,Wednesday,Thursday,Friday" }, "comments": "American Calendar", "customDays": [ { "name": "uc - Christmas", "sysId": "daf16d70c0a801650040c4d58a3feebd" }, { "name": "uc - Flag Day", "sysId": "daf16d8fc0a801650040c4d54b2432fb" } ], "firstDayOfWeek": "Sunday", "localCustomDays": [ { "adjustment": "None", "adjustmentAmount": 1, "adjustmentType": "Day", "category": "Holiday", "comments": null, "ctype": "Single Date", "date": "2017-08-23", "dateList": [], "day": 1, "dayofweek": "Sun", "month": "Jan", "name": "local custom day", "relfreq": "1st", "sysId": "616ec15e7a5e40dbaae421e3688a25e5" } ], "name": "uc - American Calendar", "opswiseGroups": [], "sysId": "da24b953c0a8016501fbcb18464d8328" }
...
Description
...
URI
...
...
HTTP Method
...
GET
...
Description
...
Retrieves information on a specific Calendar.
...
URI Parameters
...
See Read a Calendar: URI Parameters, below.
...
Example URI
...
- http://localhost:8080/uc/resources/calendar?calendarname=testCalendar
- http://localhost:8080/uc/resources/calendar?calendarid=d26265a2c4f345359d9b356f18a462c1
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/xml, application/json
...
Example Response
...
- Status 200 /OK
(See Read a Calendar: Example Response, below.) - Status 404 /Not Found
A calendar with id "d26265a2c4f345359d9b356f18a462c1" does not exist.
...
Calendar Properties
...
See Create a Calendar: Calendar Properties.
...
Custom Day Properties
...
See Create a Calendar: Custom Day Properties.
...
Local Custom Day Properties
...
See Create a Calendar: Local Custom Day Properties.
...
Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
calendarid
...
Unique ID for this Calendar.
...
Y
(unless calendarname
is specified)
...
calendarname
...
calendarname
...
Name used within the Controller to identify this Calendar.
...
Maximum 40 alphanumerics.
...
Y
(unless calendarid
is specified)
...
calendarid
...
The retainSysIds
and version
properties are specified as attributes in XML.
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on a specific Calendar. |
URI Parameters | See Read a Calendar: URI Parameters, below. |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response |
|
Calendar Properties | |
Custom Day Properties | |
Local Custom Day Properties |
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Calendar. | Y |
| |
| Name used within the Controller to identify this Calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
The retainSysIds
and version
properties are specified as attributes in XML.
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
...