Jump to

• Request
• Response

Retrieve Incoming Folders Metadata

get

/ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-folders

Retrieves the folders metadata information for a given 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

• processDefId: string
  Value of process definition ID.

Query Parameters

• name(optional): string
  Retrieves only the folder for the specified folder name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success. Returns the folders.

Body ()

Root Schema : incoming-folders

Type: object

Show Source

• incomingFolders(optional): array incoming-folders
• levels(optional): integer(int32)
• links(optional): array links
• title(optional): string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "incomingFolders":{
            "type":"array",
            "xml":{
                "name":"incoming-folders"
            },
            "items":{
                "xml":{
                    "name":"incoming-folders"
                },
                "$ref":"#/definitions/IncomingFolder"
            }
        }
    },
    "xml":{
        "name":"incoming-folders",
        "namespace":"http://xmlns.oracle.com/bpm/rest/process-definitions"
    }
}

Nested Schema : incoming-folders

Type: array

Show Source

• Array of: object IncomingFolder

{
    "type":"array",
    "xml":{
        "name":"incoming-folders"
    },
    "items":{
        "xml":{
            "name":"incoming-folders"
        },
        "$ref":"#/definitions/IncomingFolder"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : IncomingFolder

Type: object

Show Source

• assetType(optional): string
  Allowed Values: [ "MANAGED_FOLDER", "INCOMING_FOLDER", "INCOMING_DOCUMENT" ]
• defaultPermission(optional): string
  Allowed Values: [ "MANAGER", "CONTRIBUTOR", "DOWNLOADER", "VIEWER", "NONE" ]
• description(optional): string
• displayName(optional): object DisplayName
• entityAttributes(optional): array entityAttributes
• folderId(optional): object FolderId
• folders(optional): array folders
• name(optional): string
• transientAttributes(optional): object transientAttributes
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "folders":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IncomingFolder"
            }
        },
        "defaultPermission":{
            "type":"string",
            "enum":[
                "MANAGER",
                "CONTRIBUTOR",
                "DOWNLOADER",
                "VIEWER",
                "NONE"
            ]
        },
        "folderId":{
            "$ref":"#/definitions/FolderId"
        },
        "assetType":{
            "type":"string",
            "enum":[
                "MANAGED_FOLDER",
                "INCOMING_FOLDER",
                "INCOMING_DOCUMENT"
            ]
        },
        "displayName":{
            "$ref":"#/definitions/DisplayName"
        },
        "description":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

Nested Schema : DisplayName

Type: object

Show Source

• displayType(optional): string
  Allowed Values: [ "STATIC", "XPATH" ]
• displayValue(optional): string
• entityAttributes(optional): array entityAttributes
• transientAttributes(optional): object transientAttributes
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "displayValue":{
            "type":"string"
        },
        "displayType":{
            "type":"string",
            "enum":[
                "STATIC",
                "XPATH"
            ]
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

Nested Schema : entityAttributes

Type: array

Show Source

• Array of: object AttrObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AttrObject"
    }
}

Nested Schema : FolderId

Type: object

Show Source

• entityAttributes(optional): array entityAttributes
• folderIdType(optional): string
  Allowed Values: [ "STATIC", "XPATH" ]
• folderIdValue(optional): string
• transientAttributes(optional): object transientAttributes
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "folderIdValue":{
            "type":"string"
        },
        "folderIdType":{
            "type":"string",
            "enum":[
                "STATIC",
                "XPATH"
            ]
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

Nested Schema : folders

Type: array

Show Source

• Array of: object IncomingFolder

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IncomingFolder"
    }
}

Nested Schema : transientAttributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : entityAttributes

Type: array

Show Source

• Array of: object AttrObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AttrObject"
    }
}

Nested Schema : transientAttributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : AttrObject

Type: object

Show Source

• attrType(optional): string
  Allowed Values: [ "VALUE", "REF" ]
• contentType(optional): string
  Allowed Values: [ "OBJECT", "NATIVE_OBJECT", "LIST", "SORTED_LIST", "MAP" ]
• defaultValue(optional): object defaultValue
• id(optional): string
• msg(optional): object Msg

{
    "type":"object",
    "properties":{
        "msg":{
            "$ref":"#/definitions/Msg"
        },
        "attrType":{
            "type":"string",
            "enum":[
                "VALUE",
                "REF"
            ]
        },
        "contentType":{
            "type":"string",
            "enum":[
                "OBJECT",
                "NATIVE_OBJECT",
                "LIST",
                "SORTED_LIST",
                "MAP"
            ]
        },
        "id":{
            "type":"string"
        },
        "defaultValue":{
            "type":"object"
        }
    }
}

Nested Schema : defaultValue

Type: object

Nested Schema : Msg

Type: object

Show Source

• allAvailableTranslationsForProjectLanguages(optional): object allAvailableTranslationsForProjectLanguages
  Additional Properties Allowed: additionalProperties
• argCount(optional): integer(int32)
• bundleName(optional): string
• bundleShortName(optional): string
• code(optional): string
• detail(optional): string
• imageFile(optional): string
• imageResource(optional): string(url)
• localizedLogMessage(optional): string
• logComponent(optional): string
  Allowed Values: [ "DEFAULT" ]
• mnemonic(optional): string
• nonLocalizedString(optional): string
• string(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "logComponent":{
            "type":"string",
            "enum":[
                "DEFAULT"
            ]
        },
        "argCount":{
            "type":"integer",
            "format":"int32"
        },
        "string":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "allAvailableTranslationsForProjectLanguages":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "mnemonic":{
            "type":"string"
        },
        "localizedLogMessage":{
            "type":"string"
        },
        "imageFile":{
            "type":"string"
        },
        "imageResource":{
            "type":"string",
            "format":"url"
        },
        "nonLocalizedString":{
            "type":"string"
        },
        "bundleShortName":{
            "type":"string"
        },
        "bundleName":{
            "type":"string"
        }
    }
}

Nested Schema : allAvailableTranslationsForProjectLanguages

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : entityAttributes

Type: array

Show Source

• Array of: object AttrObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AttrObject"
    }
}

Nested Schema : transientAttributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

500 Response

Error in retrieving the folder information

Back to Top