Jump to

• Request
• Response

Get Licenses

get

/customsDeclarations/{gtmTransactionGid}/lines/{gtmTransactionLineGid}/licenses

Request

Path Parameters

• 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.
• 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/customsDeclarations.lines.licenses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object customsDeclarations.lines.licenses

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : customsDeclarations.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.
• 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"
                }
            ]
        },
        "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

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

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

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

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

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

Match All

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

Back to Top