Jump to

• Request
• Response

Update a map service attribute configuration

patch

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

Request

Supported Media Types

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

Path Parameters

• MapProfileReferencesUniqID: integer
  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: integer
  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: 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: publicSectorSetupMapProfiles?q=AgencyId=<value1>;MapProfileId=<value2>

Body ()

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

Root Schema : publicSectorSetupMapProfiles-MapProfileReferences-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"
}

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

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

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

Back to Top