機械翻訳について

移動先

• リクエスト
• レスポンス

動的プロセス・インスタンスに関連付けられているフォルダのリストを取得

get

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

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id(required): string
  プロセス・インスタンスId

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : フォルダ

型: object

すべてに一致

ソースを表示

• object CommonModel
  識別子: 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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : CommonModel

型: object

識別子: links

ソースを表示

• links: array links

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

ネストされたスキーマ : Folders-allOf[1]

型: object

ソースを表示

• folders: array folders
• forProcessInstanceId: string
  ProcessInstanceIdのフォルダが取得されました
• isDocsEnabledFlag: boolean
  DoCSが有効な場合、これは真です。

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

ネストされたスキーマ: folders

型: array

ソースを表示

• Array of: object Folder

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

ネストされたスキーマ : Folder

型: object

すべてに一致

ソースを表示

• object CommonModel
  識別子: 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"
                }
            }
        }
    ]
}

ネストされたスキーマ : Folder-allOf[1]

型: object

ソースを表示

• folderId: string
  フォルダID
• folderName: string
  フォルダ名
• forProcessInstanceId: string
  ProcessInstanceIdのフォルダが取得されました
• permission: string
  権限
• type: string
  フォルダの場合はf、ドキュメントの場合はd

{
    "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レスポンス

未認可

404レスポンス

指定したIdの編集プロセス・インスタンスは存在しません。

500レスポンス

内部サーバー・エラー

先頭に戻る