Update a property condition
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPropertyConditions/{publicSectorPropertyConditionsUniqID}
Request
Path Parameters
-
publicSectorPropertyConditionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PropertyCondition and AgencyId ---for the Property Conditions resource and used to uniquely identify an instance of Property Conditions. The client should not generate the hash key value. Instead, the client should query on the Property Conditions collection resource with a filter on the primary key values in order to navigate to a specific instance of Property Conditions.
For example: publicSectorPropertyConditions?q=PropertyCondition=<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
-
AgencyId: integer
(int32)
Default Value:
1
The agency ID of the property condition. -
Description: string
Title:
Description
Maximum Length:100
The description of the property condition. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the property condition is active. If the value is Y, the condition is active.
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 : publicSectorPropertyConditions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency ID of the property condition. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the property condition. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the property condition was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the property condition. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the property condition is active. If the value is Y, the condition is active. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the property condition was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the property condition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PropertyCondition: string
Title:
Property Condition
Maximum Length:30
The property condition name.
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.