Create a map profile reference

post

/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Map Service Attributes
Type: array
Title: Map Service Attributes
Use the map service attributes resource to view, create, update, and delete map service layer attributes.
Show Source
Nested Schema : publicSectorMapProfileReferences-MapServiceAttributes-item-post-request
Type: object
Show Source
  • Title: Agency ID
    Default Value: 1
    The unique identifier for the agency.
  • Title: Enable Selection
    Maximum Length: 1
    Default Value: false
    Indicates whether the map layer is enabled for selection in the linked map page.
  • Title: Display Attributes
    Maximum Length: 400
    A collection of GIS object attributes to be displayed when the GIS object is selected.
  • Title: Unique Identifiers
    Maximum Length: 200
    A collection of unique identifiers for the GIS objects in the map layer.
  • The unique identifier of the map layer within the map service.
  • Title: Map Layers
    Maximum Length: 100
    The unique identifier for the layer that the map service attributes belong to.
  • Title: Profile ID
    Maximum Length: 30
    The unique identifier for the map profile the map service attributes are linked to.
  • Title: Parcel Layer
    Maximum Length: 1
    Indicates whether the map service attribute is identified as the parcel layer.
  • Title: Map Page
    Maximum Length: 30
    The unique identifier for the map page the map service attributes are linked to.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorMapProfileReferences-item-response
Type: object
Show Source
  • Title: Agency ID
    Default Value: 1
    The agency identifier of the public sector entity to which this map profile applies.
  • Title: Enable Base Map Gallery
    Maximum Length: 1
    Indicates whether users are allowed to switch to a different base map.
  • Title: Creation Date
    Read Only: true
    The date and time when the map profile reference was created.
  • Title: Enable Default Map View
    Maximum Length: 1
    Indicates whether to display the icon for restoring the map to its initial extent. A user who has zoomed or panned the map clicks this icon to restore the default map area.
  • Maximum Length: 1
    Indicates whether the map profile is the default map profile.
  • Title: Last Updated Date
    Read Only: true
    The user who last modified the map profile reference.
  • Title: Enable Map Layers
    Maximum Length: 1
    Indicates whether users are allowed to see the list of layers and switch layer visibility on and off.
  • Links
  • Title: Profile ID
    Maximum Length: 30
    The unique identifier for the map profile.
  • Map Service Attributes
    Title: Map Service Attributes
    Use the map service attributes resource to view, create, update, and delete map service layer attributes.
  • Title: Enable Detail Window Docking
    Maximum Length: 1
    Indicates whether the map detail window is docked to the side of the view. The detail window is the pop-up window that appears when a user clicks a map marker or other GIS feature such as a parcel.
  • Title: Detail Window Dock Position
    Maximum Length: 30
    The position where the map detail window is initially docked.
  • Title: Enable Print
    Maximum Length: 1
    Indicates whether the user is allowed to display the print toolbar and print the map.
  • Title: Enable Selection Tools
    Maximum Length: 1
    Indicates whether the user is allowed to display the drawing toolbar and use the drawing tools to select parcels.
  • Title: Enable Sketch
    Maximum Length: 1
    Indicates whether the user is allowed to display the sketch toolbar and use the tools to sketch markings on the map.
  • Title: Map Page
    Maximum Length: 30
    The unique identifier for the map page.
  • Title: Enable Zoom
    Maximum Length: 1
    Indicates whether the map provides icons that enable users to zoom in and out.
Nested Schema : Map Service Attributes
Type: array
Title: Map Service Attributes
Use the map service attributes resource to view, create, update, and delete map service layer attributes.
Show Source
Nested Schema : publicSectorMapProfileReferences-MapServiceAttributes-item-response
Type: object
Show Source
  • Title: Agency ID
    Default Value: 1
    The unique identifier for the agency.
  • Title: Creation Date
    Read Only: true
    The date and time when the map service attribute configuration was created.
  • Title: Enable Selection
    Maximum Length: 1
    Default Value: false
    Indicates whether the map layer is enabled for selection in the linked map page.
  • Title: Display Attributes
    Maximum Length: 400
    A collection of GIS object attributes to be displayed when the GIS object is selected.
  • Title: Unique Identifiers
    Maximum Length: 200
    A collection of unique identifiers for the GIS objects in the map layer.
  • The unique identifier of the map layer within the map service.
  • Title: Map Layers
    Maximum Length: 100
    The unique identifier for the layer that the map service attributes belong to.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the map service attribute configuration was last updated.
  • Links
  • Title: Profile ID
    Maximum Length: 30
    The unique identifier for the map profile the map service attributes are linked to.
  • Title: Parcel Layer
    Maximum Length: 1
    Indicates whether the map service attribute is identified as the parcel layer.
  • Title: Map Page
    Maximum Length: 30
    The unique identifier for the map page the map service attributes are linked to.
Back to Top