Jump to

• Request
• Response

Get list of folders associated with a dynamic-process instance

get

/ic/api/process/v1/dp-instances/{id}/folders

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Process Instance Id

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Folders

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object Folders-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "isDocsEnabledFlag":{
                    "type":"boolean",
                    "description":"if DoCS is enabled this will be true."
                },
                "forProcessInstanceId":{
                    "type":"string",
                    "description":"Folder fetched for ProcessInstanceId"
                },
                "folders":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/Folder"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Discriminator: links

Show Source

• links: array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Folders-allOf[1]

Type: object

Show Source

• folders: array folders
• forProcessInstanceId: string
  Folder fetched for ProcessInstanceId
• isDocsEnabledFlag: boolean
  if DoCS is enabled this will be true.

{
    "properties":{
        "isDocsEnabledFlag":{
            "type":"boolean",
            "description":"if DoCS is enabled this will be true."
        },
        "forProcessInstanceId":{
            "type":"string",
            "description":"Folder fetched for ProcessInstanceId"
        },
        "folders":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Folder"
            }
        }
    }
}

Nested Schema : folders

Type: array

Show Source

• Array of: object Folder

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

Nested Schema : Folder

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object Folder-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "folderId":{
                    "type":"string",
                    "description":"Folder Id"
                },
                "forProcessInstanceId":{
                    "type":"string",
                    "description":"Folder fetched for ProcessInstanceId"
                },
                "folderName":{
                    "type":"string",
                    "description":"Folder Name"
                },
                "type":{
                    "type":"string",
                    "description":"f for folder and d for document"
                },
                "permission":{
                    "type":"string",
                    "description":"Permission"
                }
            }
        }
    ]
}

Nested Schema : Folder-allOf[1]

Type: object

Show Source

• folderId: string
  Folder Id
• folderName: string
  Folder Name
• forProcessInstanceId: string
  Folder fetched for ProcessInstanceId
• permission: string
  Permission
• type: string
  f for folder and d for document

{
    "properties":{
        "folderId":{
            "type":"string",
            "description":"Folder Id"
        },
        "forProcessInstanceId":{
            "type":"string",
            "description":"Folder fetched for ProcessInstanceId"
        },
        "folderName":{
            "type":"string",
            "description":"Folder Name"
        },
        "type":{
            "type":"string",
            "description":"f for folder and d for document"
        },
        "permission":{
            "type":"string",
            "description":"Permission"
        }
    }
}

401 Response

Unauthorized

404 Response

Dynamic-process instance with given id does not exist.

500 Response

Internal Server Error

Back to Top