Jump to

• Request
• Response

Create a gis to opal mapping

post

/fscmRestApi/resources/11.13.18.05/publicSectorGISApoMappings

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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 ()

Root Schema : schema

Type: object

Show Source

• AgencyId(required): integer (int32)
  The unique identifier of the agency.
• Description(required): string
  Title: Description

  Maximum Length: 400

  Indicates the gis to opal mapping description.
• EnabledFlag(required): string
  Title: Enabled

  Maximum Length: 1

  Indicates if the gis to opal mapping is enabled.
• MappingName(required): string
  Title: Mapping Name

  Maximum Length: 30

  Indicates the gis to opal mapping name.
• MappingUrl(required): string
  Title: Map Service URL

  Maximum Length: 1000

  Indicates the gis to opal map service url.
• XapoMapAttr: array Gis Apo Attribute Mappings
  Title: Gis Apo Attribute Mappings

  This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.

{
    "required":[
        "AgencyId",
        "Description",
        "EnabledFlag",
        "MappingName",
        "MappingUrl"
    ],
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the gis to opal mapping description.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the gis to opal mapping is enabled.",
            "nullable":false
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the gis to opal mapping name.",
            "nullable":false
        },
        "MappingUrl":{
            "title":"Map Service URL",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the gis to opal map service url.",
            "nullable":false
        },
        "XapoMapAttr":{
            "title":"Gis Apo Attribute Mappings",
            "type":"array",
            "description":"This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGISApoMappings-XapoMapAttr-item-post-request"
            }
        }
    }
}

Nested Schema : Gis Apo Attribute Mappings

Type: array

Title: Gis Apo Attribute Mappings

This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.

Show Source

• Array of: object publicSectorGISApoMappings-XapoMapAttr-item-post-request

{
    "title":"Gis Apo Attribute Mappings",
    "type":"array",
    "description":"This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGISApoMappings-XapoMapAttr-item-post-request"
    }
}

Nested Schema : publicSectorGISApoMappings-XapoMapAttr-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier of the agency.
• GisAttrName: string
  Maximum Length: 30

  Indicates the gis attribute name.
• MappingName: string
  Maximum Length: 30

  Indicates the gis to opal mapping name.
• OpalAttrName: string
  Maximum Length: 30

  Indicates the opal attribute name.
• OpalAttrType: string
  Maximum Length: 30

  Indicates the opal attribute type.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "GisAttrName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the gis attribute name.",
            "nullable":false
        },
        "MappingName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the gis to opal mapping name.",
            "nullable":false
        },
        "OpalAttrName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the opal attribute name.",
            "nullable":false
        },
        "OpalAttrType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the opal attribute type.",
            "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 : publicSectorGISApoMappings-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier of the agency.
• Description: string
  Title: Description

  Maximum Length: 400

  Indicates the gis to opal mapping description.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates if the gis to opal mapping is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingName: string
  Title: Mapping Name

  Maximum Length: 30

  Indicates the gis to opal mapping name.
• MappingUrl: string
  Title: Map Service URL

  Maximum Length: 1000

  Indicates the gis to opal map service url.
• XapoMapAttr: array Gis Apo Attribute Mappings
  Title: Gis Apo Attribute Mappings

  This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the gis to opal mapping description.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the gis to opal mapping is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "MappingName":{
            "title":"Mapping Name",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the gis to opal mapping name.",
            "nullable":false,
            "x-queryable":true
        },
        "MappingUrl":{
            "title":"Map Service URL",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the gis to opal map service url.",
            "nullable":false,
            "x-queryable":true
        },
        "XapoMapAttr":{
            "title":"Gis Apo Attribute Mappings",
            "type":"array",
            "description":"This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGISApoMappings-XapoMapAttr-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Gis Apo Attribute Mappings

Type: array

Title: Gis Apo Attribute Mappings

This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.

Show Source

• Array of: object publicSectorGISApoMappings-XapoMapAttr-item-response

{
    "title":"Gis Apo Attribute Mappings",
    "type":"array",
    "description":"This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGISApoMappings-XapoMapAttr-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorGISApoMappings-XapoMapAttr-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier of the agency.
• GisAttrName: string
  Maximum Length: 30

  Indicates the gis attribute name.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingName: string
  Maximum Length: 30

  Indicates the gis to opal mapping name.
• OpalAttrName: string
  Maximum Length: 30

  Indicates the opal attribute name.
• OpalAttrType: string
  Maximum Length: 30

  Indicates the opal attribute type.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "GisAttrName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the gis attribute name.",
            "nullable":false,
            "x-queryable":true
        },
        "MappingName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the gis to opal mapping name.",
            "nullable":false,
            "x-queryable":true
        },
        "OpalAttrName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the opal attribute name.",
            "nullable":false,
            "x-queryable":true
        },
        "OpalAttrType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the opal attribute type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

XapoMapAttr

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorGISApoMappings/{publicSectorGISApoMappingsUniqID}/child/XapoMapAttr

Parameters:

• publicSectorGISApoMappingsUniqID: $request.path.publicSectorGISApoMappingsUniqID

This resource is used to view, create, or modify the gis to opal attributes mapping configuration. An agency can setup the attributes mapping configuration for Parcel, Address, Owner where every attribute from opal is mapped to gis attribute based on the gis layers defined by the user.

Back to Top