Jump to

• Request
• Response

Get a License

get

/tradeTransactions/{gtmTransactionGid}/lines/{gtmTransactionLineGid}/licenses/{gtmTransLineLicenseSeq}

Request

Path Parameters

• gtmTransLineLicenseSeq(required): string
  Resource ID
• gtmTransactionGid(required): string
  Resource ID
• gtmTransactionLineGid(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 : tradeTransactions.lines.licenses

Type: object

Show Source

• assignedDate: assignedDate
  The date that the license is assigned to the trade transaction line.
• comments: string
  Comments.
• controlCode: string
  The control code being released by the license line assigned to the trade transaction.
• currencyValue: currencyValue
  The currency value of the license line assigned to the trade transaction.
• domainName: string
  Database domain where this data is stored.
• exchangeRateGid: string
  The Exchange Rate ID used for value conversion between the license and the trade transaction. It is foreign key reference to EXCHANGE_RATE table.
• gtmControlTypeGid: string
  The control type being released by the license line assigned to the trade transaction.
• gtmLlUsageSequenceNo: number (int64)
  The sequence number of the license line usage.
• gtmQuantityTypeGid: string
  The GID for the GTM quantity qualifier.
• gtmTransLineLicenseSeq: number (int64)
  The sequence number for the license line assigned to the trade transaction.
• gtmValueQualifierGid: string
  The GID for the GTM value qualifier.
• licenseExpirationDate: licenseExpirationDate
  The expiration date of the license assigned to the trade transaction line.
• licenseLineGid: string
  The GID for the GTM license line.
• links: array links
  Read Only: true
• quantityUom: string
  The unit of measure of the license line quantity allocated to the trade transaction line.
• quantityValue: number (double)
  The value of the license line quantity allocated to the trade transaction line.
• rateExchangeDate: rateExchangeDate
  The Exchange Rate date used for value conversion between the license and the trade transaction.
• tradeLicenses: tradeLicenses
• transactionDate: transactionDate
  Transaction date is set on performing license assignment based on the date qualifier configured on license code option.
• userGid: string
  The GID for GTM user which assigned the license to the trade transaction line.

{
    "properties":{
        "gtmTransLineLicenseSeq":{
            "description":"The sequence number for the license line assigned to the trade transaction. ",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "licenseLineGid":{
            "description":"The GID for the GTM license line.",
            "type":"string"
        },
        "gtmQuantityTypeGid":{
            "description":"The GID for the GTM quantity qualifier.",
            "type":"string"
        },
        "quantityValue":{
            "description":"The value of the license line quantity allocated to the trade transaction line.",
            "type":"number",
            "format":"double"
        },
        "quantityUom":{
            "description":"The unit of measure of the license line quantity allocated to the trade transaction line. ",
            "type":"string"
        },
        "gtmValueQualifierGid":{
            "description":"The GID for the GTM value qualifier.",
            "type":"string"
        },
        "licenseExpirationDate":{
            "description":"The expiration date of the license assigned to the trade transaction line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "userGid":{
            "description":"The GID for GTM user which assigned the license to the trade transaction line.",
            "type":"string"
        },
        "assignedDate":{
            "description":"The date that the license is assigned to the trade transaction line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "comments":{
            "description":"Comments.",
            "type":"string"
        },
        "currencyValue":{
            "description":"The currency value of the license line assigned to the trade transaction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"The Exchange Rate ID used for value conversion between the license and the trade transaction. It is foreign key reference to EXCHANGE_RATE table. ",
            "type":"string"
        },
        "rateExchangeDate":{
            "description":"The Exchange Rate date used for value conversion between the license and the trade transaction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "gtmControlTypeGid":{
            "description":"The control type being released by the license line assigned to the trade transaction.",
            "type":"string"
        },
        "controlCode":{
            "description":"The control code being released by the license line assigned to the trade transaction.",
            "type":"string"
        },
        "gtmLlUsageSequenceNo":{
            "description":"The sequence number of the license line usage.",
            "type":"number",
            "format":"int64"
        },
        "transactionDate":{
            "description":"Transaction date is set on performing license assignment based on the date qualifier configured on license code option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "tradeLicenses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeTransactions.lines.licenses.tradeLicenses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : assignedDate

The date that the license is assigned to the trade transaction line.

Match All

The date that the license is assigned to the trade transaction line.

Show Source

• object dateTimeType

{
    "description":"The date that the license is assigned to the trade transaction line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : currencyValue

The currency value of the license line assigned to the trade transaction.

Match All

The currency value of the license line assigned to the trade transaction.

Show Source

• object currencyType

{
    "description":"The currency value of the license line assigned to the trade transaction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : licenseExpirationDate

The expiration date of the license assigned to the trade transaction line.

Match All

The expiration date of the license assigned to the trade transaction line.

Show Source

• object dateTimeType

{
    "description":"The expiration date of the license assigned to the trade transaction line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

The Exchange Rate date used for value conversion between the license and the trade transaction.

Match All

The Exchange Rate date used for value conversion between the license and the trade transaction.

Show Source

• object dateType

{
    "description":"The Exchange Rate date used for value conversion between the license and the trade transaction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : tradeLicenses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeTransactions.lines.licenses.tradeLicenses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : transactionDate

Transaction date is set on performing license assignment based on the date qualifier configured on license code option.

Match All

Transaction date is set on performing license assignment based on the date qualifier configured on license code option.

Show Source

• object dateType

{
    "description":"Transaction date is set on performing license assignment based on the date qualifier configured on license code option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "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 : items

Type: array

Show Source

• Array of: object tradeTransactions.lines.licenses.tradeLicenses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeTransactions.lines.licenses.tradeLicenses"
    }
}

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 : tradeTransactions.lines.licenses.tradeLicenses

Type: object

Show Source

• approvalDate: approvalDate
  The date on which the license was approved by the licensing authority.
• attribute1: string
  No description.
• attribute10: string
  No description.
• attribute11: string
  No description.
• attribute12: string
  No description.
• attribute13: string
  No description.
• attribute14: string
  No description.
• attribute15: string
  No description.
• attribute16: string
  No description.
• attribute17: string
  No description.
• attribute18: string
  No description.
• attribute19: string
  No description.
• attribute2: string
  No description.
• attribute20: string
  No description.
• attribute3: string
  No description.
• attribute4: string
  No description.
• attribute5: string
  No description.
• attribute6: string
  No description.
• attribute7: string
  No description.
• attribute8: string
  No description.
• attribute9: string
  No description.
• attributeDate1: attributeDate1
  No description.
• attributeDate10: attributeDate10
  No description.
• attributeDate2: attributeDate2
  No description.
• attributeDate3: attributeDate3
  No description.
• attributeDate4: attributeDate4
  No description.
• attributeDate5: attributeDate5
  No description.
• attributeDate6: attributeDate6
  No description.
• attributeDate7: attributeDate7
  No description.
• attributeDate8: attributeDate8
  No description.
• attributeDate9: attributeDate9
  No description.
• attributeNumber1: number (double)
  No description.
• attributeNumber10: number (double)
  No description.
• attributeNumber2: number (double)
  No description.
• attributeNumber3: number (double)
  No description.
• attributeNumber4: number (double)
  No description.
• attributeNumber5: number (double)
  No description.
• attributeNumber6: number (double)
  No description.
• attributeNumber7: number (double)
  No description.
• attributeNumber8: number (double)
  No description.
• attributeNumber9: number (double)
  No description.
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The date on which the license is effective.
• endDate: endDate
  The date on which the license ends.
• expirationDate: expirationDate
  The date on which the license expires.
• gtmJurisdictionGid: string
  The GID for the jurisdiction.
• gtmRegimeGid: string
  The GID for the regime.
• indicator: string
  Marks the condition or state of the GTM license using colors.
• isActive: boolean
  Checkbox indicating if the license record is active or not.
• isTemplate: boolean
  Checkbox indicating whether or not this license record will be used as a license template or not.
• licenseCategoryGid: string
  The GID for the GTM license category.
• licenseCode: string
  The license code assigned to the license.
• licenseGid: string
  The GID for the GTM license.
• licenseNumber: string
  The license number issued by the licensing authority.
• licenseTypeGid: string
  The GID for the GTM license type.
• licenseXid: string
  The XID for the GTM license.
• links: array links
  Read Only: true
• renewalDate: renewalDate
  The date on which the license was renewed with the licensing authority.
• requestedDate: requestedDate
  The date on which the license was requested from the licensing authority.
• userDefined1IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.
• userDefined2IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.
• userDefined3IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.
• userDefined4IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.
• userDefined5IconGid: string
  Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table.

{
    "properties":{
        "licenseGid":{
            "description":"The GID for the GTM license.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "licenseXid":{
            "description":"The XID for the GTM license.",
            "type":"string"
        },
        "licenseNumber":{
            "description":"The license number issued by the licensing authority.",
            "type":"string"
        },
        "licenseCategoryGid":{
            "description":"The GID for the GTM license category.",
            "type":"string"
        },
        "licenseTypeGid":{
            "description":"The GID for the GTM license type.",
            "type":"string"
        },
        "licenseCode":{
            "description":"The license code assigned to the license.",
            "type":"string"
        },
        "gtmRegimeGid":{
            "description":"The GID for the regime.",
            "type":"string"
        },
        "gtmJurisdictionGid":{
            "description":"The GID for the jurisdiction.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Checkbox indicating whether or not this license record will be used as a license template or not.",
            "type":"boolean"
        },
        "indicator":{
            "description":"Marks the condition or state of the GTM license using colors.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Marks the condition or state of the GTM license using images. It is a foreign key reference to ICON table. ",
            "type":"string"
        },
        "isActive":{
            "description":"Checkbox indicating if the license record is active or not.",
            "type":"boolean"
        },
        "effectiveDate":{
            "description":"The date on which the license is effective.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The date on which the license expires.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "requestedDate":{
            "description":"The date on which the license was requested from the licensing authority.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "approvalDate":{
            "description":"The date on which the license was approved by the licensing authority.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "renewalDate":{
            "description":"The date on which the license was renewed with the licensing authority.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "endDate":{
            "description":"The date on which the license ends.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attribute1":{
            "description":"No description.",
            "type":"string"
        },
        "attribute2":{
            "description":"No description.",
            "type":"string"
        },
        "attribute3":{
            "description":"No description.",
            "type":"string"
        },
        "attribute4":{
            "description":"No description.",
            "type":"string"
        },
        "attribute5":{
            "description":"No description.",
            "type":"string"
        },
        "attribute6":{
            "description":"No description.",
            "type":"string"
        },
        "attribute7":{
            "description":"No description.",
            "type":"string"
        },
        "attribute8":{
            "description":"No description.",
            "type":"string"
        },
        "attribute9":{
            "description":"No description.",
            "type":"string"
        },
        "attribute10":{
            "description":"No description.",
            "type":"string"
        },
        "attribute11":{
            "description":"No description.",
            "type":"string"
        },
        "attribute12":{
            "description":"No description.",
            "type":"string"
        },
        "attribute13":{
            "description":"No description.",
            "type":"string"
        },
        "attribute14":{
            "description":"No description.",
            "type":"string"
        },
        "attribute15":{
            "description":"No description.",
            "type":"string"
        },
        "attribute16":{
            "description":"No description.",
            "type":"string"
        },
        "attribute17":{
            "description":"No description.",
            "type":"string"
        },
        "attribute18":{
            "description":"No description.",
            "type":"string"
        },
        "attribute19":{
            "description":"No description.",
            "type":"string"
        },
        "attribute20":{
            "description":"No description.",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : approvalDate

The date on which the license was approved by the licensing authority.

Match All

The date on which the license was approved by the licensing authority.

Show Source

• object dateType

{
    "description":"The date on which the license was approved by the licensing authority.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : attributeDate1

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate10

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate2

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate3

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate4

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate5

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate6

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate7

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate8

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : attributeDate9

No description.

Match All

No description.

Show Source

• object dateTimeType

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

Nested Schema : effectiveDate

The date on which the license is effective.

Match All

The date on which the license is effective.

Show Source

• object dateType

{
    "description":"The date on which the license is effective.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : endDate

The date on which the license ends.

Match All

The date on which the license ends.

Show Source

• object dateType

{
    "description":"The date on which the license ends.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The date on which the license expires.

Match All

The date on which the license expires.

Show Source

• object dateType

{
    "description":"The date on which the license expires.",
    "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 : renewalDate

The date on which the license was renewed with the licensing authority.

Match All

The date on which the license was renewed with the licensing authority.

Show Source

• object dateType

{
    "description":"The date on which the license was renewed with the licensing authority.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : requestedDate

The date on which the license was requested from the licensing authority.

Match All

The date on which the license was requested from the licensing authority.

Show Source

• object dateType

{
    "description":"The date on which the license was requested from the licensing authority.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Back to Top