Jump to

• Request
• Response
• Examples

Get Global Dictionary Key Value

get

/rest/v19/globalDict/{key}

This operation returns a value stored in the global dictionary corresponding to the given key along with the minTimeToLive value.

Request

Path Parameters

• key(required): string
  Key of the global dictionary.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Global Dictionary Detail

Body ()

Root Schema : Global Dict Detail

Type: object

Title: Global Dict Detail

Show Source

• dateAdded: string
  Title: Date Created

  Creation Date.
• dateModified: string
  Title: Date Last Modified

  Date last modified.
• key: string
  Title: Key

  Name of the key.
• links: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable
• minTimeTolive: integer
  Title: Minimum time to live

  The minimum time, in minutes, the key-value pair is guaranteed to exist in the global dictionary.
• value: string
  Title: Value

  Value associated with the key

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Name of the key.",
            "title":"Key"
        },
        "value":{
            "type":"string",
            "description":"Value associated with the key",
            "title":"Value"
        },
        "minTimeTolive":{
            "type":"integer",
            "description":"The minimum time, in minutes, the key-value pair is guaranteed to exist in the global dictionary.",
            "title":"Minimum time to live"
        },
        "dateModified":{
            "type":"string",
            "description":"Date last modified.",
            "title":"Date Last Modified"
        },
        "dateAdded":{
            "type":"string",
            "description":"Creation Date.",
            "title":"Date Created"
        },
        "links":{
            "$ref":"#/definitions/link"
        }
    },
    "title":"Global Dict Detail"
}

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following example shows how to retrieve a value stored in the global dictionary corresponding to the given key along with the minTimeToLive value by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/globalDict/key1

Response Body Sample

{
  "key": "key1",
  "value": "1",
  "minTimeToLive": 2500,
  "dateModified": "2024-03-11T14:25:11.000Z",
  "dateAdded": "2024-03-11T14:25:11.000Z",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/globalDict/key1"
    }
  ]
}

Back to Top