Jump to

• Request
• Response

Get a Regime

get

/regimes/{gtmRegimeGid}

Request

Path Parameters

• gtmRegimeGid(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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• category: string
  No description.
• defaultCurrencyGid: string
  No description.
• description: string
  No description.
• domainName: string
  No description.
• effectiveFrom: effectiveFrom
  No description.
• effectiveTo: effectiveTo
  No description.
• exchangeRateGid: string
  No description.
• exchangeRateTolerance: number (double)
  No description.
• gtmRegimeGid: string
  No description.
• gtmRegimeXid: string
  No description.
• gtmRegulationReferenceGid: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• overrideExchangeRateGid: string
  No description.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "gtmRegimeGid":{
            "description":"No description.",
            "type":"string"
        },
        "gtmRegimeXid":{
            "description":"No description.",
            "type":"string"
        },
        "description":{
            "description":"No description.",
            "type":"string"
        },
        "category":{
            "description":"No description.",
            "type":"string"
        },
        "gtmRegulationReferenceGid":{
            "description":"No description.",
            "type":"string"
        },
        "effectiveFrom":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "effectiveTo":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "defaultCurrencyGid":{
            "description":"No description.",
            "type":"string"
        },
        "overrideExchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "exchangeRateTolerance":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveFrom

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : effectiveTo

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

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 : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

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

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

Back to Top