Archive Process Instances

post

/archives

Archives completed process instances.

• Request
• Response
• Examples

Request

Supported Media Types

• application/xml
• application/json

Body Parameter

Body parameter is composites. Parameters of composites are compositeDN, compositeStates, properties, deleteInstances, and deleteRetention. Parameter of compositeStates is compositeState. Parameter of properties is property. Parameters of property are name and value. Property names are auditPayloadIncluded, auditImageIncluded, taskHistoryIncluded, rulesHistoryIncluded, and notificationAddress.

Root Schema : /paths/~1archives/post/parameters/0/schema

Example 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"
}

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

Body

Root Schema : /paths/~1archives/post/responses/200/schema

Example 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
}

Examples

The following example shows a request body for archiving process instances.

{
    "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"
}

For information about using cURL to send requests, see Use cURL.