REST API for Oracle Integration

機械翻訳について

タスク・ペイロードの取得

get

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

タスクのペイロードを取得します。外部UIタスク・ペイロードの場合、デフォルトで完全なペイロードを取得するか、タイプ=BOの受渡しによりビジネス・ペイロードのみを取得できます

リクエスト

パス・パラメータ

id(required): string

Task Number

問合せパラメータ

type: string

ExternalUIフェッチするペイロード・タイプ。使用可能な値はBOです - ビジネス・ペイロードのみフェッチ、完全 - ペイロードをタスクURLでフェッチします。

デフォルト値: FULL

許容値: [ "BO", "FULL" ]

トップに戻る

レスポンス

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

application/json

200レスポンス

成功

ルート・スキーマ : payload

型: object

ソースを表示

comment: string
levels: integer(int32)
links: array links
priority: integer(int32)
summaryFields: array summaryFields
title: string
xmlPayload: 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"
        },
        "summaryFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GenericMap"
            }
        },
        "comment":{
            "type":"string"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "xmlPayload":{
            "type":"string"
        }
    },
    "xml":{
        "name":"payload",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

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

型: array

ソースを表示

Array of: object Link

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

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

型: array

ソースを表示

Array of: object genericMap

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

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

型: object

ソースを表示

href: string
mediaType: string
rel: string

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

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

型: object

ソースを表示

category: string
dataType: string
displayName: string
name: string
readOnly: string
value: string

{
    "type":"object",
    "properties":{
        "dataType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "readOnly":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "category":{
            "type":"string"
        }
    },
    "xml":{
        "name":"genericMap",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

400レスポンス

不正リクエスト

401レスポンス

未認可

404レスポンス

タスクのペイロードが見つからない

409レスポンス

競合

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、RESTリソースに対するGETリクエストを使用してタスク・ペイロードを取得する方法を示しています。

リクエストの送信

https://example.com/ic/api/process/v1/tasks/<taskId>/payload/

説明

example.com は、Oracle Integrationが実行されているホストです。
<taskId>は、「タスク・リストを取得」を使用して取得するタスクIDです。

レスポンス・ヘッダーの例

Status Code: 200 OK
Date: Wed, 27 Apr 2016 00:53:16 GMT
Content-Type: application/json

レスポンス本文の例

次の例は、webフォームのレスポンス本文を示しています:

<payload xmlns="http://xmlns.oracle.com/bpel/workflow/task">
<TravelRequestForm xmlns:def="http://xmlns.oracle.com/bpm/webform/formsData/travelRequestForm"
xsi:type="def:TravelRequestFormBOType"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://xmlns.oracle.com/bpel/workflow/task">
<p0:TravelRequestForm xmlns:p0="http://www.frevvo.com/schemas/_xndRMEEiEeWNS89tuvw3FQ">
<FirstName xmlns="">test</FirstName>
<LastName xmlns="">j</LastName>
<Email xmlns="">test@oracle.com</Email>
<StartDateOfTravel xmlns="">2016-08-03</StartDateOfTravel>
<EndDateOfTravel xmlns="">2016-08-03</EndDateOfTravel>
<dateValidationError xmlns="">End date of travel cannot be earlier than start date of travel</dateValidationError>
<EstimatedCostOfTravel xmlns="">22</EstimatedCostOfTravel>
<Justification xmlns="">22</Justification>
</p0:TravelRequestForm>
</TravelRequestForm>
</payload>

ノート:

WebフォームはXML形式のペイロード・レスポンスを返します
値application/jsonのAcceptヘッダーが「リクエスト」ヘッダーに渡された場合、webフォームはJSON形式のペイロード・レスポンスを返します。

先頭に戻る