Jump to

• Request
• Response

Create a map profile reference

post

/fscmRestApi/resources/11.13.18.05/publicSectorMapProfileReferences

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorMapProfileReferences-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this map profile applies.
• BasemapgalleryEnabled(optional): string
  Maximum Length: 1

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

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

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

  The user who last modified the map profile reference.
• LayerlistEnabled(optional): string
  Maximum Length: 1

  Indicates whether users are allowed to see the list of layers and switch layer visibility on and off.
• links(optional): array Items
  Title: Items

  Link Relations
• MapProfileId(optional): string
  Maximum Length: 30

  The unique identifier for the map profile.
• MapServiceAttributes(optional): 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(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.
• PopupDockPosition(optional): string
  Maximum Length: 30

  The position where the map detail window is initially docked.
• SelectionEnabled(optional): string
  Maximum Length: 1

  Indicates whether the user is allowed to display the drawing toolbar and use the drawing tools to select parcels.
• SystemMapProfileId(optional): string
  Maximum Length: 30

  The unique identifier for the map page.
• ZoomEnabled(optional): string
  Maximum Length: 1

  Indicates whether the map provides icons that enable users to zoom in and out.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this map profile applies.",
            "title":"Agency ID"
        },
        "BasemapgalleryEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether users are allowed to switch to a different base map."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the map profile reference was created.",
            "title":"Creation Date"
        },
        "GotoInitExtentEnabled":{
            "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."
        },
        "IsDefault":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the map profile is the default map profile."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last modified the map profile reference.",
            "title":"Last Updated Date"
        },
        "LayerlistEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether users are allowed to see the list of layers and switch layer visibility on and off."
        },
        "MapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map profile."
        },
        "MapServiceAttributes":{
            "items":{
                "$ref":"#/definitions/publicSectorMapProfileReferences-MapServiceAttributes-item"
            },
            "type":"array",
            "description":"Use the map service attributes resource to view, create, update, and delete map service layer attributes.",
            "title":"Map Service Attributes"
        },
        "PopupDockEnabled":{
            "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."
        },
        "PopupDockPosition":{
            "maxLength":30,
            "type":"string",
            "description":"The position where the map detail window is initially docked."
        },
        "SelectionEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the user is allowed to display the drawing toolbar and use the drawing tools to select parcels."
        },
        "SystemMapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map page."
        },
        "ZoomEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the map provides icons that enable users to zoom in and out."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

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 publicSectorMapProfileReferences-MapServiceAttributes-item

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

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorMapProfileReferences-MapServiceAttributes-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  The date and time when the map service attribute configuration was created.
• EnableSelectFlag(optional): string
  Maximum Length: 1

  Indicates whether this map layer is enabled for selection in the linked map page.
• GisDisplayAttrNames(optional): string
  Maximum Length: 400

  A collection of GIS object attributes to be displayed when the GIS object is selected.
• GisIdAttrNames(optional): string
  Maximum Length: 200

  A collection of unique identifiers for the GIS objects in the map layer.
• GisLayerId(optional): integer(int32)
  The unique identifier of the map layer within the map service.
• GisLayerName(optional): string
  Maximum Length: 100

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

  The date and time when the map service attribute configuration was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• MapProfileId(optional): string
  Maximum Length: 30

  The unique identifier for the map profile the map service attributes are linked to.
• SystemMapProfileId(optional): string
  Maximum Length: 30

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the map service attribute configuration was created.",
            "title":"Creation Date"
        },
        "EnableSelectFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this map layer is enabled for selection in the linked map page."
        },
        "GisDisplayAttrNames":{
            "maxLength":400,
            "type":"string",
            "description":"A collection of GIS object attributes to be displayed when the GIS object is selected."
        },
        "GisIdAttrNames":{
            "maxLength":200,
            "type":"string",
            "description":"A collection of unique identifiers for the GIS objects in the map layer."
        },
        "GisLayerId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the map layer within the map service."
        },
        "GisLayerName":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the layer that the map service attributes belong to."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the map service attribute configuration was last updated.",
            "title":"Last Updated Date"
        },
        "MapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map profile the map service attributes are linked to."
        },
        "SystemMapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map page the map service attributes are linked to."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorMapProfileReferences-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this map profile applies.
• BasemapgalleryEnabled(optional): string
  Maximum Length: 1

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

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

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

  The user who last modified the map profile reference.
• LayerlistEnabled(optional): string
  Maximum Length: 1

  Indicates whether users are allowed to see the list of layers and switch layer visibility on and off.
• links(optional): array Items
  Title: Items

  Link Relations
• MapProfileId(optional): string
  Maximum Length: 30

  The unique identifier for the map profile.
• MapServiceAttributes(optional): 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(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.
• PopupDockPosition(optional): string
  Maximum Length: 30

  The position where the map detail window is initially docked.
• SelectionEnabled(optional): string
  Maximum Length: 1

  Indicates whether the user is allowed to display the drawing toolbar and use the drawing tools to select parcels.
• SystemMapProfileId(optional): string
  Maximum Length: 30

  The unique identifier for the map page.
• ZoomEnabled(optional): string
  Maximum Length: 1

  Indicates whether the map provides icons that enable users to zoom in and out.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this map profile applies.",
            "title":"Agency ID"
        },
        "BasemapgalleryEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether users are allowed to switch to a different base map."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the map profile reference was created.",
            "title":"Creation Date"
        },
        "GotoInitExtentEnabled":{
            "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."
        },
        "IsDefault":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the map profile is the default map profile."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last modified the map profile reference.",
            "title":"Last Updated Date"
        },
        "LayerlistEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether users are allowed to see the list of layers and switch layer visibility on and off."
        },
        "MapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map profile."
        },
        "MapServiceAttributes":{
            "items":{
                "$ref":"#/definitions/publicSectorMapProfileReferences-MapServiceAttributes-item"
            },
            "type":"array",
            "description":"Use the map service attributes resource to view, create, update, and delete map service layer attributes.",
            "title":"Map Service Attributes"
        },
        "PopupDockEnabled":{
            "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."
        },
        "PopupDockPosition":{
            "maxLength":30,
            "type":"string",
            "description":"The position where the map detail window is initially docked."
        },
        "SelectionEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the user is allowed to display the drawing toolbar and use the drawing tools to select parcels."
        },
        "SystemMapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map page."
        },
        "ZoomEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the map provides icons that enable users to zoom in and out."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

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 publicSectorMapProfileReferences-MapServiceAttributes-item

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

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorMapProfileReferences-MapServiceAttributes-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  The date and time when the map service attribute configuration was created.
• EnableSelectFlag(optional): string
  Maximum Length: 1

  Indicates whether this map layer is enabled for selection in the linked map page.
• GisDisplayAttrNames(optional): string
  Maximum Length: 400

  A collection of GIS object attributes to be displayed when the GIS object is selected.
• GisIdAttrNames(optional): string
  Maximum Length: 200

  A collection of unique identifiers for the GIS objects in the map layer.
• GisLayerId(optional): integer(int32)
  The unique identifier of the map layer within the map service.
• GisLayerName(optional): string
  Maximum Length: 100

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

  The date and time when the map service attribute configuration was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• MapProfileId(optional): string
  Maximum Length: 30

  The unique identifier for the map profile the map service attributes are linked to.
• SystemMapProfileId(optional): string
  Maximum Length: 30

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the map service attribute configuration was created.",
            "title":"Creation Date"
        },
        "EnableSelectFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this map layer is enabled for selection in the linked map page."
        },
        "GisDisplayAttrNames":{
            "maxLength":400,
            "type":"string",
            "description":"A collection of GIS object attributes to be displayed when the GIS object is selected."
        },
        "GisIdAttrNames":{
            "maxLength":200,
            "type":"string",
            "description":"A collection of unique identifiers for the GIS objects in the map layer."
        },
        "GisLayerId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the map layer within the map service."
        },
        "GisLayerName":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the layer that the map service attributes belong to."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the map service attribute configuration was last updated.",
            "title":"Last Updated Date"
        },
        "MapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map profile the map service attributes are linked to."
        },
        "SystemMapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map page the map service attributes are linked to."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top