Jump to

• Request
• Response

Create a GIS map service

post

/fscmRestApi/resources/11.13.18.05/publicSectorGISServices

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 ()

Root Schema : schema

Type: object

Show Source

• AgencyId(required): integer (int32)
  The identifier for the public sector agency associated with the GIS map service.
• Description: string
  Maximum Length: 400

  The description of the GIS map service.
• GISAttrMappings: array GIS Attribute Mappings
  Title: GIS Attribute Mappings

  The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.
• GisServiceId(required): string
  Title: Map Service ID

  Maximum Length: 30

  The unique identifier of the GIS map service.
• GisServiceLabel(required): string
  Title: Map Service Name

  Maximum Length: 100

  The user-friendly label of the GIS map service associated with the GIS attribute.
• GISServiceURL(required): string
  Title: Map Service URL

  Maximum Length: 300

  The URL associated with the GIS map service.

{
    "required":[
        "AgencyId",
        "GISServiceURL",
        "GisServiceId",
        "GisServiceLabel"
    ],
    "type":"object",
    "properties":{
        "GisServiceId":{
            "title":"Map Service ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the GIS map service.",
            "nullable":false
        },
        "Description":{
            "maxLength":"400",
            "type":"string",
            "description":"The description of the GIS map service.",
            "nullable":true
        },
        "GISServiceURL":{
            "title":"Map Service URL",
            "maxLength":"300",
            "type":"string",
            "description":"The URL associated with the GIS map service.",
            "nullable":false,
            "x-queryable":false
        },
        "GisServiceLabel":{
            "title":"Map Service Name",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS map service associated with the GIS attribute.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the GIS map service.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "GISAttrMappings":{
            "title":"GIS Attribute Mappings",
            "type":"array",
            "description":"The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGISServices-GISAttrMappings-item-post-request"
            }
        }
    }
}

Nested Schema : GIS Attribute Mappings

Type: array

Title: GIS Attribute Mappings

The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.

Show Source

• Array of: object schema

{
    "title":"GIS Attribute Mappings",
    "type":"array",
    "description":"The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGISServices-GISAttrMappings-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

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

  Maximum Length: 100

  The user-friendly label of the GIS attribute.
• AttrLayer: string
  Title: Layer

  Maximum Length: 300

  The GIS map service layer associated with the GIS attribute.
• AttrName: string
  Title: Attribute ID

  Maximum Length: 30

  The name to uniquely identify the GIS attribute.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the GIS attribute is enabled for capture at application intake. The default value is Y for yes.
• GisAttrName: string
  Title: Attribute

  Maximum Length: 30

  The name of the GIS attribute provided by the GIS map service.
• GisAttrType: string
  Maximum Length: 30

  The type of attribute provided by the GIS map service.
• GisServiceId: string
  Title: Map Service ID

  Maximum Length: 30

  The unique identifier of the GIS map service.
• LayerLabel: string
  Title: Layer Label

  Maximum Length: 100

  The user-friendly label of the GIS map service layer associated with the GIS attribute.

{
    "type":"object",
    "properties":{
        "GisServiceId":{
            "title":"Map Service ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the GIS map service.",
            "nullable":false
        },
        "AttrName":{
            "title":"Attribute ID",
            "maxLength":"30",
            "type":"string",
            "description":"The name to uniquely identify the GIS attribute.",
            "nullable":false
        },
        "AttrLayer":{
            "title":"Layer",
            "maxLength":"300",
            "type":"string",
            "description":"The GIS map service layer associated with the GIS attribute.",
            "nullable":false,
            "x-queryable":false
        },
        "AttrLabel":{
            "title":"Attribute Label",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS attribute.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the GIS attribute mapping.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "GisAttrType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of attribute provided by the GIS map service.",
            "nullable":false
        },
        "LayerLabel":{
            "title":"Layer Label",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS map service layer associated with the GIS attribute.",
            "nullable":false
        },
        "GisAttrName":{
            "title":"Attribute",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the GIS attribute provided by the GIS map service.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the GIS attribute is enabled for capture at application intake. The default value is Y for yes.",
            "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 : publicSectorGISServices-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The identifier for the public sector agency associated with the GIS map service.
• CreationDate: string (date-time)
  Read Only: true

  The date and time the GIS map service was created.
• Description: string
  Maximum Length: 400

  The description of the GIS map service.
• GISAttrMappings: array GIS Attribute Mappings
  Title: GIS Attribute Mappings

  The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.
• GisServiceId: string
  Title: Map Service ID

  Maximum Length: 30

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

  Maximum Length: 100

  The user-friendly label of the GIS map service associated with the GIS attribute.
• GISServiceURL: string
  Title: Map Service URL

  Maximum Length: 300

  The URL associated with the GIS map service.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time the GIS map service was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "GisServiceId":{
            "title":"Map Service ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the GIS map service.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the GIS map service was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"400",
            "type":"string",
            "description":"The description of the GIS map service.",
            "nullable":true,
            "x-queryable":true
        },
        "GISServiceURL":{
            "title":"Map Service URL",
            "maxLength":"300",
            "type":"string",
            "description":"The URL associated with the GIS map service.",
            "nullable":false,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the GIS map service.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "GISAttrMappings":{
            "title":"GIS Attribute Mappings",
            "type":"array",
            "description":"The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGISServices-GISAttrMappings-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GisServiceLabel":{
            "title":"Map Service Name",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS map service associated with the GIS attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the GIS map service was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : GIS Attribute Mappings

Type: array

Title: GIS Attribute Mappings

The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.

Show Source

• Array of: object publicSectorGISServices-GISAttrMappings-item-response

{
    "title":"GIS Attribute Mappings",
    "type":"array",
    "description":"The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGISServices-GISAttrMappings-item-response"
    }
}

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 : publicSectorGISServices-GISAttrMappings-item-response

Type: object

Show Source

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

  Maximum Length: 100

  The user-friendly label of the GIS attribute.
• AttrLayer: string
  Title: Layer

  Maximum Length: 300

  The GIS map service layer associated with the GIS attribute.
• AttrName: string
  Title: Attribute ID

  Maximum Length: 30

  The name to uniquely identify the GIS attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the GIS attribute was created.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the GIS attribute is enabled for capture at application intake. The default value is Y for yes.
• GisAttrName: string
  Title: Attribute

  Maximum Length: 30

  The name of the GIS attribute provided by the GIS map service.
• GisAttrType: string
  Maximum Length: 30

  The type of attribute provided by the GIS map service.
• GisServiceId: string
  Title: Map Service ID

  Maximum Length: 30

  The unique identifier of the GIS map service.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  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.

{
    "type":"object",
    "properties":{
        "GisServiceId":{
            "title":"Map Service ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the GIS map service.",
            "nullable":false,
            "x-queryable":true
        },
        "AttrName":{
            "title":"Attribute ID",
            "maxLength":"30",
            "type":"string",
            "description":"The name to uniquely identify the GIS attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttrLayer":{
            "title":"Layer",
            "maxLength":"300",
            "type":"string",
            "description":"The GIS map service layer associated with the GIS attribute.",
            "nullable":false,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the GIS attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttrLabel":{
            "title":"Attribute Label",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the GIS attribute mapping.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "GisAttrType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of attribute provided by the GIS map service.",
            "nullable":false,
            "x-queryable":true
        },
        "LayerLabel":{
            "title":"Layer Label",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly label of the GIS map service layer associated with the GIS attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GisAttrName":{
            "title":"Attribute",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the GIS attribute provided by the GIS map service.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the GIS attribute is enabled for capture at application intake. The default value is Y for yes.",
            "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
        }
    }
}

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

Links

GISAttrMappings

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorGISServices/{publicSectorGISServicesUniqID}/child/GISAttrMappings

Parameters:

• publicSectorGISServicesUniqID: $request.path.publicSectorGISServicesUniqID

The GIS Attribute Mappings resource is used to view, create, delete, or modify all attribute mappings for a given map service that can be selected for capture at application intake.

Back to Top