Jump to

• Request
• Response

Get an OAuth setup

get

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

Request

Path Parameters

• publicSectorGISOAuthSetupsUniqID: integer
  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>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorGISOAuthSetups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier for the agency.
• AppId(optional): string
  Maximum Length: 64

  The key value used to retrieve the web map security information.
• AppSecrete(optional): string
  The secret for the application ID. It is stored in the Oracle credential store.
• AuthEndpoint(optional): string
  The URL to request authorization from the user to access the secure web map.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the setup was created.
• Description(optional): string
  Title: Description

  Maximum Length: 400

  The description of the OAuth setup.
• Expiration(optional): integer(int32)
  The number of minutes for which a generated authentication token is valid.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the setup was last modified.
• links(optional): array Items
  Title: Items

  Link Relations
• ResourceId(optional): string
  Maximum Length: 64

  The unique identifier for the OAuth setup.
• TokenEndpoint(optional): string
  The URL to the web map that generates an access token for accessing the secure web map.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier for the agency.",
            "type":"integer",
            "format":"int32"
        },
        "AppId":{
            "description":"The key value used to retrieve the web map security information.",
            "type":"string",
            "maxLength":64
        },
        "AppSecrete":{
            "description":"The secret for the application ID. It is stored in the Oracle credential store.",
            "type":"string"
        },
        "AuthEndpoint":{
            "description":"The URL to request authorization from the user to access the secure web map.",
            "type":"string"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the setup was created.",
            "type":"string",
            "format":"date-time"
        },
        "Description":{
            "title":"Description",
            "description":"The description of the OAuth setup.",
            "type":"string",
            "maxLength":400
        },
        "Expiration":{
            "description":"The number of minutes for which a generated authentication token is valid.",
            "type":"integer",
            "format":"int32"
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the setup was last modified.",
            "type":"string",
            "format":"date-time"
        },
        "ResourceId":{
            "description":"The unique identifier for the OAuth setup.",
            "type":"string",
            "maxLength":64
        },
        "TokenEndpoint":{
            "description":"The URL to the web map that generates an access token for accessing the secure web map.",
            "type":"string"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top