Jump to

• Request
• Response

Retrieve the DOCs folder Details for a Process Instance

get

/ic/api/process/v1/processes/{processId}/folders/{folderId}

Retrieves the folder details for a given folder associated with a process.

Request

Path Parameters

• folderId(required): string
  Folder ID
• processId(required): string
  Value of Process Id

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root 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"
    }
}

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"
        }
    }
}

500 Response

Internal Server Error

Back to Top