This API method allows you to retrieve details of existing workflow statuses from your CustomerGauge system.


Returns workflow details based on CustomerGauge record id.


Resource Information

Response formatsJSON (default), XML
HTTP methodGET
Response familyworkflow
Header
Authorization: api_key XXXXX



Resource URL


Europe Production Server:

https://api.eu.customergauge.com/v4.1/workflow.json


Parameters


number_customergauge
required
CustomerGauge id (this is the record number)
Example Values: 12
date_range_from 
 optional
Filter the data from date
 Example Values: 2012-09-01
date_range_to
 optional
Filter the data to date
 Example Values: 2012-10-01
status
 optional
Filter data by status
Example Values: OPEN, CLOSE, PROGRESS


Example Requests


GET (json)https://api.eu.customergauge.com/v4.1/workflow.json?number_customergauge=26&date_range_from=2012-11-09&date_range_to=2012-11-19&status=CLOSE


GET (xml)https://api.eu.customergauge.com/v4.1/workflow.xml?number_customergauge=26&date_range_from=2012-11-09&date_range_to=2012-11-19&status=CLOSE



Example Result

Message reported on successful operation:




1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22




{"Data":[
       {
          "AssignedTo":"",
          "Comment":"",
          "Date":"2012-11-12 21:25:55",
          "Status":"OPEN",
          "User":"API"
       },
       {  "AssignedTo":"des.patch@directness.net",
          "Comment":"",
          "Date":"2012-11-12 21:25:55",
          "Status":null,
          "User":"API"
       },
       {  "AssignedTo":"",
          "Comment":"please work on this issue",
          "Date":"2012-11-12 21:25:55",
          "Status":null,
          "User":"API"
       }
      ]
   }




Message reported on failed operation:




1




{"Error":{"Message":"Workflow not found","Code":400200}}