Workflow REST API: Retrieve available workflows

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
//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 workflows operation. Your URL will likely be different.
string operationEndPoint = @"https://k2.denallix.com/api/workflow/v1/workflows";

//retrieve the authenticated user's available workflows 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
Workflows workflows = new Workflows();

//Deserialize the response into the workflow object, using the Workflows_WorkflowsContract.Workflows data contract.
using (System.IO.MemoryStream memstream = new MemoryStream(Encoding.UTF8.GetBytes(response))) {
 System.Runtime.Serialization.Json.DataContractJsonSerializer serializer = new DataContractJsonSerializer(workflows.GetType());
memstream.Position = 0;
 workflows = (Workflows) serializer.ReadObject(memstream);
}
//do something with each item in the collection of workflows that the user has rights to
foreach (Workflow workflow in workflows.K2Workflows) {
 Console.WriteLine("Workflow ID: " + workflow.Id.ToString());
 Console.WriteLine("Workflow Name: " + workflow.Name);
 Console.WriteLine("Folder: " + workflow.Folder);
 Console.WriteLine("System Name: " + workflow.SystemName);
 if (workflow.Name == "Sample Workflow REST API") {
  sampleWorkflowDefinitionId = workflow.Id;
 }
 Console.WriteLine("**************");
}

//Data contract classes for the workflows operation
namespace WorkflowRestAPISamples.Workflows_WorkflowsContract
{
    //collection of workflows returned from the GET /workflows endpoint.
    [System.Runtime.Serialization.DataContract]
    public class Workflows
    {
        [DataMember(Name = "itemCount")]
        public long ItemCount
        { get; set; }

        [DataMember(Name = "workflows")]
        public List<Workflow> K2Workflows
        { get; set; }
    }

    //Workflow object returned from the GET /workflows endpoint.
    [System.Runtime.Serialization.DataContract]
    public partial class Workflow
    {
        [DataMember(Name = "id")]
        public int Id
        { get; set; }

        [DataMember(Name = "defaultVersionId")]
        public int DefaultVersionId
        { get; set; }

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

        [DataMember(Name = "folder")]
        public string Folder
        { get; set; }

        [DataMember(Name = "systemName")]
        public string SystemName
        { get; set; }
    }
}