Create a set of meeting templates
post
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Activity ID
Default Value:1
The identifier of the public sector agency. -
ApplicantReschedule: string
Title:
Applicant can reschedule and cancel
Maximum Length:1
Default Value:N
The identifier to indicate if an applicant can reschedule or cancel a meeting. -
ApplicantSchedule: string
Title:
Applicant can request
Maximum Length:1
Default Value:N
The identifier to indicate if an applicant can schedule a meeting. -
Description: string
Title:
Description
Maximum Length:500
The description of the meeting template. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
The identifier to indicate if the meeting template is enabled for assignment on the record type page. -
IncludeAgenda: string
Title:
Include Agenda
Maximum Length:1
Default Value:N
Indicates if the meeting agenda should be shown in the Schedule Meetings page. -
IncludeSubject: string
Title:
Include Subject
Maximum Length:1
Default Value:N
Indicates if the meeting subject should be shown in the Schedule Meetings page. -
IncludeVenue: string
Title:
Include Location
Maximum Length:1
Default Value:N
Indicates if the meeting location should be shown in the Schedule Meetings page. -
MaxMeetingConcurrency: integer
(int32)
Title:
Maximum Concurrent Meetings
Default Value:1
The identifier of the maximum number of meetings that can be conducted in parallel for a given period within the agency. -
MeetingAgendaPlainText: string
(byte)
The non rich text version of the meeting agenda.
-
MeetingAgendaText: string
(byte)
Title:
Meeting Agenda
The rich text enabled description of the meeting agenda. -
MeetingDurationHours: number
Title:
Meeting Duration in Hours
The identifier of the estimated duration of a meeting. -
MeetingSubject: string
Title:
Subject
Maximum Length:4000
The text of the meeting subject to be shown in the Schedule Meetings page. -
MeetingVenue: string
Title:
Meeting Location
Maximum Length:2000
The description of the meeting venue. -
MeetingWorkschedule: string
Title:
Work Schedule
Maximum Length:30
The identifier to indicate the work schedule that will be used by the agency for the meeting configuration. -
MeetTemplateId: string
Title:
Template ID
Maximum Length:30
The unique identifier of the meeting template. -
Name: string
Title:
Template
Maximum Length:50
The name of the template. -
ScheduleUptoDays: integer
(int32)
Title:
Schedule up to Number of Days
The identifier of the number of days to display on the calendar for scheduling the meeting. -
StartOfWindow: integer
(int32)
Title:
Schedule After Number of Days
Default Value:0
The identifier to indicate the number of days in advance after which the meeting can be configured. -
UseScheduleAgency: string
Title:
Agency meeting schedule
Maximum Length:1
The identifier to indicate if an agency work schedule is to be used for configuration. -
UseSchedulePlanner: string
Title:
Staff meeting schedule
Maximum Length:1
The identifier to indicate if planners work schedule is to be used for the configuration.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorMeetingSetups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Activity ID
Default Value:1
The identifier of the public sector agency. -
ApplicantReschedule: string
Title:
Applicant can reschedule and cancel
Maximum Length:1
Default Value:N
The identifier to indicate if an applicant can reschedule or cancel a meeting. -
ApplicantSchedule: string
Title:
Applicant can request
Maximum Length:1
Default Value:N
The identifier to indicate if an applicant can schedule a meeting. -
Description: string
Title:
Description
Maximum Length:500
The description of the meeting template. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
The identifier to indicate if the meeting template is enabled for assignment on the record type page. -
IncludeAgenda: string
Title:
Include Agenda
Maximum Length:1
Default Value:N
Indicates if the meeting agenda should be shown in the Schedule Meetings page. -
IncludeSubject: string
Title:
Include Subject
Maximum Length:1
Default Value:N
Indicates if the meeting subject should be shown in the Schedule Meetings page. -
IncludeVenue: string
Title:
Include Location
Maximum Length:1
Default Value:N
Indicates if the meeting location should be shown in the Schedule Meetings page. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaxMeetingConcurrency: integer
(int32)
Title:
Maximum Concurrent Meetings
Default Value:1
The identifier of the maximum number of meetings that can be conducted in parallel for a given period within the agency. -
MeetingAgendaPlainText: string
(byte)
The non rich text version of the meeting agenda.
-
MeetingAgendaText: string
(byte)
Title:
Meeting Agenda
The rich text enabled description of the meeting agenda. -
MeetingDurationHours: number
Title:
Meeting Duration in Hours
The identifier of the estimated duration of a meeting. -
MeetingSubject: string
Title:
Subject
Maximum Length:4000
The text of the meeting subject to be shown in the Schedule Meetings page. -
MeetingVenue: string
Title:
Meeting Location
Maximum Length:2000
The description of the meeting venue. -
MeetingWorkschedule: string
Title:
Work Schedule
Maximum Length:30
The identifier to indicate the work schedule that will be used by the agency for the meeting configuration. -
MeetTemplateId: string
Title:
Template ID
Maximum Length:30
The unique identifier of the meeting template. -
Name: string
Title:
Template
Maximum Length:50
The name of the template. -
ScheduleUptoDays: integer
(int32)
Title:
Schedule up to Number of Days
The identifier of the number of days to display on the calendar for scheduling the meeting. -
StartOfWindow: integer
(int32)
Title:
Schedule After Number of Days
Default Value:0
The identifier to indicate the number of days in advance after which the meeting can be configured. -
UseScheduleAgency: string
Title:
Agency meeting schedule
Maximum Length:1
The identifier to indicate if an agency work schedule is to be used for configuration. -
UseSchedulePlanner: string
Title:
Staff meeting schedule
Maximum Length:1
The identifier to indicate if planners work schedule is to be used for the configuration.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.