Create an issue subtype
post
/fscmRestApi/resources/11.13.18.05/publicSectorIssueSubtypes
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)
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. -
IssueTypeId: string
Title:
Issue Type ID
Maximum Length:50
The name that uniquely identifies the issue type associated with the issue subtype. -
NoticeGroupCode: string
Maximum Length:
100
The notice group code. -
ProcessGrpId: string
Maximum Length:
50
The unique identifier for the process group. -
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.
Response
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-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.