Jump to

• Request
• Response

Get a Document

get

/items/{itemGid}/itemOrigins/{itemOriginGid}/qualifications/{itemQfGid}/reqdocs/{documentDefGid}/docs/{documentGid}

Request

Path Parameters

• documentDefGid(required): string
  Resource ID
• documentGid(required): string
  Resource ID
• itemGid(required): string
  Resource ID
• itemOriginGid(required): string
  Resource ID
• itemQfGid(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

• 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.
• reviewers: reviewers

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

Type: object

Show Source

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

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

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

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
}

Back to Top