Jump to

• Request
• Response
• Examples

Get Supported Currency Lookup

get

/rest/v16/pricingSetup/lookups/currencies/{lookupId}

Use this enpoint to retrive the specified supported currency lookup.

Request

Path Parameters

• lookupId(required): string

Query Parameters

• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : CurrencyLookup

Type: object

Show Source

• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• description: string()
  Title: Country Name

  Read Only: true

  The country name
• id: string()
  Title: Id

  Read Only: true

  The unique identifier of the currency.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• lookupCode: string()
  Title: Currency Code

  Read Only: true

  The currency code.
• meaning: string()
  Title: Currency Name

  Read Only: true

  The currency name.
• storedPrecision: integer()
  Title: Stored Precision

  Read Only: true

  Stored precision for the currency.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "storedPrecision":{
            "type":"integer",
            "format":"",
            "description":"Stored precision for the currency.",
            "title":"Stored Precision",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "id":{
            "type":"string",
            "format":"",
            "description":"The unique identifier of the currency.",
            "title":"Id",
            "readOnly":true
        },
        "lookupCode":{
            "type":"string",
            "format":"",
            "description":"The currency code.",
            "title":"Currency Code",
            "readOnly":true
        },
        "meaning":{
            "type":"string",
            "format":"",
            "description":"The currency name.",
            "title":"Currency Name",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The country name",
            "title":"Country Name",
            "readOnly":true
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following examples show how to retrieve a supported currency using the specified lookup Id 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"
https://sitename.oracle.com/rest/v16/pricingSetup/lookups/currencies/5190371

Response Body Sample

{
  "storedPrecision": 2,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/lookups/currencies/5190371"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/lookups/currencies"
    }
  ],
  "id": "5190371",
  "lookupCode": "GBP",
  "meaning": "United Kingdom Pound",
  "description": "United Kingdom"
}

Back to Top