Update a plan review decision
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions/{publicSectorPlanReviewDecisionsUniqID}
Request
Path Parameters
-
publicSectorPlanReviewDecisionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- SystemStatus and AgencyId ---for the Plan Review Decisions resource and used to uniquely identify an instance of Plan Review Decisions. The client should not generate the hash key value. Instead, the client should query on the Plan Review Decisions collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Review Decisions.
For example: publicSectorPlanReviewDecisions?q=SystemStatus=<value1>;AgencyId=<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:
Permit Decision Description
Maximum Length:100
The value that will be displayed for a permit plan review decision in a plan review cycle. -
DescriptionPz: string
Title:
Planning Decision Description
Maximum Length:100
The value that will be displayed for a planning plan review decision in a plan review cycle. -
EnabledFlag: boolean
Title:
Permit Decision Enabled
Maximum Length:1
Indicates whether the decision status is enabled for permit plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments. -
EnabledPzFlag: boolean
Title:
Planning Decision Enabled
Maximum Length:1
Default Value:false
Indicates whether the decision status is enabled for planning plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments.
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 : publicSectorPlanReviewDecisions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the public sector entity to which this plan review decision applies. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the plan review decision was created. -
DecisionStatus: string
Title:
Decision Status
Maximum Length:35
The name of the decision status. -
DeletedFlag: boolean
Maximum Length:
1
Indicates whether the decision seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
Description: string
Title:
Permit Decision Description
Maximum Length:100
The value that will be displayed for a permit plan review decision in a plan review cycle. -
DescriptionPz: string
Title:
Planning Decision Description
Maximum Length:100
The value that will be displayed for a planning plan review decision in a plan review cycle. -
EnabledFlag: boolean
Title:
Permit Decision Enabled
Maximum Length:1
Indicates whether the decision status is enabled for permit plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments. -
EnabledPzFlag: boolean
Title:
Planning Decision Enabled
Maximum Length:1
Default Value:false
Indicates whether the decision status is enabled for planning plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the plan review decision was last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataLock: integer
(int32)
Indicates the level at which the seed data for the decision is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
SystemStatus: string
Title:
System Status
Maximum Length:15
The unique identifier for the plan review decision.
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.