Jump to

• Request
• Response

Get all map profiles

get

/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the map profile that matches the primary key criteria specified.
    Finder Variables:
    • AgencyId; integer; The agency identifier of the public sector entity to which this map profile applies.
    • MapProfileId; string; The unique identifier of the map profile.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AgencyId; integer; The agency identifier of the public sector entity to which this map profile applies.
  • Basemap; string; The default type of base map.
  • CreatedBy; string; The date and time when the map profile was last modified.
  • CreationDate; string; The user who last modified the map profile.
  • Description; string; The description for your map profile.
  • InitExtentXmax; number; The bottom-left Y-coordinate of the initial map view extent.
  • InitExtentXmin; number; The top-left X-coordinate of the initial map view extent.
  • InitExtentYmax; number; The top-right Y-coordinate of the initial map view extent.
  • InitExtentYmin; number; The bottom-right X-coordinate of the initial map view extent.
  • LastUpdateDate; string; The user who created the map profile.
  • LastUpdatedBy; string; The date and time when the map profile was created.
  • MapProfileId; string; The unique identifier for the map profile.
  • MapProfileUser; string; Indicates whether the map profile is used for agency users, public users, or all users.
  • Name; string; The name for your map profile.
  • SecuredWebMapFlag; string; Indicates whether authorization is required to use the map service.
  • SpatialreferenceWkid; integer; The geographic coordinate system or map projection used by the mapping service to display the map.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorSetupMapProfiles-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"CommonSetup",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorSetupMapProfiles-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorSetupMapProfiles-item-response"
    }
}

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 : publicSectorSetupMapProfiles-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.
• Basemap: string
  Title: Base Map

  Maximum Length: 30

  The default type of base map.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The date and time when the map profile was last modified.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The user who last modified the map profile.
• Description: string
  Title: Description

  Maximum Length: 400

  The description for your map profile.
• InitExtentXmax: number
  Title: X-Max of Default Map View

  The bottom-left Y-coordinate of the initial map view extent.
• InitExtentXmin: number
  Title: X-Min of Default Map View

  The top-left X-coordinate of the initial map view extent.
• InitExtentYmax: number
  Title: Y-Max of Default Map View

  The top-right Y-coordinate of the initial map view extent.
• InitExtentYmin: number
  Title: Y-Min of Default Map View

  The bottom-right X-coordinate of the initial map view extent.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who created the map profile.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date and time when the map profile was created.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MapimagelayerURL: string
  Title: Map Service URL

  The URL for your map service.
• MapPreview: string (byte)
  Title: Map Preview

  The image preview of the map.
• MapProfileId: string
  Title: Profile ID

  Maximum Length: 30

  The unique identifier for the map profile.
• MapProfileReferences: array Map Profile References
  Title: Map Profile References

  Use map profile references to view, update, create, and delete map profile references. A map profile reference associates a map profile with a map and includes additional map configuration options that are specific to the individual map.
• MapProfileUser: string
  Title: Map Profile Users

  Maximum Length: 30

  Indicates whether the map profile is used for agency users, public users, or all users.
• Name: string
  Title: Profile Name

  Maximum Length: 120

  The name for your map profile.
• PrintRestURL: string
  Title: Print Service URL

  The URL for the print service.
• SecuredWebMapFlag: string
  Title: Authorization Required

  Maximum Length: 1

  Indicates whether authorization is required to use the map service.
• SpatialreferenceWkid: integer (int32)
  Title: Spatial Reference

  The geographic coordinate system or map projection used by the mapping service to display the map.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date and time when the map profile was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The user who last modified the map profile.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InitExtentXmax":{
            "title":"X-Max of Default Map View",
            "type":"number",
            "description":"The bottom-left Y-coordinate of the initial map view extent.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The date and time when the map profile was last modified.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"400",
            "type":"string",
            "description":"The description for your map profile.",
            "nullable":false,
            "x-queryable":true
        },
        "PrintRestURL":{
            "title":"Print Service URL",
            "type":"string",
            "description":"The URL for the print service.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "MapPreview":{
            "title":"Map Preview",
            "type":"string",
            "description":"The image preview of the map.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MapimagelayerURL":{
            "title":"Map Service URL",
            "type":"string",
            "description":"The URL for your map service.",
            "nullable":true,
            "x-queryable":false
        },
        "MapProfileUser":{
            "title":"Map Profile Users",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the map profile is used for agency users, public users, or all users.",
            "nullable":false,
            "x-queryable":true
        },
        "InitExtentYmax":{
            "title":"Y-Max of Default Map View",
            "type":"number",
            "description":"The top-right Y-coordinate of the initial map view extent.",
            "nullable":false,
            "x-queryable":true
        },
        "Basemap":{
            "title":"Base Map",
            "maxLength":"30",
            "type":"string",
            "description":"The default type of base map.",
            "nullable":false,
            "x-queryable":true
        },
        "SpatialreferenceWkid":{
            "title":"Spatial Reference",
            "type":"integer",
            "description":"The geographic coordinate system or map projection used by the mapping service to display the map.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Profile Name",
            "maxLength":"120",
            "type":"string",
            "description":"The name for your map profile.",
            "nullable":false,
            "x-queryable":true
        },
        "InitExtentXmin":{
            "title":"X-Min of Default Map View",
            "type":"number",
            "description":"The top-left X-coordinate of the initial map view extent.",
            "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
        },
        "SecuredWebMapFlag":{
            "title":"Authorization Required",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether authorization is required to use the map service.",
            "nullable":false,
            "x-queryable":true
        },
        "MapProfileReferences":{
            "title":"Map Profile References",
            "type":"array",
            "description":"Use map profile references to view, update, create, and delete map profile references. A map profile reference associates a map profile with a map and includes additional map configuration options that are specific to the individual map.",
            "items":{
                "$ref":"#/components/schemas/publicSectorSetupMapProfiles-MapProfileReferences-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InitExtentYmin":{
            "title":"Y-Min of Default Map View",
            "type":"number",
            "description":"The bottom-right X-coordinate of the initial map view extent.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who created the map profile.",
            "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"
    }
}

Nested Schema : Map Profile References

Type: array

Title: Map Profile References

Use map profile references to view, update, create, and delete map profile references. A map profile reference associates a map profile with a map and includes additional map configuration options that are specific to the individual map.

Show Source

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

{
    "title":"Map Profile References",
    "type":"array",
    "description":"Use map profile references to view, update, create, and delete map profile references. A map profile reference associates a map profile with a map and includes additional map configuration options that are specific to the individual map.",
    "items":{
        "$ref":"#/components/schemas/publicSectorSetupMapProfiles-MapProfileReferences-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-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 : 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"
    }
}

Back to Top