Create a Document
post
/documents
Request
Header Parameters
-
Prefer:
An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Root Schema : schema
Type:
Show Source
object
-
cmsParams:
cmsParams
-
contentManagementSystemGid: string
No description.
-
contents:
contents
-
contexts:
contexts
-
documentCmsId: string
Read Only:
true
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS. -
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description. This attribute is marked as Create-Only.
-
documentTrackingNum: string
No description.
-
documentType: string
Read Only:
true
No description. -
documentUrl: string
Read Only:
true
No description. -
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
insertDate:
insertDate
Read Only:
true
insert date -
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
-
ownerObjectGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
statuses:
statuses
-
updateDate:
updateDate
Read Only:
true
update date -
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : cmsParams
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : contents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : contexts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : documents.cmsParams
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
paramName: string
Parameter name
-
paramValue: string
Parameter value
Nested Schema : documents.contents
Type:
Show Source
object
-
documentContentGid: string
NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : documents.contexts
Type:
Show Source
object
-
documentContextQualGid: string
Represents the document context qualifier.
-
documentContextValue: string
Represents the value of a document context qualifier.
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : documents.statuses
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
No description.
-
statusValueGid: string
No description.
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
cmsParams:
cmsParams
-
contentManagementSystemGid: string
No description.
-
contents:
contents
-
contexts:
contexts
-
documentCmsId: string
Read Only:
true
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS. -
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description. This attribute is marked as Create-Only.
-
documentTrackingNum: string
No description.
-
documentType: string
Read Only:
true
No description. -
documentUrl: string
Read Only:
true
No description. -
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
insertDate:
insertDate
Read Only:
true
insert date -
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
-
ownerObjectGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
statuses:
statuses
-
updateDate:
updateDate
Read Only:
true
update date -
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : cmsParams
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : contents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : contexts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : documents.cmsParams
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
paramName: string
Parameter name
-
paramValue: string
Parameter value
Nested Schema : documents.contents
Type:
Show Source
object
-
documentContentGid: string
NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : documents.contexts
Type:
Show Source
object
-
documentContextQualGid: string
Represents the document context qualifier.
-
documentContextValue: string
Represents the value of a document context qualifier.
-
domainName: string
No description.
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : documents.statuses
Type:
Show Source
object
-
domainName: string
No description.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
No description.
-
statusValueGid: string
No description.