Jump to

• Request
• Response

Update a GIS attribute

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRecordGISAttributes/{publicSectorRecordGISAttributesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorRecordGISAttributesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- LnpRecordKey, LocationKey, AttrName and AttrValue ---for the GIS Attributes resource and used to uniquely identify an instance of GIS Attributes. The client should not generate the hash key value. Instead, the client should query on the GIS Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of GIS Attributes.
  
  For example: publicSectorRecordGISAttributes?q=LnpRecordKey=<value1>;LocationKey=<value2>;AttrName=<value3>;AttrValue=<value4>

Body ()

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

Root Schema : publicSectorRecordGISAttributes-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The identifier for the public sector agency associated with the GIS attribute.
• AttrLabel(optional): string
  Maximum Length: 100

  The user-friendly label of the GIS attribute.
• AttrName(optional): string
  Maximum Length: 30

  The name of the GIS attribute.
• AttrValue(optional): string
  Maximum Length: 100

  The value of the GIS attribute.
• CreationDate(optional): string(date-time)
  The date and time when the GIS attribute was created.
• GisServiceId(optional): string
  Maximum Length: 30

  The unique identifier of the GIS map service associated with the GIS attribute.
• GisServiceLabel(optional): string
  Maximum Length: 100

  The user-friendly label of the GIS map service associated with the GIS attribute.
• LastUpdateDate(optional): string(date-time)
  The date and time when the GIS attribute was last updated.
• LayerLabel(optional): string
  Maximum Length: 100

  The user-friendly label of the GIS map service layer associated with the GIS attribute.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the application record associated with the GIS attribute.
• LocationKey(optional): integer(int64)
  The unique identifier of the location associated with the GIS attribute. For example, ParcelKey.
• LocationReference(optional): string
  Maximum Length: 4000

  The description of the location associated with the GIS attribute. For example, the physical address.
• LocationType(optional): string
  Maximum Length: 12

  The type of location associated with the GIS attribute. For example, Parcel.
• OverrideFlag(optional): string
  Maximum Length: 1

  Indicates whether the value was overridden from the original. The default is no.
• PublicVisible(optional): string
  Maximum Length: 1

  Indicates whether the GIS attribute is visible to the public user. The default is no.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The identifier for the public sector agency associated with the GIS attribute.",
            "type":"integer",
            "format":"int64"
        },
        "AttrLabel":{
            "description":"The user-friendly label of the GIS attribute.",
            "type":"string",
            "maxLength":100
        },
        "AttrName":{
            "description":"The name of the GIS attribute.",
            "type":"string",
            "maxLength":30
        },
        "AttrValue":{
            "description":"The value of the GIS attribute.",
            "type":"string",
            "maxLength":100
        },
        "CreationDate":{
            "description":"The date and time when the GIS attribute was created.",
            "type":"string",
            "format":"date-time"
        },
        "GisServiceId":{
            "description":"The unique identifier of the GIS map service associated with the GIS attribute.",
            "type":"string",
            "maxLength":30
        },
        "GisServiceLabel":{
            "description":"The user-friendly label of the GIS map service associated with the GIS attribute.",
            "type":"string",
            "maxLength":100
        },
        "LastUpdateDate":{
            "description":"The date and time when the GIS attribute was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LayerLabel":{
            "description":"The user-friendly label of the GIS map service layer associated with the GIS attribute.",
            "type":"string",
            "maxLength":100
        },
        "LnpRecordKey":{
            "description":"The unique identifier of the application record associated with the GIS attribute.",
            "type":"integer",
            "format":"int64"
        },
        "LocationKey":{
            "description":"The unique identifier of the location associated with the GIS attribute. For example, ParcelKey.",
            "type":"integer",
            "format":"int64"
        },
        "LocationReference":{
            "description":"The description of the location associated with the GIS attribute. For example, the physical address.",
            "type":"string",
            "maxLength":4000
        },
        "LocationType":{
            "description":"The type of location associated with the GIS attribute. For example, Parcel.",
            "type":"string",
            "maxLength":12
        },
        "OverrideFlag":{
            "description":"Indicates whether the value was overridden from the original. The default is no.",
            "type":"string",
            "maxLength":1
        },
        "PublicVisible":{
            "description":"Indicates whether the GIS attribute is visible to the public user. The default is no.",
            "type":"string",
            "maxLength":1
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorRecordGISAttributes-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The identifier for the public sector agency associated with the GIS attribute.
• AttrLabel(optional): string
  Maximum Length: 100

  The user-friendly label of the GIS attribute.
• AttrName(optional): string
  Maximum Length: 30

  The name of the GIS attribute.
• AttrValue(optional): string
  Maximum Length: 100

  The value of the GIS attribute.
• CreationDate(optional): string(date-time)
  The date and time when the GIS attribute was created.
• GisServiceId(optional): string
  Maximum Length: 30

  The unique identifier of the GIS map service associated with the GIS attribute.
• GisServiceLabel(optional): string
  Maximum Length: 100

  The user-friendly label of the GIS map service associated with the GIS attribute.
• LastUpdateDate(optional): string(date-time)
  The date and time when the GIS attribute was last updated.
• LayerLabel(optional): string
  Maximum Length: 100

  The user-friendly label of the GIS map service layer associated with the GIS attribute.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the application record associated with the GIS attribute.
• LocationKey(optional): integer(int64)
  The unique identifier of the location associated with the GIS attribute. For example, ParcelKey.
• LocationReference(optional): string
  Maximum Length: 4000

  The description of the location associated with the GIS attribute. For example, the physical address.
• LocationType(optional): string
  Maximum Length: 12

  The type of location associated with the GIS attribute. For example, Parcel.
• OverrideFlag(optional): string
  Maximum Length: 1

  Indicates whether the value was overridden from the original. The default is no.
• PublicVisible(optional): string
  Maximum Length: 1

  Indicates whether the GIS attribute is visible to the public user. The default is no.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The identifier for the public sector agency associated with the GIS attribute.",
            "type":"integer",
            "format":"int64"
        },
        "AttrLabel":{
            "description":"The user-friendly label of the GIS attribute.",
            "type":"string",
            "maxLength":100
        },
        "AttrName":{
            "description":"The name of the GIS attribute.",
            "type":"string",
            "maxLength":30
        },
        "AttrValue":{
            "description":"The value of the GIS attribute.",
            "type":"string",
            "maxLength":100
        },
        "CreationDate":{
            "description":"The date and time when the GIS attribute was created.",
            "type":"string",
            "format":"date-time"
        },
        "GisServiceId":{
            "description":"The unique identifier of the GIS map service associated with the GIS attribute.",
            "type":"string",
            "maxLength":30
        },
        "GisServiceLabel":{
            "description":"The user-friendly label of the GIS map service associated with the GIS attribute.",
            "type":"string",
            "maxLength":100
        },
        "LastUpdateDate":{
            "description":"The date and time when the GIS attribute was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LayerLabel":{
            "description":"The user-friendly label of the GIS map service layer associated with the GIS attribute.",
            "type":"string",
            "maxLength":100
        },
        "LnpRecordKey":{
            "description":"The unique identifier of the application record associated with the GIS attribute.",
            "type":"integer",
            "format":"int64"
        },
        "LocationKey":{
            "description":"The unique identifier of the location associated with the GIS attribute. For example, ParcelKey.",
            "type":"integer",
            "format":"int64"
        },
        "LocationReference":{
            "description":"The description of the location associated with the GIS attribute. For example, the physical address.",
            "type":"string",
            "maxLength":4000
        },
        "LocationType":{
            "description":"The type of location associated with the GIS attribute. For example, Parcel.",
            "type":"string",
            "maxLength":12
        },
        "OverrideFlag":{
            "description":"Indicates whether the value was overridden from the original. The default is no.",
            "type":"string",
            "maxLength":1
        },
        "PublicVisible":{
            "description":"Indicates whether the GIS attribute is visible to the public user. The default is no.",
            "type":"string",
            "maxLength":1
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top