プロセス・インスタンスのアーカイブ

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です。

ルート・スキーマ: /paths/~1archives/post/parameters/0/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":"[e-mail]"
            }
        ]
    },
    "deleteInstances":true,
    "deleteRetention":"2014-09-23"
}

レスポンス

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

• application/json
• application/xml

200 レスポンス

成功

本文

ルート・スキーマ: /paths/~1archives/post/responses/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":"[e-mail]"}
            ]},
        "deleteInstances":true,
        "deleteRetention":"2014-09-23"
}

cURLを使用したリクエストの送信の詳細は、「cURLの使用」を参照してください。