Jump to

• Request
• Response

Update a GIS attribute

patch

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

Request

Path Parameters

• publicSectorRecordGISAttributesUniqID(required): string
  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>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttrValue: string
  Title: Value

  Maximum Length: 100

  The value of the GIS attribute.
• OverrideFlag: string
  Maximum Length: 1

  Indicates whether the value was overridden from the original. The default is no.

{
    "type":"object",
    "properties":{
        "OverrideFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the value was overridden from the original. The default is no.",
            "nullable":false
        },
        "AttrValue":{
            "title":"Value",
            "maxLength":"100",
            "type":"string",
            "description":"The value of the GIS attribute.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  The identifier for the public sector agency associated with the GIS attribute.
• AttrLabel: string
  Title: Attribute

  Read Only: true

  Maximum Length: 100

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

  The name of the GIS attribute.
• AttrValue: string
  Title: Value

  Maximum Length: 100

  The value of the GIS attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the GIS attribute was created.
• GisServiceId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier of the GIS map service associated with the GIS attribute.
• GisServiceLabel: string
  Title: Map Service

  Read Only: true

  Maximum Length: 100

  The user-friendly label of the GIS map service associated with the GIS attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the GIS attribute was last updated.
• LayerLabel: string
  Title: Layer

  Read Only: true

  Maximum Length: 100

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

  The link relations associated with the resource instance.
• LnpRecordKey: integer (int64)
  The unique identifier of the application record associated with the GIS attribute.
• LocationKey: integer (int64)
  The unique identifier of the location associated with the GIS attribute. For example, ParcelKey.
• LocationReference: string
  Title: Location Reference

  Maximum Length: 4000

  The description of the location associated with the GIS attribute. For example, the physical address.
• LocationType: string
  Title: Location Type

  Maximum Length: 12

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

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

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

{
    "type":"object",
    "properties":{
        "AttrName":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the GIS attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the GIS attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the value was overridden from the original. The default is no.",
            "nullable":false,
            "x-queryable":true
        },
        "AttrLabel":{
            "title":"Attribute",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the GIS attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "LayerLabel":{
            "title":"Layer",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS map service layer associated with the GIS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationReference":{
            "title":"Location Reference",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the location associated with the GIS attribute. For example, the physical address.",
            "nullable":false,
            "x-queryable":true
        },
        "GisServiceLabel":{
            "title":"Map Service",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS map service associated with the GIS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the application record associated with the GIS attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttrValue":{
            "title":"Value",
            "maxLength":"100",
            "type":"string",
            "description":"The value of the GIS attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "GisServiceId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the GIS map service associated with the GIS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PublicVisible":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the GIS attribute is visible to the public user. The default is no.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LocationType":{
            "title":"Location Type",
            "maxLength":"12",
            "type":"string",
            "description":"The type of location associated with the GIS attribute. For example, Parcel.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the GIS attribute was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationKey":{
            "type":"integer",
            "description":"The unique identifier of the location associated with the GIS attribute. For example, ParcelKey.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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