Jump to

• Request
• Response

Get all GIS map services

get

/fscmRestApi/resources/11.13.18.05/publicSectorGISServices

Request

Query Parameters

• 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the GIS map service using the specified agency ID and GIS Service ID.
    Finder Variables:
    • AgencyId; integer; The identifier for the public sector agency associated with the GIS map service.
    • GisServiceId; string; The unique identifier of the GIS map service.
  • simpleSearchFinder: Finds the GIS map services that match the specified criteria.
    Finder Variables:
    • value; string; The value used to search for GIS map services.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AgencyId; integer; The identifier for the public sector agency associated with the GIS map service.
  • CreationDate; string; The date and time the GIS map service was created.
  • Description; string; The description of the GIS map service.
  • GisServiceId; string; The unique identifier of the GIS map service.
  • GisServiceLabel; string; The user-friendly label of the GIS map service associated with the GIS attribute.
  • LastUpdateDate; string; The date and time the GIS map service was last updated.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorGISServices-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorGISServices-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorGISServices-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-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."
        }
    }
}

Back to Top