DigiOffice API Services Services

<back to all web services

CancelWorkflowOperation

Cancel a workflow.

Requires Authentication
The following routes are available for this service:
POST/api/workflows/cancel
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Cancel a workflow.
*/
// @Api(Description="Cancel a workflow.")
class CancelWorkflowOperation implements IConvertible
{
    /**
    * ID of the workflow to cancel
    */
    // @ApiMember(Description="ID of the workflow to cancel", IsRequired=true)
    int? WorkflowID;

    CancelWorkflowOperation({this.WorkflowID});
    CancelWorkflowOperation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        WorkflowID = json['WorkflowID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'WorkflowID': WorkflowID
    };

    getTypeName() => "CancelWorkflowOperation";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'test_do_services.klokgroep.nl', types: <String, TypeInfo> {
    'CancelWorkflowOperation': TypeInfo(TypeOf.Class, create:() => CancelWorkflowOperation()),
});

Dart CancelWorkflowOperation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/workflows/cancel HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"WorkflowID":0}