Jump to

• Request
• Response

Get a Required Document

get

/customsDeclarations/{gtmTransactionGid}/reqdocs/{documentDefGid}

Request

Path Parameters

• documentDefGid(required): string
  Resource ID
• gtmTransactionGid(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

• docs: docs
• documentDefGid: string
  Required document type for the GTM trade transaction.
• domainName: string
  Database domain where this data is stored.
• gtmComplianceRuleGid: string
  The GID for the compliance rule.
• gtmComplianceRuleGroupGid: string
  The GID for the compliance rule set group.
• instructions: string
  Free-form field to hold document attributes. E.g. a document could be denoted as required or optional.
• links: array links
  Read Only: true
• numRevisions: number (int32)
  The number of document revisions generated.
• reviewers: reviewers
• reviewStatus: string
  The review status of the required document.
• statuses: statuses
• subscribers: subscribers
• texts: texts

{
    "properties":{
        "documentDefGid":{
            "description":"Required document type for the GTM trade transaction.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numRevisions":{
            "description":"The number of document revisions generated.",
            "type":"number",
            "format":"int32"
        },
        "reviewStatus":{
            "description":"The review status of the required document. ",
            "type":"string"
        },
        "gtmComplianceRuleGroupGid":{
            "description":"The GID for the compliance rule set group.",
            "type":"string"
        },
        "gtmComplianceRuleGid":{
            "description":"The GID for the compliance rule.",
            "type":"string"
        },
        "instructions":{
            "description":"Free-form field to hold document attributes. E.g. a document could be denoted as required or optional.",
            "type":"string"
        },
        "reviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/customsDeclarations.reqdocs.reviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/customsDeclarations.reqdocs.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "docs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/customsDeclarations.reqdocs.docs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "subscribers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/customsDeclarations.reqdocs.subscribers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/customsDeclarations.reqdocs.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : docs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customsDeclarations.reqdocs.docs"
            }
        },
        "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 : reviewers

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customsDeclarations.reqdocs.reviewers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customsDeclarations.reqdocs.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : subscribers

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customsDeclarations.reqdocs.subscribers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customsDeclarations.reqdocs.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object customsDeclarations.reqdocs.docs

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

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 : customsDeclarations.reqdocs.docs

Type: object

Show Source

• annotations: string
  Annotations for a document revision.
• documentCmsName: string
  The document name used to identify a set of revisions (versions) for a CMS.
• documentGid: string
  The GID for the document instance.
• documentRevision: number (int32)
  The revision count for the document.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• review: string
  The review status of the required document.
• reviews: reviews

{
    "properties":{
        "documentGid":{
            "description":"The GID for the document instance.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "documentRevision":{
            "description":"The revision count for the document.",
            "type":"number",
            "format":"int32"
        },
        "review":{
            "description":"The review status of the required document. ",
            "type":"string"
        },
        "annotations":{
            "description":"Annotations for a document revision.",
            "type":"string"
        },
        "documentCmsName":{
            "description":"The document name used to identify a set of revisions (versions) for a CMS.",
            "type":"string"
        },
        "reviews":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/customsDeclarations.reqdocs.docs.reviews"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : reviews

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customsDeclarations.reqdocs.docs.reviews"
            }
        },
        "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"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object customsDeclarations.reqdocs.docs.reviews

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/customsDeclarations.reqdocs.docs.reviews"
    }
}

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 : customsDeclarations.reqdocs.docs.reviews

Type: object

Show Source

• comments: string
  Comments from the reviewer for the specific document.
• contactGid: string
  The GID for the document reviewer.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• state: string
  The review status of the document.

{
    "properties":{
        "contactGid":{
            "description":"The GID for the document reviewer.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "state":{
            "description":"The review status of the document.",
            "type":"string"
        },
        "comments":{
            "description":"Comments from the reviewer for the specific document.",
            "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 : items

Type: array

Show Source

• Array of: object customsDeclarations.reqdocs.reviewers

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

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 : customsDeclarations.reqdocs.reviewers

Type: object

Show Source

• asInvolvedPartyQualGid: string
  The involved party of the reviewer if they are acting as a party on the trade transaction.
• contactGid: string
  The GID for the document reviewer.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The GID for the document reviewer.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"The involved party of the reviewer if they are acting as a party on the trade transaction.",
            "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 : items

Type: array

Show Source

• Array of: object customsDeclarations.reqdocs.statuses

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

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 : customsDeclarations.reqdocs.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type associated with a required document.
• statusValueGid: string
  The status value associated with a required document.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type associated with a required document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value associated with a required document.",
            "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 : items

Type: array

Show Source

• Array of: object customsDeclarations.reqdocs.subscribers

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

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 : customsDeclarations.reqdocs.subscribers

Type: object

Show Source

• asInvolvedPartyQualGid: string
  The involved party of the subscriber if they are acting as a party on the trade transaction.
• contactGid: string
  The GID for the document reviewer.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The GID for the document reviewer.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"The involved party of the subscriber if they are acting as a party on the trade transaction.",
            "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 : items

Type: array

Show Source

• Array of: object customsDeclarations.reqdocs.texts

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

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 : customsDeclarations.reqdocs.texts

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmComplianceRuleGid: string
  The compliance rule used to assign the text template to the GTM trade transaction.
• gtmComplianceRuleGroupGid: string
  The compliance rule set group used to assign the text template to the GTM trade transaction.
• gtmTransactionLineGid: string
  The GID for the GTM trade transaction line.
• links: array links
  Read Only: true
• textLinks: textLinks
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for the text template associated with the GTM trade transaction line.

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template associated with the GTM trade transaction line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "gtmTransactionLineGid":{
            "description":"The GID for the GTM trade transaction line.",
            "type":"string"
        },
        "gtmComplianceRuleGid":{
            "description":"The compliance rule used to assign the text template to the GTM trade transaction.",
            "type":"string"
        },
        "gtmComplianceRuleGroupGid":{
            "description":"The compliance rule set group used to assign the text template to the GTM trade transaction.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "textLinks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/customsDeclarations.reqdocs.texts.textLinks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : textLinks

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customsDeclarations.reqdocs.texts.textLinks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object customsDeclarations.reqdocs.texts.textLinks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/customsDeclarations.reqdocs.texts.textLinks"
    }
}

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 : customsDeclarations.reqdocs.texts.textLinks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmComplianceRuleGid: string
  The GID for the GTM compliance rule used to assign a text template to a trade transaction line.
• gtmComplianceRuleGroupGid: string
  The GID for the GTM compliance rule set group used to assign a text template to a trade transaction line.
• gtmTransactionLineGid: string
  The GID for the GTM trade transaction line.
• gtmTransLineTextLinkGid: string
  The GID for the link between the GTM trade transaction line and the associated text template.
• gtmTransLineTextLinkXid: string
  The XID for the link between the GTM trade transaction line and the associated text template.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document

{
    "properties":{
        "gtmTransLineTextLinkGid":{
            "description":"The GID for the link between the GTM trade transaction line and the associated text template.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "gtmTransLineTextLinkXid":{
            "description":"The XID for the link between the GTM trade transaction line and the associated text template.",
            "type":"string"
        },
        "gtmTransactionLineGid":{
            "description":"The GID for the GTM trade transaction line.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document",
            "type":"string"
        },
        "gtmComplianceRuleGroupGid":{
            "description":"The GID for the GTM compliance rule set group used to assign a text template to a trade transaction line.",
            "type":"string"
        },
        "gtmComplianceRuleGid":{
            "description":"The GID for the GTM compliance rule used to assign a text template to a 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
}

Back to Top