Jump to

• Request
• Response

Create a record GIS object

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjects

Request

Path Parameters

• LnpRecordKey(required): 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.

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• GeometryJson: string (byte)
  The transient geometry string field of a record GIS object, which is the geometry's JSON data from the ESRI GIS server.
• GisLayerName: string
  Maximum Length: 100

  The unique identifier for the layer that the GIS object belongs to.
• GisObjDisplayAttrs: string
  Maximum Length: 4000

  The collection of display attributes for the GIS object.
• GisObjIdAttrs: string
  Maximum Length: 2000

  The collection of unique identifier attributes for the GIS object.
• GisObjKey: integer (int64)
  The unique identifier for the GIS object associated with the record.
• LnpRecordId: string
  Maximum Length: 50

  The unique identifier for the application record.
• LnpRecordKey: integer (int64)
  The unique identifier for the record associated with the GIS object.
• Shape: object Shape
  The Oracle spatial field of a record parcel, which is the storage field for shape data.
• ShapeJson: string
  The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.

{
    "type":"object",
    "properties":{
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the application record.",
            "nullable":false
        },
        "ShapeJson":{
            "type":"string",
            "description":"The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.",
            "nullable":true,
            "x-queryable":false
        },
        "GisLayerName":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the layer that the GIS object belongs to.",
            "nullable":false
        },
        "Shape":{
            "type":"object",
            "description":"The Oracle spatial field of a record parcel, which is the storage field for shape data.",
            "nullable":true,
            "x-queryable":false
        },
        "GeometryJson":{
            "type":"string",
            "description":"The transient geometry string field of a record GIS object, which is the geometry's JSON data from the ESRI GIS server.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "GisObjDisplayAttrs":{
            "maxLength":4000,
            "type":"string",
            "description":"The collection of display attributes for the GIS object.",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record associated with the GIS object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "GisObjKey":{
            "type":"integer",
            "description":"The unique identifier for the GIS object associated with the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "GisObjIdAttrs":{
            "maxLength":2000,
            "type":"string",
            "description":"The collection of unique identifier attributes for the GIS object.",
            "nullable":false
        }
    }
}

Nested Schema : Shape

Type: object

The Oracle spatial field of a record parcel, which is the storage field for shape data.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorRecordQueries-RecordGISObjects-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for a public sector agency.
• CreationDate: string (date-time)
  Read Only: true

  The date when the GIS object was created.
• GeometryJson: string (byte)
  The transient geometry string field of a record GIS object, which is the geometry's JSON data from the ESRI GIS server.
• GisLayerName: string
  Maximum Length: 100

  The unique identifier for the layer that the GIS object belongs to.
• GisObjDisplayAttrs: string
  Maximum Length: 4000

  The collection of display attributes for the GIS object.
• GisObjIdAttrs: string
  Maximum Length: 2000

  The collection of unique identifier attributes for the GIS object.
• GisObjKey: integer (int64)
  The unique identifier for the GIS object associated with the record.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the GIS object was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Maximum Length: 50

  The unique identifier for the application record.
• LnpRecordKey: integer (int64)
  The unique identifier for the record associated with the GIS object.
• Shape: object Shape
  The Oracle spatial field of a record parcel, which is the storage field for shape data.
• ShapeJson: string
  The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the GIS object was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the application record.",
            "nullable":false,
            "x-queryable":true
        },
        "GisLayerName":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the layer that the GIS object belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "Shape":{
            "type":"object",
            "description":"The Oracle spatial field of a record parcel, which is the storage field for shape data.",
            "nullable":true,
            "x-queryable":false
        },
        "GeometryJson":{
            "type":"string",
            "description":"The transient geometry string field of a record GIS object, which is the geometry's JSON data from the ESRI GIS server.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record associated with the GIS object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShapeJson":{
            "type":"string",
            "description":"The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.",
            "nullable":true,
            "x-queryable":false
        },
        "GisObjDisplayAttrs":{
            "maxLength":4000,
            "type":"string",
            "description":"The collection of display attributes for the GIS object.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GisObjKey":{
            "type":"integer",
            "description":"The unique identifier for the GIS object associated with the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the GIS object was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GisObjIdAttrs":{
            "maxLength":2000,
            "type":"string",
            "description":"The collection of unique identifier attributes for the GIS object.",
            "nullable":false,
            "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 : Shape

Type: object

The Oracle spatial field of a record parcel, which is the storage field for shape data.

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