Jump to

• Request
• Response

Update a map profile reference

patch

/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}

Request

Path Parameters

• MapProfileReferencesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, MapProfileId and SystemMapProfileId ---for the Map Profile References resource and used to uniquely identify an instance of Map Profile References. The client should not generate the hash key value. Instead, the client should query on the Map Profile References collection resource with a filter on the primary key values in order to navigate to a specific instance of Map Profile References.
  
  For example: MapProfileReferences?q=AgencyId=<value1>;MapProfileId=<value2>;SystemMapProfileId=<value3>
• publicSectorSetupMapProfilesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and MapProfileId ---for the Map Profiles resource and used to uniquely identify an instance of Map Profiles. The client should not generate the hash key value. Instead, the client should query on the Map Profiles collection resource with a filter on the primary key values in order to navigate to a specific instance of Map Profiles.
  
  For example: publicSectorSetupMapProfiles?q=AgencyId=<value1>;MapProfileId=<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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BasemapgalleryEnabled: string
  Title: Enable Base Map Gallery

  Maximum Length: 1

  Indicates whether users are allowed to switch to a different base map.
• GotoInitExtentEnabled: string
  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.
• IsDefault: string
  Maximum Length: 1

  Indicates whether the map profile is the default map profile.
• LayerlistEnabled: string
  Title: Enable Map Layers

  Maximum Length: 1

  Indicates whether the user is allowed to see the list of layers and switch layer visibility on and off.
• MapServiceAttributes: array Map Service Attributes
  Title: Map Service Attributes

  Use the map service attributes resource to view, create, update, and delete map service layer attributes.
• PopupDockEnabled: string
  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.
• PopupDockPosition: string
  Title: Detail Window Dock Position

  Maximum Length: 30

  The position where the map detail window is initially docked.
• PrintEnabledFlag: string
  Title: Enable Print

  Maximum Length: 1

  Indicates whether the user is allowed to display the print toolbar and print the map.
• SelectionEnabled: string
  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.
• SketchEnabledFlag: string
  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.
• ZoomEnabled: string
  Title: Enable Zoom

  Maximum Length: 1

  Indicates whether the map provides + and - icons so the user can zoom in and out.

{
    "type":"object",
    "properties":{
        "IsDefault":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the map profile is the default map profile.",
            "nullable":false
        },
        "BasemapgalleryEnabled":{
            "title":"Enable Base Map Gallery",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether users are allowed to switch to a different base map.",
            "nullable":false
        },
        "PopupDockPosition":{
            "title":"Detail Window Dock Position",
            "maxLength":"30",
            "type":"string",
            "description":"The position where the map detail window is initially docked.",
            "nullable":false
        },
        "SelectionEnabled":{
            "title":"Enable Selection Tools",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the user is allowed to display the drawing toolbar and use the drawing tools to select parcels.",
            "nullable":false
        },
        "SketchEnabledFlag":{
            "title":"Enable Sketch",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the user is allowed to display the sketch toolbar and use the tools to sketch markings on the map.",
            "nullable":false
        },
        "GotoInitExtentEnabled":{
            "title":"Enable Default Map View",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "LayerlistEnabled":{
            "title":"Enable Map Layers",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the user is allowed to see the list of layers and switch layer visibility on and off.",
            "nullable":false
        },
        "MapServiceAttributes":{
            "title":"Map Service Attributes",
            "type":"array",
            "description":"Use the map service attributes resource to view, create, update, and delete map service layer attributes.",
            "items":{
                "$ref":"#/components/schemas/publicSectorSetupMapProfiles-MapProfileReferences-MapServiceAttributes-item-patch-request"
            }
        },
        "PopupDockEnabled":{
            "title":"Enable Detail Window Docking",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "ZoomEnabled":{
            "title":"Enable Zoom",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the map provides + and -  icons so the user can zoom in and out.",
            "nullable":false
        },
        "PrintEnabledFlag":{
            "title":"Enable Print",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the user is allowed to display the print toolbar and print the map.",
            "nullable":false
        }
    }
}

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

• Array of: object publicSectorSetupMapProfiles-MapProfileReferences-MapServiceAttributes-item-patch-request

{
    "title":"Map Service Attributes",
    "type":"array",
    "description":"Use the map service attributes resource to view, create, update, and delete map service layer attributes.",
    "items":{
        "$ref":"#/components/schemas/publicSectorSetupMapProfiles-MapProfileReferences-MapServiceAttributes-item-patch-request"
    }
}

Nested Schema : publicSectorSetupMapProfiles-MapProfileReferences-MapServiceAttributes-item-patch-request

Type: object

Show Source

• EnableSelectFlag: boolean
  Title: Enable Selection

  Maximum Length: 1

  Default Value: false

  Indicates whether the map layer is enabled for selection in the linked map page.
• GisDisplayAttrNames: string
  Title: Display Attributes

  Maximum Length: 400

  A collection of GIS object attributes to be displayed when the GIS object is selected.
• GisIdAttrNames: string
  Title: Unique Identifiers

  Maximum Length: 200

  A collection of unique identifiers for the GIS objects in the map layer.
• ParcelLayerFlag: string
  Title: Parcel Layer

  Maximum Length: 1

  Indicates whether the map service attribute is identified as the parcel layer.

{
    "type":"object",
    "properties":{
        "GisDisplayAttrNames":{
            "title":"Display Attributes",
            "maxLength":"400",
            "type":"string",
            "description":"A collection of GIS object attributes to be displayed when the GIS object is selected.",
            "nullable":true
        },
        "GisIdAttrNames":{
            "title":"Unique Identifiers",
            "maxLength":"200",
            "type":"string",
            "description":"A collection of unique identifiers for the GIS objects in the map layer.",
            "nullable":true
        },
        "EnableSelectFlag":{
            "title":"Enable Selection",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the map layer is enabled for selection in the linked map page.",
            "nullable":false,
            "default":false
        },
        "ParcelLayerFlag":{
            "title":"Parcel Layer",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the map service attribute is identified as the parcel layer.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorSetupMapProfiles-MapProfileReferences-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this map profile applies.
• BasemapgalleryEnabled: string
  Title: Enable Base Map Gallery

  Maximum Length: 1

  Indicates whether users are allowed to switch to a different base map.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the map profile reference was created.
• GotoInitExtentEnabled: string
  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.
• IsDefault: string
  Maximum Length: 1

  Indicates whether the map profile is the default map profile.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last modified the map profile reference.
• LayerlistEnabled: string
  Title: Enable Map Layers

  Maximum Length: 1

  Indicates whether the user is allowed to see the list of layers and switch layer visibility on and off.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MapProfileId: string
  Title: Profile ID

  Maximum Length: 30

  The unique identifier for the map profile.
• MapServiceAttributes: array Map Service Attributes
  Title: Map Service Attributes

  Use the map service attributes resource to view, create, update, and delete map service layer attributes.
• PopupDockEnabled: string
  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.
• PopupDockPosition: string
  Title: Detail Window Dock Position

  Maximum Length: 30

  The position where the map detail window is initially docked.
• PrintEnabledFlag: string
  Title: Enable Print

  Maximum Length: 1

  Indicates whether the user is allowed to display the print toolbar and print the map.
• SelectionEnabled: string
  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.
• SketchEnabledFlag: string
  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.
• SystemMapProfileId: string
  Title: Map Page

  Maximum Length: 30

  The unique identifier for the map page.
• ZoomEnabled: string
  Title: Enable Zoom

  Maximum Length: 1

  Indicates whether the map provides + and - icons so the user can zoom in and out.

{
    "type":"object",
    "properties":{
        "IsDefault":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the map profile is the default map profile.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the map profile reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PopupDockPosition":{
            "title":"Detail Window Dock Position",
            "maxLength":"30",
            "type":"string",
            "description":"The position where the map detail window is initially docked.",
            "nullable":false,
            "x-queryable":true
        },
        "SketchEnabledFlag":{
            "title":"Enable Sketch",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the user is allowed to display the sketch toolbar and use the tools to sketch markings on the map.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this map profile applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SystemMapProfileId":{
            "title":"Map Page",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the map page.",
            "nullable":true,
            "x-queryable":true
        },
        "LayerlistEnabled":{
            "title":"Enable Map Layers",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the user is allowed to see the list of layers and switch layer visibility on and off.",
            "nullable":false,
            "x-queryable":true
        },
        "PopupDockEnabled":{
            "title":"Enable Detail Window Docking",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "BasemapgalleryEnabled":{
            "title":"Enable Base Map Gallery",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether users are allowed to switch to a different base map.",
            "nullable":false,
            "x-queryable":true
        },
        "SelectionEnabled":{
            "title":"Enable Selection Tools",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the user is allowed to display the drawing toolbar and use the drawing tools to select parcels.",
            "nullable":false,
            "x-queryable":true
        },
        "MapProfileId":{
            "title":"Profile ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the map profile.",
            "nullable":false,
            "x-queryable":true
        },
        "GotoInitExtentEnabled":{
            "title":"Enable Default Map View",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "MapServiceAttributes":{
            "title":"Map Service Attributes",
            "type":"array",
            "description":"Use the map service attributes resource to view, create, update, and delete map service layer attributes.",
            "items":{
                "$ref":"#/components/schemas/publicSectorSetupMapProfiles-MapProfileReferences-MapServiceAttributes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ZoomEnabled":{
            "title":"Enable Zoom",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the map provides + and -  icons so the user can zoom in and out.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last modified the map profile reference.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrintEnabledFlag":{
            "title":"Enable Print",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the user is allowed to display the print toolbar and print the map.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object publicSectorSetupMapProfiles-MapProfileReferences-MapServiceAttributes-item-response

{
    "title":"Map Service Attributes",
    "type":"array",
    "description":"Use the map service attributes resource to view, create, update, and delete map service layer attributes.",
    "items":{
        "$ref":"#/components/schemas/publicSectorSetupMapProfiles-MapProfileReferences-MapServiceAttributes-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorSetupMapProfiles-MapProfileReferences-MapServiceAttributes-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for the agency.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the map service attribute configuration was created.
• EnableSelectFlag: boolean
  Title: Enable Selection

  Maximum Length: 1

  Default Value: false

  Indicates whether the map layer is enabled for selection in the linked map page.
• GisDisplayAttrNames: string
  Title: Display Attributes

  Maximum Length: 400

  A collection of GIS object attributes to be displayed when the GIS object is selected.
• GisIdAttrNames: string
  Title: Unique Identifiers

  Maximum Length: 200

  A collection of unique identifiers for the GIS objects in the map layer.
• GisLayerId: integer (int32)
  The unique identifier of the map layer within the map service.
• GisLayerName: string
  Title: Map Layers

  Maximum Length: 100

  The unique identifier for the layer that the map service attributes belong to.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the map service attribute configuration was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MapProfileId: string
  Title: Profile ID

  Maximum Length: 30

  The unique identifier for the map profile the map service attributes are linked to.
• ParcelLayerFlag: string
  Title: Parcel Layer

  Maximum Length: 1

  Indicates whether the map service attribute is identified as the parcel layer.
• SystemMapProfileId: string
  Title: Map Page

  Maximum Length: 30

  The unique identifier for the map page the map service attributes are linked to.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the map service attribute configuration was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GisLayerName":{
            "title":"Map Layers",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier for the layer that the map service attributes belong to.",
            "nullable":false,
            "x-queryable":true
        },
        "GisDisplayAttrNames":{
            "title":"Display Attributes",
            "maxLength":"400",
            "type":"string",
            "description":"A collection of GIS object attributes to be displayed when the GIS object is selected.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "MapProfileId":{
            "title":"Profile ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the map profile the map service attributes are linked to.",
            "nullable":false,
            "x-queryable":true
        },
        "GisLayerId":{
            "type":"integer",
            "description":"The unique identifier of the map layer within the map service.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "EnableSelectFlag":{
            "title":"Enable Selection",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the map layer is enabled for selection in the linked map page.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SystemMapProfileId":{
            "title":"Map Page",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the map page the map service attributes are linked to.",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelLayerFlag":{
            "title":"Parcel Layer",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the map service attribute is identified as the parcel layer.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GisIdAttrNames":{
            "title":"Unique Identifiers",
            "maxLength":"200",
            "type":"string",
            "description":"A collection of unique identifiers for the GIS objects in the map layer.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the map service attribute configuration was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

MapServiceAttributes

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles/{publicSectorSetupMapProfilesUniqID}/child/MapProfileReferences/{MapProfileReferencesUniqID}/child/MapServiceAttributes

Parameters:

• MapProfileReferencesUniqID: $request.path.MapProfileReferencesUniqID
• publicSectorSetupMapProfilesUniqID: $request.path.publicSectorSetupMapProfilesUniqID

Use the map service attributes resource to view, create, update, and delete map service layer attributes.

Back to Top