Create a Required Document
post
/campaigns/{gtmCampaignGid}/lines/{gtmCampaignLineGid}/reqdocs
Request
Path Parameters
-
gtmCampaignGid(required): string
Resource ID
-
gtmCampaignLineGid(required): string
Resource ID
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Nested Schema : schema
Type:
Show Source
object
-
docs:
docs
-
documentDefGid: string
Required document type.
-
domainName: string
No description.
-
instructions: string
No description.
-
links: array
links
Read Only:
true
-
numRevisions: number
(int32)
Number of document revisions generated
-
reviewers:
reviewers
-
reviewStatus: string
No description.
-
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 : campaigns.lines.reqdocs.docs
Type:
Show Source
object
-
annotations: string
Document revision annotations
-
documentCmsName: string
The document name used to identify a set of revisions (versions) for a CMS.
-
documentGid: string
Document instance
-
documentRevision: number
(int32)
Document revision count
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
review: string
Document review state
Nested Schema : campaigns.lines.reqdocs.reviewers
Type:
Show Source
object
-
contactGid: string
Reviewer
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.statuses
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
Status Type
-
statusValueGid: string
Status Value
Nested Schema : campaigns.lines.reqdocs.subscribers
Type:
Show Source
object
-
contactGid: string
Subscriber
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.texts
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
textTemplateGid: string
Text template ID
Root Schema : schema
Type:
Show Source
object
-
docs:
docs
-
documentDefGid: string
Required document type.
-
domainName: string
No description.
-
instructions: string
No description.
-
links: array
links
Read Only:
true
-
numRevisions: number
(int32)
Number of document revisions generated
-
reviewers:
reviewers
-
reviewStatus: string
No description.
-
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 : campaigns.lines.reqdocs.docs
Type:
Show Source
object
-
annotations: string
Document revision annotations
-
documentCmsName: string
The document name used to identify a set of revisions (versions) for a CMS.
-
documentGid: string
Document instance
-
documentRevision: number
(int32)
Document revision count
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
review: string
Document review state
Nested Schema : campaigns.lines.reqdocs.reviewers
Type:
Show Source
object
-
contactGid: string
Reviewer
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.statuses
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
Status Type
-
statusValueGid: string
Status Value
Nested Schema : campaigns.lines.reqdocs.subscribers
Type:
Show Source
object
-
contactGid: string
Subscriber
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.texts
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
textTemplateGid: string
Text template ID
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
docs:
docs
-
documentDefGid: string
Required document type.
-
domainName: string
No description.
-
instructions: string
No description.
-
links: array
links
Read Only:
true
-
numRevisions: number
(int32)
Number of document revisions generated
-
reviewers:
reviewers
-
reviewStatus: string
No description.
-
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 : campaigns.lines.reqdocs.docs
Type:
Show Source
object
-
annotations: string
Document revision annotations
-
documentCmsName: string
The document name used to identify a set of revisions (versions) for a CMS.
-
documentGid: string
Document instance
-
documentRevision: number
(int32)
Document revision count
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
review: string
Document review state
Nested Schema : campaigns.lines.reqdocs.reviewers
Type:
Show Source
object
-
contactGid: string
Reviewer
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.statuses
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
Status Type
-
statusValueGid: string
Status Value
Nested Schema : campaigns.lines.reqdocs.subscribers
Type:
Show Source
object
-
contactGid: string
Subscriber
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : campaigns.lines.reqdocs.texts
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
textTemplateGid: string
Text template ID