Skip to content

Corrigo: Work zone schemas

1 Corrigo schema with complete fields and constraints.

← Work zone operations · All schemas

Update work zone — request body — body entity

FieldTypePresenceDescription and constraints
$objectRoot
idintegerOptionalFormat: int32
isNewbooleanOptionalRead only: true
limitMultipleEntitiesNumberBehaviourbooleanOptional
performDeletionbooleanOptional
propertiesJSONOptional
properties (anyOf 1)arrayAlternative
properties (anyOf 1)[]JSONEach item
properties (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo PropertyTreeNode.
properties (anyOf 1)[] (anyOf 2)nullAlternative
properties (anyOf 2)nullAlternative
concurrencyIdintegerOptionalFormat: int32
isRemovedbooleanOptional
accessOptionsMaskintegerOptionalFormat: int32
advanceNoticeintegerOptionalFormat: int32
allowTimePreferencebooleanOptional
assetJSONOptional
asset (anyOf 1)objectAlternativeA Corrigo Location.
asset (anyOf 2)nullAlternative
autoAssignEnabledbooleanOptional
backupRoutingIdstringOptionalOne of: Unassigned, OnCall, Default
Format: int32
billingAccountJSONOptional
billingAccount (anyOf 1)objectAlternativeA Corrigo BillingAccount.
billingAccount (anyOf 2)nullAlternative
bizHoursJSONOptional
bizHours (anyOf 1)arrayAlternative
bizHours (anyOf 1)[]JSONEach item
bizHours (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo BusinessHours.
bizHours (anyOf 1)[] (anyOf 2)nullAlternative
bizHours (anyOf 2)nullAlternative
blackoutDaysJSONOptional
blackoutDays (anyOf 1)arrayAlternative
blackoutDays (anyOf 1)[]JSONEach item
blackoutDays (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo BlackoutDay.
blackoutDays (anyOf 1)[] (anyOf 2)nullAlternative
blackoutDays (anyOf 2)nullAlternative
contactAddressesJSONOptional
contactAddresses (anyOf 1)arrayAlternative
contactAddresses (anyOf 1)[]JSONEach item
contactAddresses (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo ContactInfo.
contactAddresses (anyOf 1)[] (anyOf 2)nullAlternative
contactAddresses (anyOf 2)nullAlternative
contractJSONOptional
contract (anyOf 1)objectAlternativeA Corrigo Contract.
contract (anyOf 2)nullAlternative
cpThemeIdintegerOptionalFormat: int32
criticalFacilitiesstringOptionalOne of: No, Yes, Inherit
Format: int32
currencyTypeIdModelOptionalExpand Create rcs action — request body — body entity money Id
customFieldsJSONOptional
customFields (anyOf 1)arrayAlternative
customFields (anyOf 1)[]JSONEach item
customFields (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo CustomField2.
customFields (anyOf 1)[] (anyOf 2)nullAlternative
customFields (anyOf 2)nullAlternative
defaultAccessstringOptionalOne of: Unknown, PTE, Appointment, CallFirst, NotApplicable
Format: int32
defaultBillToLogicintegerOptionalFormat: int32
displayAsJSONOptional
displayAs (anyOf 1)stringAlternative
displayAs (anyOf 2)nullAlternative
earliestSlotintegerOptionalFormat: int32
entityJSONOptional
entity (anyOf 1)stringAlternative
entity (anyOf 2)nullAlternative
escalationRulesJSONOptional
escalationRules (anyOf 1)arrayAlternative
escalationRules (anyOf 1)[]JSONEach item
escalationRules (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo EscalationRule.
escalationRules (anyOf 1)[] (anyOf 2)nullAlternative
escalationRules (anyOf 2)nullAlternative
excludeNonCompliantProvidersstringOptionalOne of: InheritGlobalSettings, No, ExcludeAndBlock, ExcludeAndWarn
Format: int32
holidaysJSONOptional
holidays (anyOf 1)arrayAlternative
holidays (anyOf 1)[]JSONEach item
holidays (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo Holiday.
holidays (anyOf 1)[] (anyOf 2)nullAlternative
holidays (anyOf 2)nullAlternative
isNteAutoJSONOptional
isNteAuto (anyOf 1)booleanAlternative
isNteAuto (anyOf 2)nullAlternative
isOfflinebooleanOptional
isPrecalculatedSchedulebooleanOptional
ismSpecGroupIdintegerOptionalFormat: int32
ismUrlJSONOptional
ismUrl (anyOf 1)stringAlternative
ismUrl (anyOf 2)nullAlternative
languageIdintegerOptionalFormat: int32
latestSlotintegerOptionalFormat: int32
noIncompleteItembooleanOptional
noIncompleteProcedurebooleanOptional
numberJSONOptional
number (anyOf 1)stringAlternative
number (anyOf 2)nullAlternative
onCallRulesJSONOptional
onCallRules (anyOf 1)arrayAlternative
onCallRules (anyOf 1)[]JSONEach item
onCallRules (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo OnCallRule.
onCallRules (anyOf 1)[] (anyOf 2)nullAlternative
onCallRules (anyOf 2)nullAlternative
portfoliosJSONOptional
portfolios (anyOf 1)arrayAlternative
portfolios (anyOf 1)[]JSONEach item
portfolios (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo LinkPortfolioAndWorkZone.
portfolios (anyOf 1)[] (anyOf 2)nullAlternative
portfolios (anyOf 2)nullAlternative
regulatoryFrameworkIDJSONOptional
regulatoryFrameworkID (anyOf 1)integerAlternativeFormat: int32
regulatoryFrameworkID (anyOf 2)nullAlternative
responsibilitiesJSONOptional
responsibilities (anyOf 1)arrayAlternative
responsibilities (anyOf 1)[]JSONEach item
responsibilities (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo Responsibility.
responsibilities (anyOf 1)[] (anyOf 2)nullAlternative
responsibilities (anyOf 2)nullAlternative
roundApptTimeTointegerOptionalFormat: int32
schedulingWindowintegerOptionalFormat: int32
slaValuesJSONOptional
slaValues (anyOf 1)arrayAlternative
slaValues (anyOf 1)[]JSONEach item
slaValues (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo SlaValuesOverride.
slaValues (anyOf 1)[] (anyOf 2)nullAlternative
slaValues (anyOf 2)nullAlternative
slotsCountintegerOptionalFormat: int32
specDispatchRulesJSONOptional
specDispatchRules (anyOf 1)arrayAlternative
specDispatchRules (anyOf 1)[]JSONEach item
specDispatchRules (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo SpecDispatchRule.
specDispatchRules (anyOf 1)[] (anyOf 2)nullAlternative
specDispatchRules (anyOf 2)nullAlternative
taxRegionJSONOptional
taxRegion (anyOf 1)objectAlternativeA Corrigo TaxRegion.
taxRegion (anyOf 2)nullAlternative
teamsJSONOptional
teams (anyOf 1)arrayAlternative
teams (anyOf 1)[]JSONEach item
teams (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo LinkTeamAndWorkZone.
teams (anyOf 1)[] (anyOf 2)nullAlternative
teams (anyOf 2)nullAlternative
timeZoneintegerOptionalFormat: int32
turnKickOffAutobooleanOptional
turnKickOffLagDaysintegerOptionalFormat: int32
turnKickOffOnDaysintegerOptionalFormat: int32
turnTemplateIdintegerOptionalFormat: int32
uiShowProvidersFirstbooleanOptional
unitTemplateIDintegerOptionalFormat: int32
useBizHoursbooleanOptional
useBlackoutDaysbooleanOptional
useEscalationbooleanOptional
useHolidaysbooleanOptional
useOnCallbooleanOptional
woNumberDigitsintegerOptionalFormat: int32
woNumberPrefixJSONOptional
woNumberPrefix (anyOf 1)stringAlternative
woNumberPrefix (anyOf 2)nullAlternative
workPlanAutoCancelbooleanOptional
workPlanAutoDependencybooleanOptional
workPlanChildResolutionbooleanOptional

Referenced models: Create rcs action — request body — body entity money Id

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.