Jump to

• Request
• Response

Get a map service attribute configuration

get

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

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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-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"
    }
}

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."
        }
    }
}

Back to Top