機械翻訳について

移動先

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

管理フォルダ・メタデータを取得

get

/ic/api/process/v1/process-definitions/{processDefId}/documents/managed-folders

指定されたプロセス定義IDのフォルダ・メタデータ情報を取得します。

ノート:

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

• 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の場合に有効になります。

リクエスト

パス・パラメータ

• processDefId(required): string
  プロセス定義IDの値

問合せパラメータ

• name: string
  指定されたフォルダ名のフォルダのみを取得します。
• startupFlag: boolean
  trueの場合はデフォルトの起動フォルダを返し、それ以外(デフォルト)の場合はすべてのフォルダを返します。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

成功。 フォルダを返します。

本文()

ルート・スキーマ : managed-folders

型: object

ソースを表示

• levels: integer(int32)
• links: array links
• managedFolders: array managed-folders
• title: 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"
        },
        "managedFolders":{
            "type":"array",
            "xml":{
                "name":"managed-folders"
            },
            "items":{
                "xml":{
                    "name":"managed-folders"
                },
                "$ref":"#/definitions/ManagedFolder"
            }
        }
    },
    "xml":{
        "name":"managed-folders",
        "namespace":"http://xmlns.oracle.com/bpm/rest/process-definitions"
    }
}

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

型: array

ソースを表示

• Array of: object Link

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

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

型: array

ソースを表示

• Array of: object ManagedFolder

{
    "type":"array",
    "xml":{
        "name":"managed-folders"
    },
    "items":{
        "xml":{
            "name":"managed-folders"
        },
        "$ref":"#/definitions/ManagedFolder"
    }
}

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

型: object

ソースを表示

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

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

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

型: object

ソースを表示

• levels: integer(int32)
• links: array links
• name: string
• permission: string
• startupFlag: boolean
• title: 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"
        },
        "permission":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "startupFlag":{
            "type":"boolean"
        }
    }
}

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

型: array

ソースを表示

• Array of: object Link

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

401レスポンス

未認可

500レスポンス

Error in retrieving the folder information

先頭に戻る