Jump to

• Request
• Response

Get a Control Screen

get

/customsDeclarations/{gtmTransactionGid}/lines/{gtmTransactionLineGid}/controlScreens/{gtmTrControlScreenGid}

Request

Path Parameters

• gtmTrControlScreenGid(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 : customsDeclarations.lines.controlScreens

Type: object

Show Source

• controlCode: string
  The control code assigned to the GTM trade transaction line.
• domainName: string
  Database domain where this data is stored.
• exceptionComplianceRuleGid: string
  The GID for the compliance rule used to assign the exception control type/control code to the GTM trade transaction line.
• gtmAuthorizationTypeGid: string
  The authorization type of the license number associated with the license used to release a control on the GTM trade transaction line.
• gtmComplianceRuleGid: string
  The GID for the compliance rule used to assign the control type/control code to the GTM trade transaction line.
• gtmComplianceRuleGroupGid: string
  The GID for the compliance rule set group used to assign the control type/control code to the GTM trade transaction line.
• gtmControlCategory: string
  The control category associated with the control type/control code assigned to the GTM trade transaction line.
• gtmControlTypeGid: string
  The GID for the control type assigned to the GTM trade transaction line.
• gtmExceptionControlCode: string
  The exception control code assigned to the GTM trade transaction line.
• gtmExceptionControlTypeGid: string
  The GID for the exception control type assigned to the GTM trade transaction line.
• gtmRegistrationGid: string
  The GID for the registration associated with the GTM trade transaction line.
• gtmRegulationReferenceGid: string
  The GID for the regulation reference associated with the control assigned to the GTM trade transaction line.
• gtmTrControlScreenGid: string
  The GID for the GTM trade transaction line control code.
• gtmTrControlScreenXid: string
  The XID for the GTM trade transaction line control code.
• involvedPartyQualGid: string
  The GID for the involved party associated with the control code assigned to the GTM trade transaction line.
• licenseAddedBy: string
  Specifies who added the license to the GTM trade transaction line.
• licenseAddedOn: licenseAddedOn
  Specifies the date on which the license is added to the GTM trade transaction line.
• licenseNumber: string
  The license number associated with the license used to release a control on the GTM trade transaction line.
• licenseQuantity: number (double)
  The quantity from the associated license used to release a control on the GTM trade transaction line.
• licenseUom: string
  The unit of measured for the quantity from the associated license used to release a control on the GTM trade transaction line.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmTrControlScreenGid":{
            "description":"The GID for the GTM trade transaction line control code.",
            "type":"string"
        },
        "gtmTrControlScreenXid":{
            "description":"The XID for the GTM trade transaction line control code.",
            "type":"string"
        },
        "gtmComplianceRuleGroupGid":{
            "description":"The GID for the compliance rule set group used to assign the control type/control code to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmComplianceRuleGid":{
            "description":"The GID for the compliance rule used to assign the control type/control code to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmExceptionControlTypeGid":{
            "description":"The GID for the exception control type assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmExceptionControlCode":{
            "description":"The exception control code assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmRegulationReferenceGid":{
            "description":"The GID for the regulation reference associated with the control assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmControlTypeGid":{
            "description":"The GID for the control type assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "controlCode":{
            "description":"The control code assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "licenseNumber":{
            "description":"The license number associated with the license used to release a control on the GTM trade transaction line.",
            "type":"string"
        },
        "licenseQuantity":{
            "description":"The quantity from the associated license used to release a control on the GTM trade transaction line.",
            "type":"number",
            "format":"double"
        },
        "licenseUom":{
            "description":"The unit of measured for the quantity from the associated license used to release a control on the GTM trade transaction line.",
            "type":"string"
        },
        "licenseAddedBy":{
            "description":"Specifies who added the license to the GTM trade transaction line.",
            "type":"string"
        },
        "licenseAddedOn":{
            "description":"Specifies the date on which the license is added to the GTM trade transaction line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "gtmControlCategory":{
            "description":"The control category associated with the control type/control code assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmRegistrationGid":{
            "description":"The GID for the registration associated with the GTM trade transaction line.",
            "type":"string"
        },
        "involvedPartyQualGid":{
            "description":"The GID for the involved party associated with the control code assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "exceptionComplianceRuleGid":{
            "description":"The GID for the compliance rule used to assign the exception control type/control code to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmAuthorizationTypeGid":{
            "description":"The authorization type of the  license number associated with the license used to release a control on the GTM trade transaction line.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : licenseAddedOn

Specifies the date on which the license is added to the GTM trade transaction line.

Match All

Specifies the date on which the license is added to the GTM trade transaction line.

Show Source

• object dateTimeType

{
    "description":"Specifies the date on which the license is added to the GTM 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 : 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 : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top