Get all meeting templates
get
/fscmRestApi/resources/11.13.18.05/publicSectorMeetingSetups
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the meeting template that matches the specified primary key criteria.
Finder Variables:- AgencyId; integer; The identifier of the public sector agency.
- MeetTemplateId; string; The identifier of the meeting template.
- simpleSearchFinder: Finds the meeting template that matches the specified criteria.
Finder Variables:- value; string; Finds the meeting template that matches the specified value.
- PrimaryKey: Finds the meeting template that matches the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The identifier of the public sector agency.
- ApplicantReschedule; string; The identifier to indicate if an applicant can reschedule or cancel a meeting.
- ApplicantSchedule; string; The identifier to indicate if an applicant can schedule a meeting.
- Description; string; The description of the meeting template.
- EnabledFlag; string; The identifier to indicate if the meeting template is enabled for assignment on the record type page.
- IncludeAgenda; string; Indicates if the meeting agenda should be shown in the Schedule Meetings page.
- IncludeSubject; string; Indicates if the meeting subject should be shown in the Schedule Meetings page.
- IncludeVenue; string; Indicates if the meeting location should be shown in the Schedule Meetings page.
- MaxMeetingConcurrency; integer; The identifier of the maximum number of meetings that can be conducted in parallel for a given period within the agency.
- MeetTemplateId; string; The unique identifier of the meeting template.
- MeetingDurationHours; number; The identifier of the estimated duration of a meeting.
- MeetingSubject; string; The text of the meeting subject to be shown in the Schedule Meetings page.
- MeetingVenue; string; The description of the meeting venue.
- MeetingWorkschedule; string; The identifier to indicate the work schedule that will be used by the agency for the meeting configuration.
- Name; string; The name of the template.
- ScheduleUptoDays; integer; The identifier of the number of days to display on the calendar for scheduling the meeting.
- StartOfWindow; integer; The identifier to indicate the number of days in advance after which the meeting can be configured.
- UseScheduleAgency; string; The identifier to indicate if an agency work schedule is to be used for configuration.
- UseSchedulePlanner; string; The identifier to indicate if planners work schedule is to be used for the configuration.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.