Retrieve Incoming Document Metadata for a Document
get
/ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-documents/{documentName}
Retrieves the folder metadata information for a given incoming document and a process definition ID.
NOTE:
Whether a process application uses documents or attachments depends on the application configuration.
- If Oracle Content and Experience(documents) is enabled, the application can only use documents, and API operations on attachments do not apply.
- If Oracle Content and Experience(documents) is not enabled, the application can only use attachments, and API operations on documents do not apply.
To identify whether Oracle Content and Experience(documents) is enabled in a process application, use the API /ic/api/process/v1/processes/{processId} to retrieve process instance details. Oracle Content and Experience(documents) is enabled when the parameter isDoCSEnabled=true.
Request
Path Parameters
-
documentName(required): string
Name of the document.
-
processDefId(required): string
Value of process definition ID.
Response
Supported Media Types
- application/json
200 Response
Success. Returns the incoming document metadata.
Root Schema : IncomingDocument
Type:
Show Source
object
-
assetType:
string
Allowed Values:
[ "MANAGED_FOLDER", "INCOMING_FOLDER", "INCOMING_DOCUMENT" ]
-
defaultPermission:
string
Allowed Values:
[ "MANAGER", "CONTRIBUTOR", "DOWNLOADER", "VIEWER", "NONE" ]
-
description:
string
-
displayName:
object DisplayName
-
entityAttributes:
array entityAttributes
-
folderId:
object FolderId
-
name:
string
-
transientAttributes:
object transientAttributes
Additional Properties Allowed: additionalProperties
Nested Schema : DisplayName
Type:
Show Source
object
-
displayType:
string
Allowed Values:
[ "STATIC", "XPATH" ]
-
displayValue:
string
-
entityAttributes:
array entityAttributes
-
transientAttributes:
object transientAttributes
Additional Properties Allowed: additionalProperties
Nested Schema : FolderId
Type:
Show Source
object
-
entityAttributes:
array entityAttributes
-
folderIdType:
string
Allowed Values:
[ "STATIC", "XPATH" ]
-
folderIdValue:
string
-
transientAttributes:
object transientAttributes
Additional Properties Allowed: additionalProperties
Nested Schema : AttrObject
Type:
Show Source
object
-
attrType:
string
Allowed Values:
[ "VALUE", "REF" ]
-
contentType:
string
Allowed Values:
[ "OBJECT", "NATIVE_OBJECT", "LIST", "SORTED_LIST", "MAP" ]
-
defaultValue:
object defaultValue
-
id:
string
-
msg:
object Msg
Nested Schema : defaultValue
Type:
object
Nested Schema : Msg
Type:
Show Source
object
-
allAvailableTranslationsForProjectLanguages:
object allAvailableTranslationsForProjectLanguages
Additional Properties Allowed: additionalProperties
-
argCount:
integer(int32)
-
bundleName:
string
-
bundleShortName:
string
-
code:
string
-
detail:
string
-
imageFile:
string
-
imageResource:
string(url)
-
localizedLogMessage:
string
-
logComponent:
string
Allowed Values:
[ "DEFAULT" ]
-
mnemonic:
string
-
nonLocalizedString:
string
-
string:
string
Nested Schema : allAvailableTranslationsForProjectLanguages
Type:
object
Additional Properties Allowed
Show Source
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
401 Response
Unauthorized
500 Response
Error in retrieving the document information