Update a proxy setup
patch
/fscmRestApi/resources/11.13.18.05/publicSectorProxySetups/{publicSectorProxySetupsUniqID}
Request
Path Parameters
-
publicSectorProxySetupsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and ProxyId ---for the Proxy Setups resource and used to uniquely identify an instance of Proxy Setups. The client should not generate the hash key value. Instead, the client should query on the Proxy Setups collection resource with a filter on the primary key values in order to navigate to a specific instance of Proxy Setups.
For example: publicSectorProxySetups?q=AgencyId=<value1>;ProxyId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for the agency.
-
Description: string
Title:
Description
Maximum Length:400
The description of the proxy setup. -
GISServiceLayerURL: string
Title:
GIS Service URL
The base GIS service layer URL that will be accessed using this setup. -
Password: string
Title:
Password
Maximum Length:255
The password that is used to access the secure map service. -
ProxyId: string
Title:
Secure Access ID
Maximum Length:64
The unique identifier for the proxy setup. -
TokenServiceURL: string
Title:
Token Service URL
The token service URL that will be used to generate a token to access secure map services. -
Username: string
Title:
User Name
The user name that is used to access the secure map service.
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.
Root Schema : publicSectorProxySetups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for the agency.
-
CreationDate: string
(date-time)
Read Only:
true
The date and time when the proxy setup was created. -
Description: string
Title:
Description
Maximum Length:400
The description of the proxy setup. -
GISServiceLayerURL: string
Title:
GIS Service URL
The base GIS service layer URL that will be accessed using this setup. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the proxy setup was last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Password: string
Title:
Password
Maximum Length:255
The password that is used to access the secure map service. -
ProxyId: string
Title:
Secure Access ID
Maximum Length:64
The unique identifier for the proxy setup. -
TokenServiceURL: string
Title:
Token Service URL
The token service URL that will be used to generate a token to access secure map services. -
Username: string
Title:
User Name
The user name that is used to access the secure map service.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.