Jump to

• Request
• Response
• Examples

Get All Global Dictionary Key Values

get

/rest/v16/globalDict

This operation returns all the global dictionary key values defined for a site.

Request

Query Parameters

• excludeLinks: string
  Exclude links.
• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should return at a maximum.
• offset: integer
  The offset of the page. By default the offset is 0, which means the first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Criteria to filter the companies. By default no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Global Dict Details

Body ()

Root Schema : Company Details

Type: object

Title: Company Details

Show Source

• count: integer
  Title: count

  Number of the global dict records.
• globalDicts: array globalDicts
• hasMore: boolean
  Title: hasMore

  Has records in other pages.
• limit: integer
  Title: limit

  Number of records per page.
• links: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable
• offset: integer
  Title: offset

  The offset of the page.

{
    "type":"object",
    "properties":{
        "globalDicts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/getGlobalDict-response"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset of the page.",
            "title":"offset"
        },
        "limit":{
            "type":"integer",
            "description":"Number of records per page.",
            "title":"limit"
        },
        "count":{
            "type":"integer",
            "description":"Number of the global dict records.",
            "title":"count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has records in other pages.",
            "title":"hasMore"
        },
        "links":{
            "$ref":"#/definitions/link"
        }
    },
    "title":"Company Details"
}

Nested Schema : globalDicts

Type: array

Show Source

• Array of: object Global Dict Detail
  Title: Global Dict Detail

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/getGlobalDict-response"
    }
}

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
• name: string
• rel: string
  Title: Link Relationship to the current object

  Default Value: self

  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",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested 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"
}

Back to Top

Examples

The following example shows how to retrieve all the key value pairs stored in the global dictionary for a site by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/globalDict

Response Body Sample

{
  "items": [{
      "key": "Key1",
      "value": "ba8643c86eb3443db70bb21b80ef8ba6493fbfa551524bc8d815!-1499002922",
      "minTimeToLive": 1440,
      "dateModified": "2024-03-11T10:41:28.000Z",
      "dateAdded": "2024-03-11T10:41:28.000Z"
    }, {
      "key": "Key2",
      "value": "1c265a45ad7e4b1f91fe3b87561150fa4651bcbbcbfd50fe0378!-1499002922",
      "minTimeToLive": 1440,
      "dateModified": "2024-03-11T10:40:26.000Z",
      "dateAdded": "2024-03-11T10:40:26.000Z"
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 2,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/globalDict"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/globalDict?offset=0&limit=1000"
    }
  ]
}

Back to Top