機械翻訳について

移動先

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

受信ドキュメント・メタデータの取得

get

/ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-documents

指定されたプロセス定義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
  指定されたフォルダ名のフォルダのみを取得します。

トップに戻る

レスポンス

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

• application/json

200レスポンス

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

本文()

ルート・スキーマ : incoming-documents

型: object

ソースを表示

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

ネストされたスキーマ : incoming-documents

型: array

ソースを表示

• Array of: object IncomingDocument

{
    "type":"array",
    "xml":{
        "name":"incoming-documents"
    },
    "items":{
        "xml":{
            "name":"incoming-documents"
        },
        "$ref":"#/definitions/IncomingDocument"
    }
}

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

型: array

ソースを表示

• Array of: object Link

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

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

型: object

ソースを表示

• assetType: string
  許容値: [ "MANAGED_FOLDER", "INCOMING_FOLDER", "INCOMING_DOCUMENT" ]
• defaultPermission: string
  許容値: [ "MANAGER", "CONTRIBUTOR", "DOWNLOADER", "VIEWER", "NONE" ]
• description: string
• displayName: object DisplayName
• entityAttributes: array entityAttributes
• folderId: object FolderId
• name: string
• transientAttributes: object transientAttributes
  許可される追加のプロパティ: additionalProperties

{
    "type":"object",
    "properties":{
        "defaultPermission":{
            "type":"string",
            "enum":[
                "MANAGER",
                "CONTRIBUTOR",
                "DOWNLOADER",
                "VIEWER",
                "NONE"
            ]
        },
        "folderId":{
            "$ref":"#/definitions/FolderId"
        },
        "assetType":{
            "type":"string",
            "enum":[
                "MANAGED_FOLDER",
                "INCOMING_FOLDER",
                "INCOMING_DOCUMENT"
            ]
        },
        "displayName":{
            "$ref":"#/definitions/DisplayName"
        },
        "description":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

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

型: object

ソースを表示

• displayType: string
  許容値: [ "STATIC", "XPATH" ]
• displayValue: string
• entityAttributes: array entityAttributes
• transientAttributes: object transientAttributes
  許可される追加のプロパティ: additionalProperties

{
    "type":"object",
    "properties":{
        "displayValue":{
            "type":"string"
        },
        "displayType":{
            "type":"string",
            "enum":[
                "STATIC",
                "XPATH"
            ]
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object AttrObject

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

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

型: object

ソースを表示

• entityAttributes: array entityAttributes
• folderIdType: string
  許容値: [ "STATIC", "XPATH" ]
• folderIdValue: string
• transientAttributes: object transientAttributes
  許可される追加のプロパティ: additionalProperties

{
    "type":"object",
    "properties":{
        "folderIdValue":{
            "type":"string"
        },
        "folderIdType":{
            "type":"string",
            "enum":[
                "STATIC",
                "XPATH"
            ]
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

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

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

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

型: array

ソースを表示

• Array of: object AttrObject

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

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

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

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

型: object

ソースを表示

• attrType: string
  許容値: [ "VALUE", "REF" ]
• contentType: string
  許容値: [ "OBJECT", "NATIVE_OBJECT", "LIST", "SORTED_LIST", "MAP" ]
• defaultValue: object defaultValue
• id: string
• msg: object Msg

{
    "type":"object",
    "properties":{
        "msg":{
            "$ref":"#/definitions/Msg"
        },
        "attrType":{
            "type":"string",
            "enum":[
                "VALUE",
                "REF"
            ]
        },
        "contentType":{
            "type":"string",
            "enum":[
                "OBJECT",
                "NATIVE_OBJECT",
                "LIST",
                "SORTED_LIST",
                "MAP"
            ]
        },
        "id":{
            "type":"string"
        },
        "defaultValue":{
            "type":"object"
        }
    }
}

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

型: object

ネストされたスキーマ : メッセージ

型: object

ソースを表示

• allAvailableTranslationsForProjectLanguages: object allAvailableTranslationsForProjectLanguages
  許可される追加のプロパティ: additionalProperties
• argCount: integer(int32)
• bundleName: string
• bundleShortName: string
• code: string
• detail: string
• imageFile: string
• imageResource: string(url)
• localizedLogMessage: string
• logComponent: string
  許容値: [ "DEFAULT" ]
• mnemonic: string
• nonLocalizedString: string
• string: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "logComponent":{
            "type":"string",
            "enum":[
                "DEFAULT"
            ]
        },
        "argCount":{
            "type":"integer",
            "format":"int32"
        },
        "string":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "allAvailableTranslationsForProjectLanguages":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "mnemonic":{
            "type":"string"
        },
        "localizedLogMessage":{
            "type":"string"
        },
        "imageFile":{
            "type":"string"
        },
        "imageResource":{
            "type":"string",
            "format":"url"
        },
        "nonLocalizedString":{
            "type":"string"
        },
        "bundleShortName":{
            "type":"string"
        },
        "bundleName":{
            "type":"string"
        }
    }
}

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

型: object

使用可能なその他のプロパティ

ソースを表示

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

型: object

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

型: array

ソースを表示

• Array of: object AttrObject

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

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

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

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

型: object

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

型: object

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

型: object

ソースを表示

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

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

401レスポンス

未認可

500レスポンス

Error in retrieving the folder information

先頭に戻る