Jump to

• Request
• Response

Retrieve DOCs Folder Details for a Task

get

/ic/api/process/v1/tasks/{id}/folders

Retrieves the DOCs folders associated with a task, if any.

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

• id(required): string
  Task number

Query Parameters

• name: string
  Retrieves only the folder for the specified folder name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : DcsFolderCollection

Type: object

Show Source

• count: integer(int32)
• hasMore: boolean
• items: array items
• limit: integer(int32)
• links: array links
• offset: integer(int32)
• totalResults: integer(int32)
• userLink: object Link

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "userLink":{
            "xml":{
                "name":"user"
            },
            "$ref":"#/definitions/Link"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DcsFolder"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object DcsFolder

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

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 : DcsFolder

Type: object

Show Source

• appLink: string
• folderId: string
• folderName: string
• levels: integer(int32)
• links: array links
• mafLink: string
• permission: string
• title: string
• type: 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"
        },
        "folderId":{
            "type":"string"
        },
        "folderName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "permission":{
            "type":"string"
        },
        "mafLink":{
            "type":"string"
        },
        "appLink":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

400 Response

Bad Request

401 Response

Unauthorized

404 Response

DoCs Folders not found for given task

500 Response

Internal Server Error

Back to Top