Jump to

• Request
• Response

Create an OAuth setup

post

/fscmRestApi/resources/11.13.18.05/publicSectorGISOAuthSetups

Request

Supported Media Types

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

Body ()

The following table describes the body parameters in the request for this task.

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.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top