Get all record type display groups
get
/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups
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:- usePermitAndCitizenFinder: Finds a record type display group that matches the specified search criteria. Finder Variables:
- citizenEnabled; string; Indicates whether the record type of one display group is enabled for a public user to submit the application form.
- citizenEnabled2; string; Indicates whether the record type of one display group is enabled for a public user to submit the application form.
- citizenEnabled3; string; Indicates whether the record type of one display group is enabled for a public user to submit the application form.
- usePermit; string; Indicates whether the display group is used for the Permits service or not.
- simpleSearchFinder: Finds a record type display group using the specified key criteria. Finder Variables:
- value; string; The key criteria used to find a display group or the description to find a record type display group.
- PrimaryKey: Finds a display group that matches the primary key criteria specified. Finder Variables:
- AgencyId; integer; The unique identifier for a public sector agency.
- DisplayGroup; string; The unique identifier for the record type display group.
- usePermitAndCitizenFinder: Finds a record type display group that matches the specified search criteria. 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 : publicSectorDisplayGroups
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 : publicSectorDisplayGroups-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier of a public sector agency. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record type display group. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record type display group was created. -
Description(optional):
string
Maximum Length:
100
The short description of the record type display group. -
DisplayGroup(optional):
string
Maximum Length:
30
The unique identifier of the record type display group. -
DisplayGroupLine(optional):
array Record Type Display Group lines
Title:
Record Type Display Group lines
The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the record type display group is available to be used or not. The default value is false. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the record type display group was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record type display group. -
links(optional):
array Items
Title:
Items
Link Relations -
LongDescription(optional):
string
Title:
Description
Maximum Length:1000
The long description of the record type display group. -
Url(optional):
string
Title:
URL
The URL provides a link that the user can click to navigate to other pages with more information. -
UseBusLicensing(optional):
string
Maximum Length:
1
Indicates whether the display group is used for the business licensing service or not. The default value is no. -
UsePermitting(optional):
string
Maximum Length:
1
Indicates whether the display group is used for the permits service or not. The default value is yes. -
UsePlanning(optional):
string
Maximum Length:
1
Indicates whether the display group is used for the planning and zoning service or not. The default value is no. -
UsePolLicensing(optional):
string
Maximum Length:
1
Indicates whether the display group is used for the professional licensing service or not. The default value is no.
Nested Schema : Record Type Display Group lines
Type:
array
Title:
Record Type Display Group lines
The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.
Show Source
Nested Schema : publicSectorDisplayGroups-DisplayGroupLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier of a public sector agency. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record type display group line. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record type display group line was created. -
DisplayGroup(optional):
string
Maximum Length:
30
The display group to which the group line belongs. -
DisplayOrder(optional):
integer(int64)
The display number for the display group line.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the record type display group line was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record type display group line. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordTypeCode(optional):
string
Title:
Record Type Code
Maximum Length:20
The short name of the record type included in the display group line. -
RecordTypeId(optional):
string
Title:
Record Type ID
Maximum Length:30
The unique identifier of the record type included in the display group line.
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.