Update an application category
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCategories/{publicSectorCategoriesUniqID}
Request
Path Parameters
-
publicSectorCategoriesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and Category ---for the Application Categories resource and used to uniquely identify an instance of Application Categories. The client should not generate the hash key value. Instead, the client should query on the Application Categories collection resource with a filter on the primary key values in order to navigate to a specific instance of Application Categories.
For example: publicSectorCategories?q=AgencyId=<value1>;Category=<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
-
Description: string
Title:
Description
Maximum Length:100
The description of the application category. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the application category is available to be used. The default value is false. -
UseBusLicensing: string
Title:
Business Licenses
Maximum Length:1
Indicates whether the application category is used for business licensing. The default value is no. -
UsePermitting: string
Title:
Permits
Maximum Length:1
Indicates whether the application category is used for permits. The default value is yes. -
UsePlanning: string
Title:
Planning and Zoning
Maximum Length:1
Indicates whether the application category is used for planning and zoning. The default value is no. -
UsePolLicensing: string
Title:
Professional Licenses
Maximum Length:1
Indicates whether the application category is used for professional licensing. The default value is no.
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 : publicSectorCategories-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for a public sector agency. -
Category: string
Title:
Category
Maximum Length:30
The category of the application. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the application category. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the application category was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the application category. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the application category is available to be used. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the application category was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the application category. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UseBusLicensing: string
Title:
Business Licenses
Maximum Length:1
Indicates whether the application category is used for business licensing. The default value is no. -
UsePermitting: string
Title:
Permits
Maximum Length:1
Indicates whether the application category is used for permits. The default value is yes. -
UsePlanning: string
Title:
Planning and Zoning
Maximum Length:1
Indicates whether the application category is used for planning and zoning. The default value is no. -
UsePolLicensing: string
Title:
Professional Licenses
Maximum Length:1
Indicates whether the application category is used for professional licensing. The default value is no.
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.