Jump to

• Request
• Response

Read Currencies

get

/currency

Reads Currency objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<Currency>

Type: array

Title: List<Currency>

Show Source

• Array of: object Currency
  Title: Currency

  Currency Entity

{
    "title":"List<Currency>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Currency"
    }
}

Nested Schema : Currency

Type: object

Title: Currency

Currency Entity

Show Source

• CreateDate: string (date-time)
  The date this currency was created.
• CreateUser: string
  The name of the user that created this currency.
• DecimalPlaces: integer (int32)
  The number of decimal places displayed.
• DecimalSymbol: string
  The decimal symbol displayed.
• DigitGroupingSymbol: string
  The symbol used to group the numbers.
• ExchangeRate: number (double)
  The exchange rate against the base currency.
• Id(required): string
  The unique currency abbreviation for each currency.
• IsBaseCurrency: boolean
  The currency used to store cost in the Project Management database. The exchange rate for the base currency is always 1.0. The base currency ID, name, and symbol default to U.S. dollars and can be edited but never deleted.
• LastUpdateDate: string (date-time)
  The date this currency was last updated.
• LastUpdateUser: string
  The name of the user that last updated this currency.
• Name(required): string
  The name of the currency.
• NegativeSymbol: string
  The symbol used to display a negative currency.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• PositiveSymbol: string
  The symbol used to display a positive currency.
• Symbol(required): string
  The currency symbol displayed.

{
    "title":"Currency",
    "required":[
        "Id",
        "Name",
        "Symbol"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this currency was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this currency."
        },
        "DecimalPlaces":{
            "type":"integer",
            "description":"The number of decimal places displayed.",
            "format":"int32"
        },
        "DecimalSymbol":{
            "type":"string",
            "description":"The decimal symbol displayed."
        },
        "DigitGroupingSymbol":{
            "type":"string",
            "description":"The symbol used to group the numbers."
        },
        "ExchangeRate":{
            "type":"number",
            "description":"The exchange rate against the base currency.",
            "format":"double"
        },
        "Id":{
            "type":"string",
            "description":"The unique currency abbreviation for each currency."
        },
        "IsBaseCurrency":{
            "type":"boolean",
            "description":"The currency used to store cost in the Project Management database. The exchange rate for the base currency is always 1.0. The base currency ID, name, and symbol default to U.S. dollars and can be edited but never deleted."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this currency was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this currency."
        },
        "Name":{
            "type":"string",
            "description":"The name of the currency."
        },
        "NegativeSymbol":{
            "type":"string",
            "description":"The symbol used to display a negative currency."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "PositiveSymbol":{
            "type":"string",
            "description":"The symbol used to display a positive currency."
        },
        "Symbol":{
            "type":"string",
            "description":"The currency symbol displayed."
        }
    },
    "description":"Currency Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top