Jump to

• Request
• Response

Create an attribute mapping

post

/fscmRestApi/resources/11.13.18.05/publicSectorApoMappings

Request

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:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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

• AddressLayerPid: string
  Title: Parcel Number in Address Layer

  Maximum Length: 30

  The address layer GIS attribute that provides the unique identifier for each parcel.
• AddressRestURL: string
  Title: Address Layer Service URL

  The URL for the address layer feature service.
• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this GIS attribute mapping applies.
• BoundaryRestURL: string
  Title: Boundary Layer Service URL

  The URL for the boundary layer feature service.
• NeighborhoodRestURL: string
  Title: Neighborhood Group Service URL

  The URL for the neighborhood group layer feature service.
• OwnerLayerPid: string
  Title: Parcel Number in Owner Layer

  Maximum Length: 30

  The owner layer GIS attribute that provides the unique identifier for each parcel.
• OwnerRestURL: string
  Title: Owner Layer Service URL

  The URL for the owner layer feature service.
• ParcelParcelIdEntered: string
  Title: Parcel Number in Parcel Layer

  Maximum Length: 30

  The parcel layer GIS attribute that provides the unique identifier for each parcel.
• ParcelRestURL: string
  Title: Parcel Layer Service URL

  The URL for the parcel layer feature service.
• PrintRestURL: string
  Title: Print Service URL

  The URL for the print service.

{
    "type":"object",
    "properties":{
        "OwnerRestURL":{
            "title":"Owner Layer Service URL",
            "type":"string",
            "description":"The URL for the owner layer feature service.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerLayerPid":{
            "title":"Parcel Number in Owner Layer",
            "maxLength":30,
            "type":"string",
            "description":"The owner layer GIS attribute that provides the unique identifier for each parcel.",
            "nullable":true
        },
        "NeighborhoodRestURL":{
            "title":"Neighborhood Group Service URL",
            "type":"string",
            "description":"The URL for the neighborhood group layer feature service.",
            "nullable":true,
            "x-queryable":false
        },
        "ParcelRestURL":{
            "title":"Parcel Layer Service URL",
            "type":"string",
            "description":"The URL for the parcel layer feature service.",
            "nullable":false,
            "x-queryable":false
        },
        "AddressLayerPid":{
            "title":"Parcel Number in Address Layer",
            "maxLength":30,
            "type":"string",
            "description":"The address layer GIS attribute that provides the unique identifier for each parcel.",
            "nullable":true
        },
        "PrintRestURL":{
            "title":"Print Service URL",
            "type":"string",
            "description":"The URL for the print service.",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this GIS attribute mapping applies.",
            "nullable":false,
            "default":1
        },
        "BoundaryRestURL":{
            "title":"Boundary Layer Service URL",
            "type":"string",
            "description":"The URL for the boundary layer feature service.",
            "nullable":true,
            "x-queryable":false
        },
        "ParcelParcelIdEntered":{
            "title":"Parcel Number in Parcel Layer",
            "maxLength":30,
            "type":"string",
            "description":"The parcel layer GIS attribute that provides the unique identifier for each parcel.",
            "nullable":false
        },
        "AddressRestURL":{
            "title":"Address Layer Service URL",
            "type":"string",
            "description":"The URL for the address layer feature service.",
            "nullable":true,
            "x-queryable":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(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 : publicSectorApoMappings-item-response

Type: object

Show Source

• AddressLayerPid: string
  Title: Parcel Number in Address Layer

  Maximum Length: 30

  The address layer GIS attribute that provides the unique identifier for each parcel.
• AddressRestURL: string
  Title: Address Layer Service URL

  The URL for the address layer feature service.
• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this GIS attribute mapping applies.
• BoundaryRestURL: string
  Title: Boundary Layer Service URL

  The URL for the boundary layer feature service.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the GIS attribute mapping was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the GIS attribute mapping was last modified.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NeighborhoodRestURL: string
  Title: Neighborhood Group Service URL

  The URL for the neighborhood group layer feature service.
• OwnerLayerPid: string
  Title: Parcel Number in Owner Layer

  Maximum Length: 30

  The owner layer GIS attribute that provides the unique identifier for each parcel.
• OwnerRestURL: string
  Title: Owner Layer Service URL

  The URL for the owner layer feature service.
• ParcelParcelIdEntered: string
  Title: Parcel Number in Parcel Layer

  Maximum Length: 30

  The parcel layer GIS attribute that provides the unique identifier for each parcel.
• ParcelRestURL: string
  Title: Parcel Layer Service URL

  The URL for the parcel layer feature service.
• PrintRestURL: string
  Title: Print Service URL

  The URL for the print service.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the GIS attribute mapping was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerLayerPid":{
            "title":"Parcel Number in Owner Layer",
            "maxLength":30,
            "type":"string",
            "description":"The owner layer GIS attribute that provides the unique identifier for each parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "NeighborhoodRestURL":{
            "title":"Neighborhood Group Service URL",
            "type":"string",
            "description":"The URL for the neighborhood group layer feature service.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLayerPid":{
            "title":"Parcel Number in Address Layer",
            "maxLength":30,
            "type":"string",
            "description":"The address layer GIS attribute that provides the unique identifier for each parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "PrintRestURL":{
            "title":"Print Service URL",
            "type":"string",
            "description":"The URL for the print service.",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this GIS attribute mapping applies.",
            "nullable":false,
            "default":1,
            "x-queryable":true
        },
        "ParcelParcelIdEntered":{
            "title":"Parcel Number in Parcel Layer",
            "maxLength":30,
            "type":"string",
            "description":"The parcel layer GIS attribute that provides the unique identifier for each parcel.",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerRestURL":{
            "title":"Owner Layer Service URL",
            "type":"string",
            "description":"The URL for the owner layer feature service.",
            "nullable":true,
            "x-queryable":false
        },
        "ParcelRestURL":{
            "title":"Parcel Layer Service URL",
            "type":"string",
            "description":"The URL for the parcel layer feature service.",
            "nullable":false,
            "x-queryable":false
        },
        "BoundaryRestURL":{
            "title":"Boundary Layer Service URL",
            "type":"string",
            "description":"The URL for the boundary layer feature service.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressRestURL":{
            "title":"Address Layer Service URL",
            "type":"string",
            "description":"The URL for the address layer feature service.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the GIS attribute mapping was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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