Jump to

• Request
• Response

Get Values

get

/tipInventories/{gtmTipInventoryGid}/values

Request

Path Parameters

• gtmTipInventoryGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tipInventories.values"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object tipInventories.values

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tipInventories.values"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : tipInventories.values

Type: object

Show Source

• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency converions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• gtmValueQualifierGid: string
  The GID of the value qualifier on the GTM Trade Incentive Program
• links: array links
  Read Only: true
• value: value
  Currency value of the GTM Trade Incentive Program
• valueNote: string
  A note that shows how the value qualifier is calculated.

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID of the value qualifier on the GTM Trade Incentive Program",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "value":{
            "description":"Currency value of the GTM Trade Incentive Program",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency converions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "valueNote":{
            "description":"A note that shows how the value qualifier is calculated.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency converions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency converions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency converions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : value

Currency value of the GTM Trade Incentive Program

Match All

Currency value of the GTM Trade Incentive Program

Show Source

• object currencyType

{
    "description":"Currency value of the GTM Trade Incentive Program",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Back to Top