Nothing Found

Edit Schedule Item

Update or edit a schedule item based on the given details.

Securityoauth2
Request
path Parameters
offerId
required
integer <int32>

Unique identifier of an offer.

Example: <<Incomplete_example>>
lobName
required
string

Name of the line of business.

Example: <<Incomplete_example>>
state
required
string

<>

Example: <<Incomplete_example>>
businessEntityId
required
integer <int32>

Unique identifier of a business entity.

Example: <<Incomplete_example>>
userId
required
integer <int32>

Unique identifier of a user.

Example: <<Incomplete_example>>
template
required
string

<>

Example: <<Incomplete_example>>
Request Body schema:
id
string or null

ID of Schedule.

code
string or null

Code of Schedule.

mode
integer <int32> (VAM.DealFoundry.WebAPI.Entities.Models.Action)
Enum: 0 1 2
name
string or null

Name of Schedule.

displayName
string or null

Display name of Schedule.

output
string or null

Indicates output.

helpText
string or null

Displays Schedule information on UI.

isMandatory
boolean

Indicates whether the Schedule is mandatory or not.

coverageType
string or null

Coverage type of Schedule.

formType
integer <int32> (VAM.DealFoundry.WebAPI.Entities.Models.formType)
Enum: 0 1 2
stateName
string or null

State name of Schedule.

cardinality
integer <int32> (VAM.DealFoundry.WebAPI.Entities.Models.Cardinality)
Enum: 0 1
formNumber
string or null

Form number of Schedule.

formId
string or null

Form ID of Schedule.

scheduleDetalXML
string or null

Details XML for Schedule.

scheduleData
Array of objects or null (VAM.DealFoundry.WebAPI.Entities.Models.Section)
Array of objects or null (VAM.DealFoundry.WebAPI.Entities.Models.Field)
Array of objects or null (VAM.DealFoundry.WebAPI.Entities.Models.Coverage)
Array of objects or null (VAM.DealFoundry.WebAPI.Entities.Models.Fields)
isVisible
boolean

Indicates whether the section is visible on UI or not.

sequenceNumber
integer <int32>

Sequence number of section.

fullPath
string or null

Full path of section.

uiRuleIndicator
boolean

Indicates whether the section type is UIRuleIndicator or not.

Responses
200

Success

401

Unauthorized

403

Forbidden

post/api/v1/forms/EditScheduleItem/{offerId}/{lobName}/{state}/{businessEntityId}/{userId}/{template}
Request samples
{
  • "id": "string",
  • "code": "string",
  • "mode": 0,
  • "name": "string",
  • "displayName": "string",
  • "output": "string",
  • "helpText": "string",
  • "isMandatory": true,
  • "coverageType": "string",
  • "formType": 0,
  • "stateName": "string",
  • "cardinality": 0,
  • "formNumber": "string",
  • "formId": "string",
  • "scheduleDetalXML": "string",
  • "scheduleData": [
    ],
  • "fields": [
    ],
  • "scheduleCoverages": [
    ],
  • "scheduleFields": [
    ],
  • "isVisible": true,
  • "sequenceNumber": 0,
  • "fullPath": "string",
  • "uiRuleIndicator": true
}
Response samples
No sample