Create a GIS map service
post
/fscmRestApi/resources/11.13.18.05/publicSectorGISServices
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId(required): integer
(int32)
The identifier for the public sector agency associated with the GIS map service.
-
Description: string
Maximum Length:
400
The description of the GIS map service. -
GISAttrMappings: array
GIS Attribute Mappings
Title:
GIS Attribute Mappings
The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake. -
GisServiceId(required): string
Title:
Map Service ID
Maximum Length:30
The unique identifier of the GIS map service. -
GisServiceLabel(required): string
Title:
Map Service Name
Maximum Length:100
The user-friendly label of the GIS map service associated with the GIS attribute. -
GISServiceURL(required): string
Title:
Map Service URL
Maximum Length:300
The URL associated with the GIS map service.
Nested Schema : GIS Attribute Mappings
Type:
array
Title:
GIS Attribute Mappings
The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.
Show Source
Nested Schema : schema
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 to uniquely identify the GIS attribute. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the GIS attribute is enabled for capture at application intake. The default value is Y for yes. -
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. -
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 : publicSectorGISServices-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The identifier for the public sector agency associated with the GIS map service.
-
CreationDate: string
(date-time)
Read Only:
true
The date and time the GIS map service was created. -
Description: string
Maximum Length:
400
The description of the GIS map service. -
GISAttrMappings: array
GIS Attribute Mappings
Title:
GIS Attribute Mappings
The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake. -
GisServiceId: string
Title:
Map Service ID
Maximum Length:30
The unique identifier of the GIS map service. -
GisServiceLabel: string
Title:
Map Service Name
Maximum Length:100
The user-friendly label of the GIS map service associated with the GIS attribute. -
GISServiceURL: string
Title:
Map Service URL
Maximum Length:300
The URL associated with the GIS map service. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the GIS map service was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : GIS Attribute Mappings
Type:
array
Title:
GIS Attribute Mappings
The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorGISServices-GISAttrMappings-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 to uniquely identify the GIS attribute. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the GIS attribute was created. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the GIS attribute is enabled for capture at application intake. The default value is Y for yes. -
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 when 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.
Links
- GISAttrMappings
-
Parameters:
- publicSectorGISServicesUniqID:
$request.path.publicSectorGISServicesUniqID
The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake. - publicSectorGISServicesUniqID: