DigiOffice API Services Services

<back to all web services

FinishTaskOperation

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

class WorkflowTransitionDTO implements IConvertible
{
    String? ID;
    String? Name;
    bool? AssignmentAtStartWorkflowIsAdHoc;
    bool? AssignmentIsAdHocRequired;
    bool? DeferAtStartWorkflowIsAdHoc;
    bool? IsNext;
    List<int>? UserIDs;
    List<int>? GroupIDs;
    List<int>? RoleIDs;
    DateTime? DeferUntil;
    String? DeferralNote;

    WorkflowTransitionDTO({this.ID,this.Name,this.AssignmentAtStartWorkflowIsAdHoc,this.AssignmentIsAdHocRequired,this.DeferAtStartWorkflowIsAdHoc,this.IsNext,this.UserIDs,this.GroupIDs,this.RoleIDs,this.DeferUntil,this.DeferralNote});
    WorkflowTransitionDTO.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        Name = json['Name'];
        AssignmentAtStartWorkflowIsAdHoc = json['AssignmentAtStartWorkflowIsAdHoc'];
        AssignmentIsAdHocRequired = json['AssignmentIsAdHocRequired'];
        DeferAtStartWorkflowIsAdHoc = json['DeferAtStartWorkflowIsAdHoc'];
        IsNext = json['IsNext'];
        UserIDs = JsonConverters.fromJson(json['UserIDs'],'List<int>',context!);
        GroupIDs = JsonConverters.fromJson(json['GroupIDs'],'List<int>',context!);
        RoleIDs = JsonConverters.fromJson(json['RoleIDs'],'List<int>',context!);
        DeferUntil = JsonConverters.fromJson(json['DeferUntil'],'DateTime',context!);
        DeferralNote = json['DeferralNote'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'Name': Name,
        'AssignmentAtStartWorkflowIsAdHoc': AssignmentAtStartWorkflowIsAdHoc,
        'AssignmentIsAdHocRequired': AssignmentIsAdHocRequired,
        'DeferAtStartWorkflowIsAdHoc': DeferAtStartWorkflowIsAdHoc,
        'IsNext': IsNext,
        'UserIDs': JsonConverters.toJson(UserIDs,'List<int>',context!),
        'GroupIDs': JsonConverters.toJson(GroupIDs,'List<int>',context!),
        'RoleIDs': JsonConverters.toJson(RoleIDs,'List<int>',context!),
        'DeferUntil': JsonConverters.toJson(DeferUntil,'DateTime',context!),
        'DeferralNote': DeferralNote
    };

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

class FinishTaskOperation implements IConvertible
{
    List<int>? TaskIDs;
    String? WSVerbindingID;
    List<WorkflowTransitionDTO>? Transitions;
    DateTime? DeferTo;
    String? Reason;
    String? Comment;

    FinishTaskOperation({this.TaskIDs,this.WSVerbindingID,this.Transitions,this.DeferTo,this.Reason,this.Comment});
    FinishTaskOperation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TaskIDs = JsonConverters.fromJson(json['TaskIDs'],'List<int>',context!);
        WSVerbindingID = json['WSVerbindingID'];
        Transitions = JsonConverters.fromJson(json['Transitions'],'List<WorkflowTransitionDTO>',context!);
        DeferTo = JsonConverters.fromJson(json['DeferTo'],'DateTime',context!);
        Reason = json['Reason'];
        Comment = json['Comment'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TaskIDs': JsonConverters.toJson(TaskIDs,'List<int>',context!),
        'WSVerbindingID': WSVerbindingID,
        'Transitions': JsonConverters.toJson(Transitions,'List<WorkflowTransitionDTO>',context!),
        'DeferTo': JsonConverters.toJson(DeferTo,'DateTime',context!),
        'Reason': Reason,
        'Comment': Comment
    };

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

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

Dart FinishTaskOperation DTOs

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

HTTP + JSV

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

POST /api/workflowtasks/finish HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TaskIDs: 
	[
		0
	],
	WSVerbindingID: 00000000-0000-0000-0000-000000000000,
	DeferTo: 0001-01-01,
	Reason: String,
	Comment: String
}