Get Required Documents
get
/tradeTransactions/{gtmTransactionGid}/reqdocs
Request
Path Parameters
-
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.
-
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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : tradeTransactions.reqdocs
Type:
Show Source
object
-
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.
-
references:
references
-
reviewers:
reviewers
-
reviewStatus: string
The review status of the required document.
-
statuses:
statuses
-
subscribers:
subscribers
-
texts:
texts
Nested Schema : references
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reviewers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : subscribers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : tradeTransactions.reqdocs.docs
Type:
Show Source
object
-
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
Nested Schema : reviews
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : tradeTransactions.reqdocs.docs.reviews
Type:
Show Source
object
-
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.
Nested Schema : tradeTransactions.reqdocs.references
Type:
Show Source
object
-
dataQueryTypeGid: string
Identifies the data query type of the object.
-
domainName: string
Database domain where this data is stored.
-
gtmDtConfigGid: string
Gives the data configuration used to create/copy data from the related object to trade transaction.
-
isPrimary: boolean
Gives the primary shipment among the multiple shipments. Takes the values Y/N.
-
links: array
links
Read Only:
true
-
sequenceNo: number
(int64)
Uniquely identifies the association of trade transaction with the related object.
-
transactionRefGid: string
Gives the Shipment or Order Release ID based on the data query type.
Nested Schema : tradeTransactions.reqdocs.reviewers
Type:
Show Source
object
-
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
Nested Schema : tradeTransactions.reqdocs.statuses
Type:
Show Source
object
-
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.
Nested Schema : tradeTransactions.reqdocs.subscribers
Type:
Show Source
object
-
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
Nested Schema : tradeTransactions.reqdocs.texts
Type:
Show Source
object
-
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
-
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.