Get a Required Document
get
/shipments/{shipmentGid}/reqdocs/{documentDefGid}
Request
Path Parameters
-
documentDefGid(required): string
Resource ID
-
shipmentGid(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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
docs:
docs
-
documentDefGid: string
The required document type for the shipment.
-
domainName: string
Database domain where this data is stored.
-
instructions: string
The instruction associated with handling of the document.
-
links: array
links
Read Only:
true
-
numRevisions: number
(int32)
The number of document revisions generated.
-
reviewers:
reviewers
-
reviewStatus: string
The status of the review of the document.
-
statuses:
statuses
-
subscribers:
subscribers
-
texts:
texts
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 : shipments.reqdocs.docs
Type:
Show Source
object
-
annotations: string
The document revision annotations.
-
documentCmsName: string
The document name used to identify a set of revisions (versions) for a CMS.
-
documentGid: string
The document GID.
-
documentRevision: number
(int32)
The document revision count.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
review: string
The document review state.
-
reviews:
reviews
Nested Schema : reviews
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.docs.reviews
Type:
Show Source
object
-
comments: string
Comments added by the reviewer.
-
contactGid: string
The reviewer GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
state: string
The review state.
Nested Schema : shipments.reqdocs.reviewers
Type:
Show Source
object
-
asInvolvedPartyQualGid: string
The involved party qualifier for reviewer, if it is acting as a party on the shipment.
-
contactGid: string
The reviewer.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipments.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.
-
statusValueGid: string
The status value.
Nested Schema : shipments.reqdocs.subscribers
Type:
Show Source
object
-
asInvolvedPartyQualGid: string
The involved party qualifier for subscriber, if it is acting as a party on the shipment.
-
contactGid: string
The subscriber GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : shipments.reqdocs.texts
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sShipUnitGid: string
If the text is associated with a ship unit or ship unit line, this holds the ship unit ID.
-
sShipUnitLineNo: number
(int64)
If the text is associated with a ship unit line, this holds the ship unit line number.
-
textTemplateGid: string
The text template ID.