Workflow REST API: Retrieve Task List

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
//use a System.Net.Http.HttpClient to send the request.
//TODO: You will have to construct the HttpClient and authentication for the webclient before running the snippet
System.Net.Http.HttpClient k2WebClient;

//construct the endpoint for the tasklist operation. Your URL will likely be different.
string operationEndPoint = @"https://k2.denallix.com/api/workflow/v1/tasks";

//retrieve the authenticated user's task list as JSON
string response = k2WebClient.GetStringAsync(operationEndPoint).Result;
//process the JSON response using a JSON deserializer.
//In this case the built-in .NET DataContractSerializer class (you may want to use JSON.NET instead)
//instantiate the DataContract used to parse the returned JSON worklist
WorkflowRestAPISamples.Tasks_TasklistContract.K2TaskList tasklist = new WorkflowRestAPISamples.Tasks_TasklistContract.K2TaskList();

//Deserialize the response into the tasklist object, using the K2TaskList data contract.
using (System.IO.MemoryStream memstream = new MemoryStream(Encoding.UTF8.GetBytes(response))) {
    System.Runtime.Serialization.Json.DataContractJsonSerializer serializer = new DataContractJsonSerializer(tasklist.GetType());
    memstream.Position = 0;
    tasklist = (WorkflowRestAPISamples.Tasks_TasklistContract.K2TaskList) serializer.ReadObject(memstream);
};

//do something with the collection of tasks in the retrieved task list
foreach (WorkflowRestAPISamples.Tasks_TasklistContract.K2TaskListTask task in tasklist.K2Tasks) {
    Console.WriteLine("Folio: " + task.WorkflowInstanceFolio);
    Console.WriteLine("Serial Number: " + task.SerialNumber);
};

//DataContract for the task list and tasks within the task list
namespace WorkflowRestAPISamples.Tasks_TasklistContract
{
    // Tasklist/worklist data contract for the /tasks endpoint
    [System.Runtime.Serialization.DataContract]
    public class K2TaskList
    {
        [DataMember(Name = "itemCount")]
        public long ItemCount
        { get; set; }

        [DataMember(Name = "tasks")]
        public List<K2TaskListTask> K2Tasks
        { get; set; }
    }

    // Task object defined as it comes back for the K2 Tasklist call.
    [System.Runtime.Serialization.DataContract]
    public class K2TaskListTask
    {
        [DataMember(Name = "instruction")]
        public string Instruction
        { get; set; }

        [DataMember(Name = "activityName")]
        public string ActivityName
        { get; set; }

        [DataMember(Name = "activityInstanceDestinationID")]
        public long ActivityInstanceDestinationID
        { get; set; }

        [DataMember(Name = "actions")]
        public K2TaskListTaskActions Actions
        { get; set; }

        [DataMember(Name = "activityInstanceID")]
        public long ActivityInstanceID
        { get; set; }

        [DataMember(Name = "eventName")]
        public string EventName
        { get; set; }

        [DataMember(Name = "eventDescription")]
        public string EventDescription
        { get; set; }

        [DataMember(Name = "formURL")]
        public string FormURL
        { get; set; }

        [DataMember(Name = "status")]
        public string Status
        { get; set; }

        [DataMember(Name = "workflowDisplayName")]
        public string WorkflowDisplayName
        { get; set; }

        [DataMember(Name = "priority")]
        public long Priority
        { get; set; }

        [DataMember(Name = "originator")]
        public K2TaskListOriginator Originator
        { get; set; }

        [DataMember(Name = "serialNumber")]
        public string SerialNumber
        { get; set; }

        [DataMember(Name = "viewFlowURL")]
        public string ViewFlowURL
        { get; set; }

        [DataMember(Name = "taskStartDate")]
        public string TaskStartDate
        { get; set; }

        [DataMember(Name = "workflowCategory")]
        public string WorkflowCategory
        { get; set; }

        [DataMember(Name = "workflowInstanceFolio")]
        public string WorkflowInstanceFolio
        { get; set; }

        [DataMember(Name = "workflowID")]
        public long WorkflowID
        { get; set; }

        [DataMember(Name = "workflowInstanceID")]
        public long WorkflowInstanceID
        { get; set; }

        [DataMember(Name = "workflowName")]
        public string WorkflowName
        { get; set; }

    }

    [DataContract]
    public class K2TaskListTaskActions
    {
        [DataMember(Name = "nonBatchableActions")]
        public List<object> NonBatchableActions
        { get; set; }

        [DataMember(Name = "batchableActions")]
        public List<string> BatchableActions
        { get; set; }

        [DataMember(Name = "systemActions")]
        public List<string> SystemActions
        { get; set; }
    }

    [DataContract]
    public class K2TaskListOriginator
    {
        [DataMember(Name = "email")]
        public string Email
        { get; set; }

        [DataMember(Name = "manager")]
        public string Manager
        { get; set; }

        [DataMember(Name = "displayName")]
        public string DisplayName
        { get; set; }

        [DataMember(Name = "fqn")]
        public string Fqn
        { get; set; }

        [DataMember(Name = "username")]
        public string Username
        { get; set; }
    }
}