Jump to

• Request
• Response

Get a Required Document

get

/campaigns/{gtmCampaignGid}/lines/{gtmCampaignLineGid}/reqdocs/{documentDefGid}

Request

Path Parameters

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

{
    "properties":{
        "documentDefGid":{
            "description":"Required document type.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "numRevisions":{
            "description":"Number of document revisions generated",
            "type":"number",
            "format":"int32"
        },
        "reviewStatus":{
            "description":"No description.",
            "type":"string"
        },
        "instructions":{
            "description":"No description.",
            "type":"string"
        },
        "reviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/campaigns.lines.reqdocs.reviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "docs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/campaigns.lines.reqdocs.docs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/campaigns.lines.reqdocs.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "subscribers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/campaigns.lines.reqdocs.subscribers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/campaigns.lines.reqdocs.texts"
                    }
                },
                "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/campaigns.lines.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/campaigns.lines.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/campaigns.lines.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/campaigns.lines.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/campaigns.lines.reqdocs.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object campaigns.lines.reqdocs.docs

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

Type: object

Show Source

• 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

{
    "properties":{
        "documentGid":{
            "description":"Document instance",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "documentRevision":{
            "description":"Document revision count",
            "type":"number",
            "format":"int32"
        },
        "review":{
            "description":"Document review state",
            "type":"string"
        },
        "annotations":{
            "description":"Document revision annotations",
            "type":"string"
        },
        "documentCmsName":{
            "description":"The document name used to identify a set of revisions (versions) for a CMS.",
            "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"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object campaigns.lines.reqdocs.reviewers

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

Type: object

Show Source

• contactGid: string
  Reviewer
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"Reviewer",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 campaigns.lines.reqdocs.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/campaigns.lines.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 : campaigns.lines.reqdocs.statuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  Status Type
• statusValueGid: string
  Status Value

{
    "properties":{
        "statusTypeGid":{
            "description":"Status Type",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Status Value",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 campaigns.lines.reqdocs.subscribers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/campaigns.lines.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 : campaigns.lines.reqdocs.subscribers

Type: object

Show Source

• contactGid: string
  Subscriber
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"Subscriber",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 campaigns.lines.reqdocs.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/campaigns.lines.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 : campaigns.lines.reqdocs.texts

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• textTemplateGid: string
  Text template ID

{
    "properties":{
        "textTemplateGid":{
            "description":"Text template ID",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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