プロセス・インスタンスのアーカイブ
post
/archives
完了したプロセス・インスタンスをアーカイブします。
リクエスト
サポートされているメディア・タイプ
- application/xml
- application/json
本文パラメータはcompositesです。compositesのパラメータは、compositeDN、compositeStates、properties、deleteInstancesおよびdeleteRetentionです。compositeStatesのパラメータはcompositeStateです。propertiesのパラメータはpropertyです。propertyのパラメータはnameとvalueです。プロパティ名は、auditPayloadIncluded、auditImageIncluded、taskHistoryIncluded、rulesHistoryIncludedおよびnotificationAddressです。
ルート・スキーマ: schema
リクエストの例(application/json)
{
"composites":{
"compositeDN":[
"development/SimpleUserTaskSample!12.0*soa_974c4e61-d978-4736-add1-8cab2acf6ebb"
]
},
"compositeStates":{
"compositeState":[
"4",
"5",
"6",
"7",
"8",
"9",
"10"
]
},
"properties":{
"property":[
{
"name":"auditPayloadIncluded",
"value":true
},
{
"name":"auditImageIncluded",
"value":true
},
{
"name":"taskHistoryIncluded",
"value":true
},
{
"name":"rulesHistoryIncluded",
"value":"true"
},
{
"name":"notificationAddress",
"value":"john.steinbeck@example.com"
}
]
},
"deleteInstances":true,
"deleteRetention":"2014-09-23"
}
レスポンス
サポートされているメディア・タイプ
- application/json
- application/xml
200レスポンス
成功
ルート・スキーマ: schema
レスポンスの例(application/json)
{
"levels":1,
"links":[
{
"href":"http://example.com/bpm/api/3.0/",
"length":0,
"rel":"back"
},
{
"href":"http://example.com/bpm/api/3.0/archives",
"length":0,
"rel":"self"
}
],
"title":"Archive requests for jstein",
"archives":[
{
"href":"http://example.com/bpm/api/3.0/archives/401",
"length":0,
"rel":"self",
"id":"401",
"state":"COMPLETED",
"requester":"jstein"
},
{
"href":"http://example.com/bpm/api/3.0/archives/501",
"length":0,
"rel":"self",
"id":"501",
"state":"COMPLETED",
"requester":"jstein"
}
],
"archiveCount":2
}
例
次の例に、プロセス・インスタンスをアーカイブするためのリクエスト本文を示します。
{ "composites":{ "compositeDN":["development/SimpleUserTaskSample!12.0*soa_974c4e61-d978-4736-add1-8cab2acf6ebb"]}, "compositeStates":{"compositeState":["4","5","6","7","8","9","10"]}, "properties":{ "property":[ {"name":"auditPayloadIncluded","value":true}, {"name":"auditImageIncluded","value":true}, {"name":"taskHistoryIncluded","value":true}, {"name":"rulesHistoryIncluded","value":"true"}, {"name":"notificationAddress","value":"john.steinbeck@example.com"} ]}, "deleteInstances":true, "deleteRetention":"2014-09-23" }
cURLを使用したリクエストの送信の詳細は、「cURLの使用」を参照してください