Get all issue subtypes
get
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes
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 issue subtypes that matches the specified primary key criteria.
Finder Variables:- AgencyId; integer; The unique identifier for the agency.
- IssueSubtypeId; string; The unique identifier of the issue subtype.
- issueSubtypeFinder: Finds the issue subtypes that match the specified bind variable criteria.
Finder Variables:- value; string; Finds the issue type, issue sub type or search tags that match the specified primary key criteria.
- simpleSearchFinder: Finds the issue subtypes that match the specified primary key criteria.
Finder Variables:- value; string; The key identifier of the search value.
- PrimaryKey: Finds the issue subtypes 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 unique identifier for the agency.
- AutoNumRuleCase; string; The autonumber rule definition for cases that have this issue subtype.
- AutoNumRuleIncident; string; The autonumber rule for incidents that have this issue subtype.
- CitizenEnabled; string; Indicates whether the issue subtype is enabled for all users, only for registered users, or only for users other than public users.
- CloneCodeReference; string; The clone of the code reference.
- CloneDesignForm; string; Identifier for the issue subtype intake form that was cloned to create the intake form for the current issue subtype.
- CloneIssueSubtypeCode; string; The clone of the issue subtype.
- CloneTimeRule; string; The clone of the time rule.
- DistrictType; string; The unique identifier for the district type that the issue subtype is associated with.
- FeeScheduleId; string; The fee schedule ID associated with the issue subtype.
- IconImage; string; The sui-icon image name.
- IssueSubtype; string; The name of the issue subtype.
- IssueSubtypeCode; string; The issue subtype code.
- IssueSubtypeId; string; The unique identifier for the issue subtype.
- IssueType; string; The name of the issue type for this issue subtype.
- IssueTypeId; string; The name that uniquely identifies the issue type associated with the issue subtype.
- NoticeGroupCode; string; The notice group code.
- ProcessGrpId; string; The unique identifier for the process group.
- PublishedState; string; A status that indicates whether the intake form for this issue subtype has been published.
- ShortDescr; string; The short description for the issue subtype.
- Status; string; The status of the issue subtype.
- ValidFromDate; string; The date from which the issue subtype is valid.
- ValidToDate; string; The date to which the issue subtype is valid.
-
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 : publicSectorIssueSubtypes
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 : publicSectorIssueSubtypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for the agency.
-
AutoNumRuleCase: string
Title:
Case Autonumber Rule
Maximum Length:20
The autonumber rule definition for cases that have this issue subtype. -
AutoNumRuleIncident: string
Title:
Incident Autonumber Rule
Maximum Length:20
The autonumber rule for incidents that have this issue subtype. -
CitizenEnabled: string
Title:
Public User Enabled
Maximum Length:10
Indicates whether the issue subtype is enabled for all users, only for registered users, or only for users other than public users. -
CloneCodeReference: string
Maximum Length:
255
The clone of the code reference. -
CloneDesignForm: string
Identifier for the issue subtype intake form that was cloned to create the intake form for the current issue subtype.
-
CloneIssueSubtypeCode: string
The clone of the issue subtype.
-
CloneTimeRule: string
The clone of the time rule.
-
Description: string
(byte)
Title:
Description
The description of the issue subtype. -
DistrictType: string
Title:
District Type
Maximum Length:50
The unique identifier for the district type that the issue subtype is associated with. -
FeeScheduleId: string
Title:
Fee Schedule
Maximum Length:20
The fee schedule ID associated with the issue subtype. -
IconImage: string
Title:
Icon
Maximum Length:100
The sui-icon image name. -
IssueSubtype: string
Title:
Issue Subtype
Maximum Length:100
The name of the issue subtype. -
IssueSubtypeCode: string
Title:
Issue Subtype ID
Maximum Length:40
The issue subtype code. -
IssueSubtypeId: string
Title:
Issue Subtype ID
Maximum Length:50
The unique identifier for the issue subtype. -
IssueType: string
Read Only:
true
Maximum Length:100
The name of the issue type for this issue subtype. -
IssueTypeId: string
Title:
Issue Type ID
Maximum Length:50
The name that uniquely identifies the issue type associated with the issue subtype. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoticeGroupCode: string
Maximum Length:
100
The notice group code. -
ProcessGrpId: string
Maximum Length:
50
The unique identifier for the process group. -
PublishedState: string
Read Only:
true
Maximum Length:1
A status that indicates whether the intake form for this issue subtype has been published. -
ShortDescr: string
Maximum Length:
150
The short description for the issue subtype. -
Status: string
Title:
Status
Maximum Length:10
The status of the issue subtype. -
ValidFromDate: string
(date)
Title:
Valid from Date
The date from which the issue subtype is valid. -
ValidToDate: string
(date)
Title:
Valid to Date
The date to which the issue subtype is valid.
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.