Jump to

• Request
• Response

Get a Document Type

get

/documentTypes/{documentDefGid}

Request

Path Parameters

• documentDefGid(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

• appActionGid: string
  No description.
• checks: checks
• cmsParameters: cmsParameters
• contentManagementSystemGid: string
  No description.
• description: string
  No description.
• documentCmsType: string
  No description.
• documentDefGid: string
  No description.
• documentDefXid: string
  No description.
• documentTemplateGid: string
  No description.
• domainName: string
  No description.
• fixedAccount: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• isAttachment: boolean
  No description.
• isConsolidated: boolean
  No description.
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• ownerDetails: ownerDetails
• printerDocuments: printerDocuments
• reportGid: string
  No description.
• texts: texts
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefXid":{
            "description":"No description.",
            "type":"string"
        },
        "description":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "appActionGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "isAttachment":{
            "description":"No description.",
            "type":"boolean"
        },
        "fixedAccount":{
            "description":"No description.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsType":{
            "description":"No description.",
            "type":"string"
        },
        "documentTemplateGid":{
            "description":"No description.",
            "type":"string"
        },
        "isConsolidated":{
            "description":"No description.",
            "type":"boolean"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documentTypes.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "printerDocuments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documentTypes.printerDocuments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "checks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documentTypes.checks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "cmsParameters":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documentTypes.cmsParameters"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "ownerDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documentTypes.ownerDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : checks

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documentTypes.checks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cmsParameters

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documentTypes.cmsParameters"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : ownerDetails

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documentTypes.ownerDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : printerDocuments

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documentTypes.printerDocuments"
            }
        },
        "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/documentTypes.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object documentTypes.checks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documentTypes.checks"
    }
}

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 : documentTypes.checks

Type: object

Show Source

• autoAssignRuleGid: string
  No description.
• dataQueryTypeGid: string
  No description.
• documentDefCheckGid: string
  No description.
• documentDefCheckXid: string
  No description.
• domainName: string
  No description.
• errorTranslationGid: string
  No description.
• links: array links
  Read Only: true
• outXmlProfileGid: string
  No description.
• reviewStatus: string
  No description.
• savedConditionGid: string
  No description.
• solutionTranslationGid: string
  No description.
• xpathRoot: string
  No description.
• xpathTest: string
  No description.

{
    "properties":{
        "documentDefCheckGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "savedConditionGid":{
            "description":"No description.",
            "type":"string"
        },
        "errorTranslationGid":{
            "description":"No description.",
            "type":"string"
        },
        "solutionTranslationGid":{
            "description":"No description.",
            "type":"string"
        },
        "reviewStatus":{
            "description":"No description.",
            "type":"string"
        },
        "xpathRoot":{
            "description":"No description.",
            "type":"string"
        },
        "xpathTest":{
            "description":"No description.",
            "type":"string"
        },
        "autoAssignRuleGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefCheckXid":{
            "description":"No description.",
            "type":"string"
        },
        "outXmlProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "dataQueryTypeGid":{
            "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 : 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 documentTypes.cmsParameters

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documentTypes.cmsParameters"
    }
}

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 : documentTypes.cmsParameters

Type: object

Show Source

• domainName: string
  No description.
• isModifiable: boolean
  No description.
• links: array links
  Read Only: true
• paramName: string
  No description.
• paramValueGenGid: string
  No description.

{
    "properties":{
        "paramName":{
            "description":"No description.",
            "type":"string"
        },
        "paramValueGenGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "isModifiable":{
            "description":"No description.",
            "type":"boolean"
        },
        "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 : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object documentTypes.ownerDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documentTypes.ownerDetails"
    }
}

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 : documentTypes.ownerDetails

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• reportGid: string
  No description.

{
    "properties":{
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "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 documentTypes.printerDocuments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documentTypes.printerDocuments"
    }
}

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 : documentTypes.printerDocuments

Type: object

Show Source

• defaultCopies: number (int32)
  No description.
• domainName: string
  No description.
• ippPrinterGid: string
  No description.
• links: array links
  Read Only: true
• media: string
  No description.
• orientation: string
  No description.
• sides: string
  No description.

{
    "properties":{
        "ippPrinterGid":{
            "description":"No description.",
            "type":"string"
        },
        "sides":{
            "description":"No description.",
            "type":"string"
        },
        "orientation":{
            "description":"No description.",
            "type":"string"
        },
        "media":{
            "description":"No description.",
            "type":"string"
        },
        "defaultCopies":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "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 documentTypes.texts

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

Type: object

Show Source

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

{
    "properties":{
        "textTemplateGid":{
            "description":"No description.",
            "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