Jump to

• Request
• Response
• Examples

Get a currency

get

/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/{CurrencyCode}

Request

Path Parameters

• CurrencyCode(required): string
  The three-letter code associated with the currency as established by the International Standards Organization.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : preferredCurrenciesLOV-item-response

Type: object

Show Source

• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  The three-letter code associated with the currency as established by the International Standards Organization.
• CurrencyFlag: boolean
  Title: Currency Flag

  Read Only: true

  Maximum Length: 1

  The indicator for whether the currency is a statistical unit.
• CurrencyFormat: string
  Read Only: true

  Maximum Length: 255

  The currency representation format for the currency code.
• CurrencyFormatWithCode: string
  Read Only: true

  Maximum Length: 255

  The currency format code representation for the currency name.
• CurrencyFormatWithSymbol: string
  Read Only: true

  Maximum Length: 255

  The currency format symbol representation for the currency name.
• CurrencyName: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  The name of the currency associated with the row.
• DisplaySequence: integer
  Read Only: true

  The sequence in which the currency details are ordered and displayed.
• EnabledFlag: boolean
  Title: Enabled

  Read Only: true

  Maximum Length: 1

  The indicator for whether the currency is enabled for use. Valid values are YES and NO.
• EndDateActive: string (date)
  Read Only: true

  The date when the preferred currency is no longer active.
• ExtendedPrecision: integer (int32)
  Title: Extended Precision

  Read Only: true

  The number of digits placed after the decimal point that must be greater than or equal to the precision value. Used for calculations requiring greater precision.
• IssuingTerritoryCode: string
  Title: Issuing Territory

  Read Only: true

  Maximum Length: 2

  A unique two-letter code that identifies the territory of the preferred currency.
• LedgerSetId: integer
  The unique identifier of the ledger set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinimumAccountableUnit: number
  Title: Minimum Accountable Unit

  Read Only: true

  The smallest denomination for the currency.
• Name: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  The name of the currency associated with the currency format or currency symbol.
• Precision: integer (int32)
  Title: Precision

  Read Only: true

  The number of digits to the right of the decimal point used in regular currency transactions.
• StartDateActive: string (date)
  Read Only: true

  The date when the preferred currency becomes active.
• Symbol: string
  Title: Symbol

  Read Only: true

  Maximum Length: 12

  A graphic representation used as a shorthand for the name of a currency.

{
    "type":"object",
    "properties":{
        "IssuingTerritoryCode":{
            "title":"Issuing Territory",
            "maxLength":2,
            "type":"string",
            "description":"A unique two-letter code that identifies the territory of the preferred currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The sequence in which the currency details are ordered and displayed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "DisplaySequenceValue"
                ]
            },
            "x-queryable":true
        },
        "MinimumAccountableUnit":{
            "title":"Minimum Accountable Unit",
            "type":"number",
            "description":"The smallest denomination for the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyFormat":{
            "maxLength":255,
            "type":"string",
            "description":"The currency representation format for the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Symbol":{
            "title":"Symbol",
            "maxLength":12,
            "type":"string",
            "description":"A graphic representation used as a shorthand for the name of a currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerSetId":{
            "type":"integer",
            "description":"The unique identifier of the ledger set.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyFlag":{
            "title":"Currency Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator for whether the currency is a statistical unit.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CurrencyName":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the currency associated with the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the currency associated with the currency format or currency symbol.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The three-letter code associated with the currency as established by the International Standards Organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The date when the preferred currency becomes active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "description":"The date when the preferred currency is no longer active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurrencyFormatWithCode":{
            "maxLength":255,
            "type":"string",
            "description":"The currency format code representation for the currency name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Precision":{
            "title":"Precision",
            "type":"integer",
            "description":"The number of digits to the right of the decimal point used in regular currency transactions.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ExtendedPrecision":{
            "title":"Extended Precision",
            "type":"integer",
            "description":"The number of digits placed after the decimal point that must be greater than or equal to the precision value. Used for calculations requiring greater precision.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":2,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"The indicator for whether the currency is enabled for use. Valid values are YES and NO.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CurrencyFormatWithSymbol":{
            "maxLength":255,
            "type":"string",
            "description":"The currency format symbol representation for the currency name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve a currency by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/USD

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "CurrencyCode": "USD",
    "CurrencyName": "US Dollar",
    "CurrencyFlag": true,
    "EnabledFlag": true,
    "DisplaySequence": 1,
    "Precision": 2,
    "MinimumAccountableUnit": null,
    "Symbol": "$",
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/USD",
            "name": "preferredCurrenciesLOV",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/USD",
            "name": "preferredCurrenciesLOV",
            "kind": "item"
        }
    ]
}

Back to Top