Jump to

• Request
• Response

Update an OAuth setup

patch

/fscmRestApi/resources/11.13.18.05/publicSectorGISOAuthSetups/{publicSectorGISOAuthSetupsUniqID}

Request

Path Parameters

• publicSectorGISOAuthSetupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and ResourceId ---for the GIS OAuth Setup resource and used to uniquely identify an instance of GIS OAuth Setup. The client should not generate the hash key value. Instead, the client should query on the GIS OAuth Setup collection resource with a filter on the primary key values in order to navigate to a specific instance of GIS OAuth Setup.
  
  For example: publicSectorGISOAuthSetups?q=AgencyId=<value1>;ResourceId=<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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TokenEndpoint":{
            "title":"OAuth 2 Token URL",
            "type":"string",
            "description":"The URL to the web map that generates an access token for accessing the secure web map.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"400",
            "type":"string",
            "description":"The description of the OAuth setup.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "AppId":{
            "title":"Application ID",
            "maxLength":"64",
            "type":"string",
            "description":"The key value used to retrieve the web map security information.",
            "nullable":false
        },
        "ResourceId":{
            "title":"Secure Access ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier for the OAuth setup.",
            "nullable":false
        },
        "AppSecrete":{
            "title":"Application Secret",
            "type":"string",
            "description":"The secret for the application ID. It is stored in the Oracle credential store.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Expiration":{
            "title":"Expiration in Minutes",
            "type":"integer",
            "description":"The number of minutes for which a generated authentication token is valid.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"8"
            }
        },
        "AuthEndpoint":{
            "title":"OAuth 2 Authorize URL",
            "type":"string",
            "description":"The URL to request authorization from the user to access the secure web map.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":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 : publicSectorGISOAuthSetups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TokenEndpoint":{
            "title":"OAuth 2 Token URL",
            "type":"string",
            "description":"The URL to the web map that generates an access token for accessing the secure web map.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the setup was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"400",
            "type":"string",
            "description":"The description of the OAuth setup.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AppId":{
            "title":"Application ID",
            "maxLength":"64",
            "type":"string",
            "description":"The key value used to retrieve the web map security information.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Secure Access ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier for the OAuth setup.",
            "nullable":false,
            "x-queryable":true
        },
        "AppSecrete":{
            "title":"Application Secret",
            "type":"string",
            "description":"The secret for the application ID. It is stored in the Oracle credential store.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Expiration":{
            "title":"Expiration in Minutes",
            "type":"integer",
            "description":"The number of minutes for which a generated authentication token is valid.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AuthEndpoint":{
            "title":"OAuth 2 Authorize URL",
            "type":"string",
            "description":"The URL to request authorization from the user to access the secure web map.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the setup was last modified.",
            "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