Jump to

• Request
• Response

Retrieve the Managed Folders Metadata

get

/ic/api/process/v1/process-definitions/{processDefId}/documents/managed-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(required): string
  Value of process definition ID.

Query Parameters

• name: string
  Retrieves only the folder for the specified folder name
• startupFlag: boolean
  Retrieves the default startup folder if true, else (default) returns all folders

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success. Returns the folders.

Body ()

Root Schema : managed-folders

Type: object

Show Source

• levels: integer(int32)
• links: array links
• managedFolders: array managed-folders
• title: 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"
        },
        "managedFolders":{
            "type":"array",
            "xml":{
                "name":"managed-folders"
            },
            "items":{
                "xml":{
                    "name":"managed-folders"
                },
                "$ref":"#/definitions/ManagedFolder"
            }
        }
    },
    "xml":{
        "name":"managed-folders",
        "namespace":"http://xmlns.oracle.com/bpm/rest/process-definitions"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : managed-folders

Type: array

Show Source

• Array of: object ManagedFolder

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

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

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

Nested Schema : ManagedFolder

Type: object

Show Source

• levels: integer(int32)
• links: array links
• name: string
• permission: string
• startupFlag: boolean
• title: 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"
        },
        "permission":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "startupFlag":{
            "type":"boolean"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

401 Response

Unauthorized

500 Response

Error in retrieving the folder information

Back to Top