機械翻訳について

移動先

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

タスクのDOCフォルダ詳細の取得

get

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

タスクに関連付けられたDOCフォルダ(ある場合)を取得します。

ノート:

プロセス・アプリケーションがドキュメントまたは添付ファイルを使用するかどうかは、アプリケーションの構成によって異なります。

• Oracle Content and Experience(documents)が有効な場合、アプリケーションはドキュメントのみを使用でき、添付ファイルのAPI操作は適用されません。
• Oracle Content and Experience(documents)が有効でない場合、アプリケーションは添付ファイルのみを使用でき、文書のAPI操作は適用されません。

Oracle Content and Experience(documents)がプロセス・アプリケーションで有効かどうかを識別するには、API /ic/api/process/v1/processes/{processId} を使用してプロセス・インスタンスの詳細を取得します。 Oracle Content and Experience(documents)は、パラメータisDoCSEnabled=trueの場合に有効になります。

リクエスト

パス・パラメータ

• id(required): string
  タスク番号

問合せパラメータ

• name: string
  指定されたフォルダ名のフォルダのみを取得します。

トップに戻る

レスポンス

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

• application/json

200レスポンス

成功

本文()

ルート・スキーマ : DcsFolderCollection

型: object

ソースを表示

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

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

型: array

ソースを表示

• Array of: object DcsFolder

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

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

型: array

ソースを表示

• Array of: object Link

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

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

型: object

ソースを表示

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

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

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

型: object

ソースを表示

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

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

型: array

ソースを表示

• Array of: object Link

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

400レスポンス

不正なリクエスト

401レスポンス

未認可

404レスポンス

DoCs Folders not found for given task

500レスポンス

内部サーバー・エラー

先頭に戻る