Get all Pre-Application meeting attributes
get
/fscmRestApi/resources/11.13.18.05/publicSectorPreappMeetingCommunications
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:- simpleSearchFinder: Finds the matching notification row by matching a list of fields. Finder Variables:
- value; string; Finds the value for which the search is performed.
- PrimaryKey: Finds the notification row that matches the specified search criteria. Finder Variables:
- AssignedDatetime; string; The identifier of the date and time when a planner was assigned to Pre-application.
- AssigneeId; integer; The unique identifier of the assigned planner.
- LnpRecordKey; integer; The unique identifier of the Pre-application.
- MeetingId; integer; The unique identifier of the meeting.
- simpleSearchFinder: Finds the matching notification row by matching a list of fields. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPreappMeetingCommunications
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPreappMeetingCommunications-item
Type:
Show Source
object
-
Address1(optional):
string
Title:
Address Line 1
Maximum Length:240
The address of the Pre-Application. -
Address2(optional):
string
Title:
Address Line 2
Maximum Length:240
The additional address of the Pre-Application. -
Address3(optional):
string
Title:
Address Line 3
Maximum Length:240
The additional address of the Pre-Application. -
Address4(optional):
string
Title:
Address Line 4
Maximum Length:240
The additional address of the Pre-Application. -
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the public sector agency. -
Applicant(optional):
integer(int64)
Title:
Applicant ID
The identifier of the applicant of the Pre-Application. -
ApplicantUserId(optional):
string
Title:
Applicant User ID
The userid of the applicant as setup in the system. -
ApplicationStatus(optional):
string
Title:
Pre-application Status
Maximum Length:15
The status of the application. -
AssignedDatetime(optional):
string(date-time)
Title:
Assigned Date and Time
The identifier of the date and time when a planner was assigned to Pre-Application. -
AssigneeId(optional):
integer(int64)
Title:
Planner ID
The unique identifier of the assigned planner. -
City(optional):
string
Title:
City
Maximum Length:60
The city of the Pre-Application. -
Classification(optional):
string
Title:
Classification
Maximum Length:3
The unique identifier of the type of application. -
ContextRecordType(optional):
string
Title:
Record Type
Maximum Length:30
The unique identifier of the type of record. -
Country(optional):
string
Title:
Country
Maximum Length:3
The country of the Pre-Application. -
County(optional):
string
Title:
County
Maximum Length:60
The county of the Pre-Application. -
Description(optional):
string
Title:
Pre-application Description
Maximum Length:1000
The additional information about the Pre-Application. -
DisplayName(optional):
string
Title:
Planner Name
Maximum Length:240
The name of the planner. -
EmailAddress(optional):
string
Title:
Planner Email
Maximum Length:240
The email of the planner. -
EmailAddress1(optional):
string
Title:
Applicant Primary Email
Maximum Length:320
The email of the applicant. -
EmailAddress2(optional):
string
Title:
Applicant Secondary Email
Maximum Length:320
The additional email of the applicant. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Pre-application ID
Maximum Length:50
The unique identifier of the Pre-Application. -
LnpRecordKey(optional):
integer(int64)
Title:
Transaction Key
The unique identifier of the Pre-Application. -
MeetingAgenda(optional):
string
Title:
Meeting Agenda
Maximum Length:4000
The unique identifier of the meeting agenda. -
MeetingDurationHours(optional):
number
Title:
Meeting Duration in Hours
The unique identifier of the duration of the meeting. -
MeetingEndDttm(optional):
string(date-time)
Title:
Meeting End Time
The unique identifier of the end date and time for the meeting. -
MeetingId(optional):
integer(int64)
Title:
Meeting ID
The unique identifier of the meeting. -
MeetingStartDttm(optional):
string(date-time)
Title:
Meeting Start Time
The unique identifier of the start date and time for the meeting. -
MeetingVenue(optional):
string
Title:
Meeting Location
Maximum Length:2000
The identifier of the location of the meeting. -
PersonName(optional):
string
Title:
Applicant Name
Maximum Length:450
The name of the applicant. -
PlannerUserId(optional):
string
Title:
Planner User ID
The userid of the planner assigned to the application. -
PostalCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code of the Pre-Application. -
Province(optional):
string
Title:
Province
Maximum Length:60
The province of the Pre-Application. -
RecordTypeCode(optional):
string
Title:
Record Type
Maximum Length:20
The unique identifier of the Pre-Application. -
State(optional):
string
Title:
State
Maximum Length:60
The state of the Pre-Application. -
Status(optional):
string
Title:
Meeting Status
Maximum Length:10
The identifier of the status of the meeting. -
Subclassification(optional):
string
Title:
Subclassification
Maximum Length:20
The identifier of the type of application based on classification. -
Tzname(optional):
string
Title:
Time Zone
Maximum Length:64
The identifier of the time zone.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.