DigiOffice API Services Services

<back to all web services

GetTaskOperation

Get workflow task.

Requires Authentication
The following routes are available for this service:
GET/api/workflowtasks/{TaskID}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class WorkflowTaskActionDTO implements IConvertible
{
    bool? BeginGroup;
    String? DigiOfficeIcon;
    bool? Enabled;
    String? FontAwesomeIcon;
    String? Hint;
    String? Name;
    bool? ShowTextForRootItems;
    String? Text;
    String? Url;
    List<WorkflowTaskActionDTO>? Items;

    WorkflowTaskActionDTO({this.BeginGroup,this.DigiOfficeIcon,this.Enabled,this.FontAwesomeIcon,this.Hint,this.Name,this.ShowTextForRootItems,this.Text,this.Url,this.Items});
    WorkflowTaskActionDTO.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BeginGroup = json['BeginGroup'];
        DigiOfficeIcon = json['DigiOfficeIcon'];
        Enabled = json['Enabled'];
        FontAwesomeIcon = json['FontAwesomeIcon'];
        Hint = json['Hint'];
        Name = json['Name'];
        ShowTextForRootItems = json['ShowTextForRootItems'];
        Text = json['Text'];
        Url = json['Url'];
        Items = JsonConverters.fromJson(json['Items'],'List<WorkflowTaskActionDTO>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BeginGroup': BeginGroup,
        'DigiOfficeIcon': DigiOfficeIcon,
        'Enabled': Enabled,
        'FontAwesomeIcon': FontAwesomeIcon,
        'Hint': Hint,
        'Name': Name,
        'ShowTextForRootItems': ShowTextForRootItems,
        'Text': Text,
        'Url': Url,
        'Items': JsonConverters.toJson(Items,'List<WorkflowTaskActionDTO>',context!)
    };

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

class WorkflowTaskDTO implements IConvertible
{
    int? ID;
    String? Name;
    int? WorkflowID;
    String? WorkflowDescription;
    int? RootWorkflowID;
    String? TransitionID;
    String? TransitionName;
    String? ActivationID;
    int? TypeID;
    String? TypeDescription;
    int? StatusID;
    String? StatusDescription;
    int? UserID;
    bool? Active;
    DateTime? OfferedDate;
    DateTime? AssignedDate;
    DateTime? StartDate;
    DateTime? ExpirationDate;
    int? Order;
    double? Progress;
    DateTime? FinishedDate;
    int? FinishedByUserID;
    String? FinishedDocumentID;
    bool? Read;
    DateTime? DeferDate;
    String? DeferReason;
    String? Reason;
    bool? Urgent;
    String? Status;
    List<WorkflowTaskActionDTO>? AvailableActions;
    List<WorkflowTaskActionDTO>? FinishActions;
    List<WorkflowTaskActionDTO>? CommentActions;
    List<WorkflowTaskActionDTO>? DocumentActions;
    int? NumberOfComments;
    String? RelativeDetailLink;
    int? FirstSideStepID;
    String? FirstSideStepOmschr;
    String? FirstSideStepDetailLink;
    int? IsSideStepOfWorkflowID;
    String? IsSideStepOfWorkflowOmschr;
    String? IsSideStepOfWorkflowDetailLink;
    int? IsSideStepOfTaskID;
    String? IsSideStepOfTaskOmschr;
    String? IsSideStepOfTaskDetailLink;
    int? IsObservedID;
    String? IsObservedOmschr;
    String? IsObservedDetailLink;

    WorkflowTaskDTO({this.ID,this.Name,this.WorkflowID,this.WorkflowDescription,this.RootWorkflowID,this.TransitionID,this.TransitionName,this.ActivationID,this.TypeID,this.TypeDescription,this.StatusID,this.StatusDescription,this.UserID,this.Active,this.OfferedDate,this.AssignedDate,this.StartDate,this.ExpirationDate,this.Order,this.Progress,this.FinishedDate,this.FinishedByUserID,this.FinishedDocumentID,this.Read,this.DeferDate,this.DeferReason,this.Reason,this.Urgent,this.Status,this.AvailableActions,this.FinishActions,this.CommentActions,this.DocumentActions,this.NumberOfComments,this.RelativeDetailLink,this.FirstSideStepID,this.FirstSideStepOmschr,this.FirstSideStepDetailLink,this.IsSideStepOfWorkflowID,this.IsSideStepOfWorkflowOmschr,this.IsSideStepOfWorkflowDetailLink,this.IsSideStepOfTaskID,this.IsSideStepOfTaskOmschr,this.IsSideStepOfTaskDetailLink,this.IsObservedID,this.IsObservedOmschr,this.IsObservedDetailLink});
    WorkflowTaskDTO.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        Name = json['Name'];
        WorkflowID = json['WorkflowID'];
        WorkflowDescription = json['WorkflowDescription'];
        RootWorkflowID = json['RootWorkflowID'];
        TransitionID = json['TransitionID'];
        TransitionName = json['TransitionName'];
        ActivationID = json['ActivationID'];
        TypeID = json['TypeID'];
        TypeDescription = json['TypeDescription'];
        StatusID = json['StatusID'];
        StatusDescription = json['StatusDescription'];
        UserID = json['UserID'];
        Active = json['Active'];
        OfferedDate = JsonConverters.fromJson(json['OfferedDate'],'DateTime',context!);
        AssignedDate = JsonConverters.fromJson(json['AssignedDate'],'DateTime',context!);
        StartDate = JsonConverters.fromJson(json['StartDate'],'DateTime',context!);
        ExpirationDate = JsonConverters.fromJson(json['ExpirationDate'],'DateTime',context!);
        Order = json['Order'];
        Progress = JsonConverters.toDouble(json['Progress']);
        FinishedDate = JsonConverters.fromJson(json['FinishedDate'],'DateTime',context!);
        FinishedByUserID = json['FinishedByUserID'];
        FinishedDocumentID = json['FinishedDocumentID'];
        Read = json['Read'];
        DeferDate = JsonConverters.fromJson(json['DeferDate'],'DateTime',context!);
        DeferReason = json['DeferReason'];
        Reason = json['Reason'];
        Urgent = json['Urgent'];
        Status = json['Status'];
        AvailableActions = JsonConverters.fromJson(json['AvailableActions'],'List<WorkflowTaskActionDTO>',context!);
        FinishActions = JsonConverters.fromJson(json['FinishActions'],'List<WorkflowTaskActionDTO>',context!);
        CommentActions = JsonConverters.fromJson(json['CommentActions'],'List<WorkflowTaskActionDTO>',context!);
        DocumentActions = JsonConverters.fromJson(json['DocumentActions'],'List<WorkflowTaskActionDTO>',context!);
        NumberOfComments = json['NumberOfComments'];
        RelativeDetailLink = json['RelativeDetailLink'];
        FirstSideStepID = json['FirstSideStepID'];
        FirstSideStepOmschr = json['FirstSideStepOmschr'];
        FirstSideStepDetailLink = json['FirstSideStepDetailLink'];
        IsSideStepOfWorkflowID = json['IsSideStepOfWorkflowID'];
        IsSideStepOfWorkflowOmschr = json['IsSideStepOfWorkflowOmschr'];
        IsSideStepOfWorkflowDetailLink = json['IsSideStepOfWorkflowDetailLink'];
        IsSideStepOfTaskID = json['IsSideStepOfTaskID'];
        IsSideStepOfTaskOmschr = json['IsSideStepOfTaskOmschr'];
        IsSideStepOfTaskDetailLink = json['IsSideStepOfTaskDetailLink'];
        IsObservedID = json['IsObservedID'];
        IsObservedOmschr = json['IsObservedOmschr'];
        IsObservedDetailLink = json['IsObservedDetailLink'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'Name': Name,
        'WorkflowID': WorkflowID,
        'WorkflowDescription': WorkflowDescription,
        'RootWorkflowID': RootWorkflowID,
        'TransitionID': TransitionID,
        'TransitionName': TransitionName,
        'ActivationID': ActivationID,
        'TypeID': TypeID,
        'TypeDescription': TypeDescription,
        'StatusID': StatusID,
        'StatusDescription': StatusDescription,
        'UserID': UserID,
        'Active': Active,
        'OfferedDate': JsonConverters.toJson(OfferedDate,'DateTime',context!),
        'AssignedDate': JsonConverters.toJson(AssignedDate,'DateTime',context!),
        'StartDate': JsonConverters.toJson(StartDate,'DateTime',context!),
        'ExpirationDate': JsonConverters.toJson(ExpirationDate,'DateTime',context!),
        'Order': Order,
        'Progress': Progress,
        'FinishedDate': JsonConverters.toJson(FinishedDate,'DateTime',context!),
        'FinishedByUserID': FinishedByUserID,
        'FinishedDocumentID': FinishedDocumentID,
        'Read': Read,
        'DeferDate': JsonConverters.toJson(DeferDate,'DateTime',context!),
        'DeferReason': DeferReason,
        'Reason': Reason,
        'Urgent': Urgent,
        'Status': Status,
        'AvailableActions': JsonConverters.toJson(AvailableActions,'List<WorkflowTaskActionDTO>',context!),
        'FinishActions': JsonConverters.toJson(FinishActions,'List<WorkflowTaskActionDTO>',context!),
        'CommentActions': JsonConverters.toJson(CommentActions,'List<WorkflowTaskActionDTO>',context!),
        'DocumentActions': JsonConverters.toJson(DocumentActions,'List<WorkflowTaskActionDTO>',context!),
        'NumberOfComments': NumberOfComments,
        'RelativeDetailLink': RelativeDetailLink,
        'FirstSideStepID': FirstSideStepID,
        'FirstSideStepOmschr': FirstSideStepOmschr,
        'FirstSideStepDetailLink': FirstSideStepDetailLink,
        'IsSideStepOfWorkflowID': IsSideStepOfWorkflowID,
        'IsSideStepOfWorkflowOmschr': IsSideStepOfWorkflowOmschr,
        'IsSideStepOfWorkflowDetailLink': IsSideStepOfWorkflowDetailLink,
        'IsSideStepOfTaskID': IsSideStepOfTaskID,
        'IsSideStepOfTaskOmschr': IsSideStepOfTaskOmschr,
        'IsSideStepOfTaskDetailLink': IsSideStepOfTaskDetailLink,
        'IsObservedID': IsObservedID,
        'IsObservedOmschr': IsObservedOmschr,
        'IsObservedDetailLink': IsObservedDetailLink
    };

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

/**
* Get workflow task.
*/
// @Api(Description="Get workflow task.")
class GetTaskOperation implements IConvertible
{
    /**
    * ID of the workflow task(s) to return
    */
    // @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
    int? TaskID;

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

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

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

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

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

Dart GetTaskOperation DTOs

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

HTTP + XML

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

GET /api/workflowtasks/{TaskID} HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowTaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs">
  <ActivationID>00000000-0000-0000-0000-000000000000</ActivationID>
  <Active>false</Active>
  <AssignedDate>0001-01-01T00:00:00</AssignedDate>
  <AvailableActions i:nil="true" />
  <CommentActions i:nil="true" />
  <DeferDate>0001-01-01T00:00:00</DeferDate>
  <DeferReason>String</DeferReason>
  <DocumentActions i:nil="true" />
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <FinishActions i:nil="true" />
  <FinishedByUserID>0</FinishedByUserID>
  <FinishedDate>0001-01-01T00:00:00</FinishedDate>
  <FinishedDocumentID>00000000-0000-0000-0000-000000000000</FinishedDocumentID>
  <FirstSideStepDetailLink>String</FirstSideStepDetailLink>
  <FirstSideStepID>0</FirstSideStepID>
  <FirstSideStepOmschr>String</FirstSideStepOmschr>
  <ID>0</ID>
  <IsObservedDetailLink>String</IsObservedDetailLink>
  <IsObservedID>0</IsObservedID>
  <IsObservedOmschr>String</IsObservedOmschr>
  <IsSideStepOfTaskDetailLink>String</IsSideStepOfTaskDetailLink>
  <IsSideStepOfTaskID>0</IsSideStepOfTaskID>
  <IsSideStepOfTaskOmschr>String</IsSideStepOfTaskOmschr>
  <IsSideStepOfWorkflowDetailLink>String</IsSideStepOfWorkflowDetailLink>
  <IsSideStepOfWorkflowID>0</IsSideStepOfWorkflowID>
  <IsSideStepOfWorkflowOmschr>String</IsSideStepOfWorkflowOmschr>
  <Name>String</Name>
  <NumberOfComments>0</NumberOfComments>
  <OfferedDate>0001-01-01T00:00:00</OfferedDate>
  <Order>0</Order>
  <Progress>0</Progress>
  <Read>false</Read>
  <Reason>String</Reason>
  <RelativeDetailLink>String</RelativeDetailLink>
  <RootWorkflowID>0</RootWorkflowID>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Status>String</Status>
  <StatusDescription>String</StatusDescription>
  <StatusID>0</StatusID>
  <TransitionID>00000000-0000-0000-0000-000000000000</TransitionID>
  <TransitionName>String</TransitionName>
  <TypeDescription>String</TypeDescription>
  <TypeID>0</TypeID>
  <Urgent>false</Urgent>
  <UserID>0</UserID>
  <WorkflowDescription>String</WorkflowDescription>
  <WorkflowID>0</WorkflowID>
</WorkflowTaskDTO>