...
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
<secondQuarterStart>
<day>14</day>
<month>Apr</month>
</secondQuarterStart>
JSON
"secondQuarterStart": {
"day": "14",
"month": "Apr"
}
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.
thirdQuarterStart
3rd Quarter Start
To specify the start of the 1st Quarter, a day and month must be specified as shown below.
XML
<thirdQuarterStart>
<day>16</day>
<month>Jul</month>
</thirdQuarterStart>
JSON
"thirdQuarterStart": {
"day": "16",
"month": "Jul"
}
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.
fourthQuarterStart
Html bobswift |
---|
<ul>
<li> If <code>businessDays</code> is blank or is not specified in the Request, <code>businessDays</code> defaults to Monday,Tuesday,Wednesday,Thursday,Friday. To disable this behavior, set <b>useDefaultIfBlank</b> to false. That is, to set <code>businessDays</code> to blank when a calendar contains "Business Day" Custom Day(s), specify: <code><businessDays useDefaultIfBlank="false"></businessDays></code>.
<li> If <code>businessDays</code> is blank and the <b>useDefaultIfBlank</b> attribute is not included in the Request (<code><businessDays /></code>), <code>businessDays</code> defaults to Monday,Tuesday,Wednesday,Thursday,Friday.
<li> If <code>businessDays</code> is not blank, <b>useDefaultIfBlank</b> is ignored.
<li> If <b>useDefaultIfBlank</b> is set to true (<code><businessDays useDefaultIfBlank="true"></businessDays></code>), <code>businessDays</code> defaults to Monday,Tuesday,Wednesday,Thursday,Friday.
<li> If <b>useDefaultIfBlank</b> is set to false (<code><businessDays useDefaultIfBlank="false"></businessDays></code>), business days are not set.
</ul> |
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:
Html bobswift |
---|
<ul>
<li> Sunday
<li> Monday
<li> Tuesday
<li> Wednesday
<li> Thursday
<li> Friday
<li> Saturday
</ul> |
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 | ||
---|---|---|
|
JSON
Panel | ||
---|---|---|
|
N
Anchor | ||||
---|---|---|---|---|
|
retainSysIds
n/a
Specification for whether or not the Create a Calendar web service will persist the sysId property.
Html bobswift |
---|
<ul>
<li> If <b>retainSysIds</b>="true" and <code>sysId</code> is included in the request/response, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>="false" and <code>sysId</code> is included in the request/response, <code>sysId</code> will be ignored; it will be autogenerated by the Controller.
</ul> |
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
<fourthQuarterStart><firstQuarterStart>
<day>13<<day>15</day>
<month>10<<month>01</month>
</fourthQuarterStart>firstQuarterStart>
JSON
"fourthQuarterStartfirstQuarterStart": {
"day": "1315",
"month": "OctJan"
}
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
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anchor | adjustment - LCD | adjustment - LCD | Adjustment | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | adjustmentAmount - LCD | adjustmentAmount - LCD | Adjustment Amount | If | Default is 1. | 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. | Valid values: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 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
...