Update a condition of approval
patch
/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}
Request
Path Parameters
-
CoaKey(required): integer(int64)
The unique identifier of the condition of approval.
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
-
CategoryId: string
Maximum Length:
20
The identifier of the type of the category. -
COAConditionComplyPeriods: array
Conditions of Approval Compliance Periods
Title:
Conditions of Approval Compliance Periods
The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application. -
CoaPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval. -
Condition: string
(byte)
The actual text of the condition of approval.
-
LnpRecordPuid: string
Maximum Length:
480
The public unique identifier of the planning and zoning application. -
MigratedDataFlag: string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
PrintSeq: integer
(int32)
Indicates the print sequence of the condition.
-
ReorderData: string
Used to set PrintSeq for conditions. Optionally, accepts data in the given format for PATCH request. OPERATION; COAKey1:PrintSeqNum; COAKey2:PrintSeqNum; COAKey3:PrintSeqNum. Currently, OPERATION supports only the value 'REORDER'.
-
ResolvedDate: string
(date-time)
The date on which the condition of approval was resolved.
-
SourceCoaPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval source. -
Status: string
Maximum Length:
10
Default Value:ORA_APLY
The status of the condition of approval. The valid values are Applied and Resolved. -
SubcategoryId: string
Maximum Length:
20
The identifier of the type of the subcategory.
Nested Schema : Conditions of Approval Compliance Periods
Type:
array
Title:
Conditions of Approval Compliance Periods
The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CoaPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval. -
CoaTransComplyPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval associated with the transaction complies. -
Comments: string
Title:
Resolution Comments
Maximum Length:1000
The comment entered at the time of resolution. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if the compliance period is applicable to the conditions of approval. -
MigratedDataFlag: string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
Status: string
Title:
Resolved
Maximum Length:10
Default Value:ORA_APLY
Indicates if the compliance period is resolved or applied.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorConditionsOfApprovalTransactions-item-response
Type:
Show Source
object
-
CategoryId: string
Maximum Length:
20
The identifier of the type of the category. -
CategoryName: string
Read Only:
true
Maximum Length:50
The name of the category. -
COAConditionComplyPeriods: array
Conditions of Approval Compliance Periods
Title:
Conditions of Approval Compliance Periods
The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application. -
CoaKey: integer
(int64)
The unique identifier of the condition of approval.
-
CoaPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval. -
Compliance: string
Read Only:
true
Maximum Length:4000
The compliances associated with the condition of approval. -
Condition: string
(byte)
The actual text of the condition of approval.
-
ConditionPlain: string
(byte)
Read Only:
true
The text of the condition of approval without any HTML tags. -
ConditionType: string
Maximum Length:
10
The identifier of the type of the condition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
The unique identifier of the planning and zoning application.
-
LnpRecordPuid: string
Maximum Length:
480
The public unique identifier of the planning and zoning application. -
MigratedDataFlag: string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
PrintSeq: integer
(int32)
Indicates the print sequence of the condition.
-
ReorderData: string
Used to set PrintSeq for conditions. Optionally, accepts data in the given format for PATCH request. OPERATION; COAKey1:PrintSeqNum; COAKey2:PrintSeqNum; COAKey3:PrintSeqNum. Currently, OPERATION supports only the value 'REORDER'.
-
ResolvedDate: string
(date-time)
The date on which the condition of approval was resolved.
-
SourceCoaKey: integer
(int64)
The unique identifier of the condition of approval for the planning application.
-
SourceCoaPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval source. -
SourceLnpRecId: string
Read Only:
true
Maximum Length:50
The unique identifier of the planning application record for the attribute SourceCoaKey. -
SourceLnpRecKey: integer
(int64)
Read Only:
true
The unique identifier of the planning application record key for the attribute SourceCoaKey. -
SourcePrintSeq: integer
(int32)
Read Only:
true
Indicates the print sequence of the condition for the attribute SourceLnpRecId. -
Status: string
Maximum Length:
10
Default Value:ORA_APLY
The status of the condition of approval. The valid values are Applied and Resolved. -
StatusType: string
Read Only:
true
Maximum Length:80
The status of the condition of approval. Valid values are Applied and Resolved. -
SubcategoryId: string
Maximum Length:
20
The identifier of the type of the subcategory. -
SubcategoryName: string
Read Only:
true
Maximum Length:50
The name of the subcategory. -
Type: string
Read Only:
true
Maximum Length:80
The name of the condition type. -
UpdatedByDate: string
Read Only:
true
Maximum Length:255
The date on which the condition of approval was updated. -
UpdatedByName: string
Read Only:
true
The name of the person who updated the condition.
Nested Schema : Conditions of Approval Compliance Periods
Type:
array
Title:
Conditions of Approval Compliance Periods
The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item-response
Type:
Show Source
object
-
CoaKey: integer
(int64)
The unique identifier of the condition of approval.
-
CoaPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval. -
CoaTransComplyKey: integer
(int64)
The unique identifier of the condition of approval associated with the transaction complies.
-
CoaTransComplyPuid: string
Maximum Length:
480
The public unique identifier of the migrated condition of approval associated with the transaction complies. -
Comments: string
Title:
Resolution Comments
Maximum Length:1000
The comment entered at the time of resolution. -
ComplyPrdId: string
Maximum Length:
20
The identifier of the compliance period associated with the conditions of approval. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if the compliance period is applicable to the conditions of approval. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MigratedDataFlag: string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
Status: string
Title:
Resolved
Maximum Length:10
Default Value:ORA_APLY
Indicates if the compliance period is resolved or applied.
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.
Links
- COAConditionComplyPeriods
-
Parameters:
- CoaKey:
$request.path.CoaKey
The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application. - CoaKey: