Update an issue type
patch
/fscmRestApi/resources/11.13.18.05/publicSectorIssueTypes/{publicSectorIssueTypesUniqID}
Request
Path Parameters
-
publicSectorIssueTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and IssueTypeId ---for the Issue Types resource and used to uniquely identify an instance of Issue Types. The client should not generate the hash key value. Instead, the client should query on the Issue Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Issue Types.
For example: publicSectorIssueTypes?q=AgencyId=<value1>;IssueTypeId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for the agency.
-
Description: string
(byte)
Title:
Description
The description of the issue type. -
IconImage: string
Title:
Icon
Maximum Length:100
The name of the image that is used as an icon. -
IssueType: string
Title:
Issue Type
Maximum Length:100
The name of the issue type. -
ProcessGrpId: string
Maximum Length:
50
The unique identifier for the process group. -
Status: string
Title:
Status
Maximum Length:10
The status of the issue type. -
ValidFromDate: string
(date)
Title:
Valid from Date
The date from which the issue type is valid. -
ValidToDate: string
(date)
Title:
Valid to Date
The date until which the issue type 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 : publicSectorIssueTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for the agency.
-
Description: string
(byte)
Title:
Description
The description of the issue type. -
IconImage: string
Title:
Icon
Maximum Length:100
The name of the image that is used as an icon. -
IssueType: string
Title:
Issue Type
Maximum Length:100
The name of the issue type. -
IssueTypeId: string
Title:
Issue Type ID
Maximum Length:50
The unique identifier for the issue type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessGrpId: string
Maximum Length:
50
The unique identifier for the process group. -
Status: string
Title:
Status
Maximum Length:10
The status of the issue type. -
ValidFromDate: string
(date)
Title:
Valid from Date
The date from which the issue type is valid. -
ValidToDate: string
(date)
Title:
Valid to Date
The date until which the issue type 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.