Update a GIS attribute mapping
patch
/fscmRestApi/resources/11.13.18.05/publicSectorGISAttributeMappings/{publicSectorGISAttributeMappingsUniqID}
Request
Path Parameters
-
publicSectorGISAttributeMappingsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, GisServiceId and AttrName ---for the GIS Attribute Mappings resource and used to uniquely identify an instance of GIS Attribute Mappings. The client should not generate the hash key value. Instead, the client should query on the GIS Attribute Mappings collection resource with a filter on the primary key values in order to navigate to a specific instance of GIS Attribute Mappings.
For example: publicSectorGISAttributeMappings?q=AgencyId=<value1>;GisServiceId=<value2>;AttrName=<value3>
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
-
AttrLabel: string
Title:
Attribute Label
Maximum Length:100
The user-friendly label of the GIS attribute. -
AttrLayer: string
Title:
Layer
Maximum Length:300
The GIS map service layer associated with the GIS attribute. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the GIS attribute is enabled for capture at application intake. -
GisAttrName: string
Title:
Attribute
Maximum Length:30
The name of the GIS attribute provided by the GIS map service. -
GisAttrType: string
Maximum Length:
30
The type of attribute provided by the GIS map service. -
LayerLabel: string
Title:
Layer Label
Maximum Length:100
The user-friendly label of the GIS map service layer associated with the GIS attribute.
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 : publicSectorGISAttributeMappings-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The identifier for the public sector agency associated with the GIS attribute mapping.
-
AttrLabel: string
Title:
Attribute Label
Maximum Length:100
The user-friendly label of the GIS attribute. -
AttrLayer: string
Title:
Layer
Maximum Length:300
The GIS map service layer associated with the GIS attribute. -
AttrName: string
Title:
Attribute ID
Maximum Length:30
The name of the GIS attribute. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the GIS attribute was created. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the GIS attribute is enabled for capture at application intake. -
GisAttrName: string
Title:
Attribute
Maximum Length:30
The name of the GIS attribute provided by the GIS map service. -
GisAttrType: string
Maximum Length:
30
The type of attribute provided by the GIS map service. -
GisServiceId: string
Title:
Map Service ID
Maximum Length:30
The unique identifier of the GIS map service. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the GIS attribute was last updated. -
LayerLabel: string
Title:
Layer Label
Maximum Length:100
The user-friendly label of the GIS map service layer associated with the GIS attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.