...
Property | UI Field Name | Description | Specifications | Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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
...
Anchor | name - CCD | name - CCD
The Read a Calendar web service will return useDefaultIfBlank only if | N | |||||||
comments | Description | User-defined; description for the calendar. | N | |||||||
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 | ||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | ||||||
exportTable | n/a | Record table information. | read only | N | ||||||
firstDayOfWeek | First Day Of Week | Day that is considered the start of the week. | Valid values:
| N | ||||||
name | Name | Name used within the Controller to identify this Custom Daycalendar. | Maximum 40 alphanumerics. | Y | ||||||
sysId | n/a | sysId of the Calendar-to-Custom Day relationship. | N |
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anchor | adjustment - LCD | adjustment - LCD | Adjustment | If | Valid values: Default is None (0 | Member of Business Services | List of Business Services:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retainSysIds | n/a | Specification for whether or not the Create a Calendar web service will persist the sysId property.
| Valid values: true/false (default is true). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Default is 1
adjustmentAmount | Adjustment Amount | If |
| n/a | System ID field in the database for this Calendar record. | Persisted only if retainSysIds is set to true. | N Anchor | | adjustmentType - LCD | adjustmentType - LCD | Adjustment Type | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | category - LCD | category - LCD | Category | Category of this Local Custom Day. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | comments - LCD | comments - LCD | Description | Description of this Local Custom Day. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | ctype - LCD | ctype - LCD | Type | Type of this Local Custom Day. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | date - LCD | date - LCD | Date | Specific date for this Local Custom Day | Format: yyyy-mm-dd. | Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | dateList - LCD | dateList - LCD | Dates | Multiple specific dates for this Local Custom Day. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | Y |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | day - LCD | day - LCD | Day | Day of the month. | Integer; Valid values: 1-31. | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | dayofweek - LCD | dayofweek - LCD | Day Of Week | Day of the week. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | month - LCD | month - LCD | Month | Month of the year. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | name - LCD | name - LCD | Name | Name of this Local Custom Day. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | observedRules - LCD | observedRules - LCD | Observed Rules | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | Valid day of week values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | relfreq - LCD | relfreq - LCD | When | Occurrence of this day in the month. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | sysId - LCD | sysId - LCD | n/a | System ID in the database for this Local Custom Day. | Persisted only if retainSysIds is set to true. | Y |
...
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.
...
firstQuarterStart | 1st 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. |
secondQuarterStart | 2nd 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. |
thirdQuarterStart | 3rd 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. |
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 | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
name | Name | 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 |
---|
...
XML Response | JSON Response | ||||||||
---|---|---|---|---|---|---|---|---|---|
Expand |
|
| Unique ID for this Calendar. | Y |
| ||||
| Name used within the Controller to identify this Calendar. | Maximum 40 alphanumerics. | Y |
|
...
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.
adjustment | Adjustment | If | Valid values:
Default is None (0). | N | ||||||||||||||||
adjustmentAmount | Adjustment Amount | If | Default is 1. | N | ||||||||||||||||
adjustmentType | 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 | ||||||||||||||||
comments | Description | Description of this Local Custom Day. | N | |||||||||||||||||
ctype | Type | Type of this Local Custom Day. | Valid values:
Default is Single Date (0). | N | ||||||||||||||||
date | Date | Specific date for this Local Custom Day | Format: yyyy-mm-dd. | Y |
| |||||||||||||||
dateList | Dates | Multiple specific dates for this Local Custom Day. | XML
| Y |
| |||||||||||||||
day | Day | Day of the month. | Integer; Valid values: 1-31. | Y | ||||||||||||||||
dayofweek | Day Of Week | Day of the week. | Valid values:
Default is Mon (2). | Y | ||||||||||||||||
month | 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
| 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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
...
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
...
XML Response
...
JSON Response
...
title | XML Response |
---|
...
in XML.
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
...