Create an OAuth setup
post
/fscmRestApi/resources/11.13.18.05/publicSectorGISOAuthSetups
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
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency. -
AppId: string
Title:
Application ID
Maximum Length:64
The key value used to retrieve the web map security information. -
AppSecrete: string
Title:
Application Secret
The secret for the application ID. It is stored in the Oracle credential store. -
AuthEndpoint: string
Title:
OAuth 2 Authorize URL
The URL to request authorization from the user to access the secure web map. -
Description: string
Title:
Description
Maximum Length:400
The description of the OAuth setup. -
Expiration: integer
(int32)
Title:
Expiration in Minutes
The number of minutes for which a generated authentication token is valid. -
ResourceId: string
Title:
Secure Access ID
Maximum Length:64
The unique identifier for the OAuth setup. -
TokenEndpoint: string
Title:
OAuth 2 Token URL
The URL to the web map that generates an access token for accessing the secure web map.
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 : publicSectorGISOAuthSetups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency. -
AppId: string
Title:
Application ID
Maximum Length:64
The key value used to retrieve the web map security information. -
AppSecrete: string
Title:
Application Secret
The secret for the application ID. It is stored in the Oracle credential store. -
AuthEndpoint: string
Title:
OAuth 2 Authorize URL
The URL to request authorization from the user to access the secure web map. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the setup was created. -
Description: string
Title:
Description
Maximum Length:400
The description of the OAuth setup. -
Expiration: integer
(int32)
Title:
Expiration in Minutes
The number of minutes for which a generated authentication token is valid. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the setup was last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceId: string
Title:
Secure Access ID
Maximum Length:64
The unique identifier for the OAuth setup. -
TokenEndpoint: string
Title:
OAuth 2 Token URL
The URL to the web map that generates an access token for accessing the secure web map.
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.