Get a record GIS object
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects/{GisObjKey}
Request
Path Parameters
-
GisObjKey: integer
The unique identifier for the GIS object associated with the record.
-
LnpRecordKey: integer
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRecordQueries-RecordGISObjects-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for a public sector agency.
-
CreationDate(optional):
string(date-time)
The date when the GIS object was created.
-
GeometryJson(optional):
string
The transient geometry string field of a record GIS object, which is the geometry's JSON data from the ESRI GIS server.
-
GisLayerName(optional):
string
Maximum Length:
100
The unique identifier for the layer that the GIS object belongs to. -
GisObjDisplayAttrs(optional):
string
Maximum Length:
4000
The collection of display attributes for the GIS object. -
GisObjIdAttrs(optional):
string
Maximum Length:
2000
The collection of unique identifier attributes for the GIS object. -
GisObjKey(optional):
integer(int64)
The unique identifier for the GIS object associated with the record.
-
LastUpdateDate(optional):
string(date-time)
The date when the GIS object was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Maximum Length:
50
The unique identifier for the application record. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the record associated with the GIS object.
-
ShapeJson(optional):
string
The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.
Nested Schema : link
Type:
Show Source
object
-
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.