Jump to

• Request
• Response

Create a map profile

post

/fscmRestApi/resources/11.13.18.05/publicSectorSetupMapProfiles

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 : publicSectorSetupMapProfiles-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.
• Basemap(optional): string
  Maximum Length: 30

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

  Maximum Length: 64

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

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

  Maximum Length: 400

  The description for your map profile.
• InitExtentXmax(optional): number
  The bottom-left Y-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-right X-coordinate of the initial map view extent.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The date and time when the map profile was created.
• links(optional): array Items
  Title: Items

  Link Relations
• MapimagelayerURL(optional): string
  The URL for your map service.
• MapPreview(optional): string(binary)
  The image preview of the map.
• MapProfileId(optional): string
  Maximum Length: 30

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

  Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.
• Name(optional): string
  Maximum Length: 120

  The name for your map profile.
• SpatialreferenceWkid(optional): integer(int32)
  The geographic coordinate system or map projection used by the mapping service to display the map.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this map profile applies.",
            "title":"Agency ID"
        },
        "Basemap":{
            "maxLength":30,
            "type":"string",
            "description":"The default type of base map."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time when the map profile was last modified.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last modified the map profile.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":400,
            "type":"string",
            "description":"The description for your map profile.",
            "title":"Description"
        },
        "InitExtentXmax":{
            "type":"number",
            "description":"The bottom-left Y-coordinate of the initial map view extent."
        },
        "InitExtentXmin":{
            "type":"number",
            "description":"The top-left X-coordinate of the initial map view extent."
        },
        "InitExtentYmax":{
            "type":"number",
            "description":"The top-right Y-coordinate of the initial map view extent."
        },
        "InitExtentYmin":{
            "type":"number",
            "description":"The bottom-right X-coordinate of the initial map view extent."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who created the map profile.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time when the map profile was created.",
            "title":"Last Updated By"
        },
        "MapPreview":{
            "format":"binary",
            "type":"string",
            "description":"The image preview of the map."
        },
        "MapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map profile."
        },
        "MapProfileReferences":{
            "items":{
                "$ref":"#/definitions/publicSectorSetupMapProfiles-MapProfileReferences-item"
            },
            "type":"array",
            "description":"Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.",
            "title":"Map Profile References"
        },
        "MapimagelayerURL":{
            "type":"string",
            "description":"The URL for your map service."
        },
        "Name":{
            "maxLength":120,
            "type":"string",
            "description":"The name for your map profile."
        },
        "SpatialreferenceWkid":{
            "format":"int32",
            "type":"integer",
            "description":"The geographic coordinate system or map projection used by the mapping service to display the map."
        },
        "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 Profile References

Type: array

Title: Map Profile References

Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.

Show Source

• Array of: object publicSectorSetupMapProfiles-MapProfileReferences-item

{
    "items":{
        "$ref":"#/definitions/publicSectorSetupMapProfiles-MapProfileReferences-item"
    },
    "type":"array",
    "description":"Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.",
    "title":"Map Profile References"
}

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 : publicSectorSetupMapProfiles-MapProfileReferences-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.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the map profile reference.
• 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.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The date and time when the map profile reference 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.
• links(optional): array Items
  Title: Items

  Link Relations
• 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.
• 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 + and - icons so the user can 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."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the map profile reference.",
            "title":"Created By"
        },
        "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"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time when the map profile reference was last modified.",
            "title":"Last Updated By"
        },
        "LayerlistEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the user is 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."
        },
        "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 + and -  icons so the user can 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"
}

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 : publicSectorSetupMapProfiles-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.
• Basemap(optional): string
  Maximum Length: 30

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

  Maximum Length: 64

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

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

  Maximum Length: 400

  The description for your map profile.
• InitExtentXmax(optional): number
  The bottom-left Y-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-right X-coordinate of the initial map view extent.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

  The date and time when the map profile was created.
• links(optional): array Items
  Title: Items

  Link Relations
• MapimagelayerURL(optional): string
  The URL for your map service.
• MapPreview(optional): string(binary)
  The image preview of the map.
• MapProfileId(optional): string
  Maximum Length: 30

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

  Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.
• Name(optional): string
  Maximum Length: 120

  The name for your map profile.
• SpatialreferenceWkid(optional): integer(int32)
  The geographic coordinate system or map projection used by the mapping service to display the map.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this map profile applies.",
            "title":"Agency ID"
        },
        "Basemap":{
            "maxLength":30,
            "type":"string",
            "description":"The default type of base map."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time when the map profile was last modified.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last modified the map profile.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":400,
            "type":"string",
            "description":"The description for your map profile.",
            "title":"Description"
        },
        "InitExtentXmax":{
            "type":"number",
            "description":"The bottom-left Y-coordinate of the initial map view extent."
        },
        "InitExtentXmin":{
            "type":"number",
            "description":"The top-left X-coordinate of the initial map view extent."
        },
        "InitExtentYmax":{
            "type":"number",
            "description":"The top-right Y-coordinate of the initial map view extent."
        },
        "InitExtentYmin":{
            "type":"number",
            "description":"The bottom-right X-coordinate of the initial map view extent."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who created the map profile.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time when the map profile was created.",
            "title":"Last Updated By"
        },
        "MapPreview":{
            "format":"binary",
            "type":"string",
            "description":"The image preview of the map."
        },
        "MapProfileId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the map profile."
        },
        "MapProfileReferences":{
            "items":{
                "$ref":"#/definitions/publicSectorSetupMapProfiles-MapProfileReferences-item"
            },
            "type":"array",
            "description":"Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.",
            "title":"Map Profile References"
        },
        "MapimagelayerURL":{
            "type":"string",
            "description":"The URL for your map service."
        },
        "Name":{
            "maxLength":120,
            "type":"string",
            "description":"The name for your map profile."
        },
        "SpatialreferenceWkid":{
            "format":"int32",
            "type":"integer",
            "description":"The geographic coordinate system or map projection used by the mapping service to display the map."
        },
        "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 Profile References

Type: array

Title: Map Profile References

Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.

Show Source

• Array of: object publicSectorSetupMapProfiles-MapProfileReferences-item

{
    "items":{
        "$ref":"#/definitions/publicSectorSetupMapProfiles-MapProfileReferences-item"
    },
    "type":"array",
    "description":"Use the map profiles resource to view, update, create, and delete map profiles. A map profile contains map configuration options that can be applied to one or more maps.",
    "title":"Map Profile References"
}

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 : publicSectorSetupMapProfiles-MapProfileReferences-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.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the map profile reference.
• 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.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The date and time when the map profile reference 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.
• links(optional): array Items
  Title: Items

  Link Relations
• 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.
• 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 + and - icons so the user can 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."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the map profile reference.",
            "title":"Created By"
        },
        "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"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time when the map profile reference was last modified.",
            "title":"Last Updated By"
        },
        "LayerlistEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the user is 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."
        },
        "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 + and -  icons so the user can 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"
}

Back to Top