Get a map profile
get
/fscmRestApi/resources/11.13.18.05/publicSectorMapProfiles/{publicSectorMapProfilesUniqID}
Request
Path Parameters
-
publicSectorMapProfilesUniqID: integer
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: publicSectorMapProfiles?q=AgencyId=<value1>;MapProfileId=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorMapProfiles-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this document subcategory applies. -
Basemap(optional):
string
Maximum Length:
30
The default type of base map. -
BasemapgalleryEnabled(optional):
string
Maximum Length:
1
Indicates whether users are allowed to switch to a different base map. The default value is N. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the map profile. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the map profile was created. -
GotoInitExtentEnabled(optional):
string
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. The default value is Y. -
InitExtentXmax(optional):
number
The bottom-right X-coordinate of the initial map view extent.
-
InitExtentXmin(optional):
number
The top-left X-coordinate of the initial map view extent.
-
InitExtentYmax(optional):
number
The top-right Y-coordinate of the initial map view extent.
-
InitExtentYmin(optional):
number
The bottom-left Y-coordinate of the initial map view extent.
-
IsDefault(optional):
string
Maximum Length:
1
Indicates whether the map profile is the default map profile. The default value is N. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The user who last modified the map profile. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date and time when the map profile was last modified. -
LayerlistEnabled(optional):
string
Maximum Length:
1
Indicates whether the user is allowed to see the list of layers and switch layer visibility on and off. The default value is N. -
links(optional):
array Items
Title:
Items
Link Relations -
MapimagelayerURL(optional):
string
The URL for your map service.
-
MapProfileId(optional):
string
Maximum Length:
30
The unique identifier for the map profile. -
PopupDockEnabled(optional):
string
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. The default value is N. -
PopupDockPosition(optional):
string
Maximum Length:
30
The position where the map detail window is initially docked. -
SpatialreferenceWkid(optional):
number
The geographic coordinate system or map projection used by the mapping service to display the map.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.