Get all map profile references
get
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences
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 reference that matches the primary key criteria specified.
Finder Variables:- AgencyId; integer; The agency identifier of the public sector entity to which this map profile reference applies.
- MapProfileId; string; The unique identifier of the map profile.
- SystemMapProfileId; string; The unique identifier for the map page.
- PrimaryKey: Finds the map profile reference that matches the primary key criteria specified.
-
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.
- BasemapgalleryEnabled; string; Indicates whether users are allowed to switch to a different base map.
- CreationDate; string; The date and time when the map profile reference was created.
- GotoInitExtentEnabled; string; 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; Indicates whether the map profile is the default map profile.
- LastUpdateDate; string; The user who last modified the map profile reference.
- LayerlistEnabled; string; Indicates whether users are allowed to see the list of layers and switch layer visibility on and off.
- MapProfileId; string; The unique identifier for the map profile.
- PopupDockEnabled; string; 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; The position where the map detail window is initially docked.
- PrintEnabledFlag; string; Indicates whether the user is allowed to display the print toolbar and print the map.
- SelectionEnabled; string; Indicates whether the user is allowed to display the drawing toolbar and use the drawing tools to select parcels.
- SketchEnabledFlag; string; Indicates whether the user is allowed to display the sketch toolbar and use the tools to sketch markings on the map.
- SystemMapProfileId; string; The unique identifier for the map page.
- ZoomEnabled; string; Indicates whether the map provides icons that enable users to zoom in and out.
-
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 TopResponse
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.
Root Schema : publicSectorMapProfileReferences
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorMapProfileReferences-item-response
Type:
Show Source
object
-
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 users are 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 icons that enable users to zoom in and out.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : 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.
Nested Schema : publicSectorMapProfileReferences-MapServiceAttributes-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source