Jump to

• Request
• Response

Get Reportings

get

/customsDeclarations/{gtmTransactionGid}/lines/{gtmTransactionLineGid}/reportings

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

Nested Schema : items

Type: array

Show Source

• Array of: object customsDeclarations.lines.reportings

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : customsDeclarations.lines.reportings

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• exceptionComplianceRuleGid: string
  The GID for the exception compliance rule used to assign the reporting results to the GTM trade transaction line.
• gtmComplianceRuleGid: string
  The GID for the compliance rule used to assign the reporting results to the GTM trade transaction line.
• gtmComplianceRuleGroupGid: string
  The GID for the compliance rule set group used to assign the reporting results to the GTM trade transaction line.
• gtmControlCode: string
  The control code assigned in the reporting results of the GTM trade transaction line.
• gtmControlTypeGid: string
  The GID for the control type assigned in the reporting results of the GTM trade transaction line.
• gtmExceptionControlCode: string
  The exception control code assigned in the reporting results of the GTM trade transaction line.
• gtmExceptionControlTypeGid: string
  The GID for the exception control type assigned in the reporting results of the GTM trade transaction line.
• gtmRegimeGid: string
  The GID for the regime associated with the reporting results control assigned to the GTM trade transaction line.
• gtmTrReportingGid: string
  The GID for the reporting results assigned to the GTM trade transaction line.
• gtmTrReportingXid: string
  The XID for the reporting results assigned to the GTM trade transaction line.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmTrReportingGid":{
            "description":"The GID for the reporting results assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "gtmTrReportingXid":{
            "description":"The XID for the reporting results assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmComplianceRuleGroupGid":{
            "description":"The GID for the compliance rule set group used to assign the reporting results to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmComplianceRuleGid":{
            "description":"The GID for the compliance rule used to assign the reporting results to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmRegimeGid":{
            "description":"The GID for the regime associated with the reporting results control assigned to the GTM trade transaction line.",
            "type":"string"
        },
        "gtmControlTypeGid":{
            "description":"The GID for the control type assigned in the reporting results of the GTM trade transaction line.",
            "type":"string"
        },
        "gtmControlCode":{
            "description":"The control code assigned in the reporting results of the GTM trade transaction line.",
            "type":"string"
        },
        "gtmExceptionControlTypeGid":{
            "description":"The GID for the exception control type assigned in the reporting results of the GTM trade transaction line.",
            "type":"string"
        },
        "gtmExceptionControlCode":{
            "description":"The exception control code assigned in the reporting results of the GTM trade transaction line.",
            "type":"string"
        },
        "exceptionComplianceRuleGid":{
            "description":"The GID for the exception compliance rule used to assign the reporting results to the GTM trade transaction line.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "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 : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top