Online Docs
English
Tiếng Việt

Get Phase of selected source

Retrieves the list of Phase for each source.

eTask supports 4 types of sources, each of which {source} and {source-id} correspond to _id and source properties in the Get Configured Project endpoint. However, the phase of eSource is using a different endpoint.

1
2
3
4
5
GET api/tasks/getPhase/{source -code}/{source-id}
  --x-appvity-channelId: [ChannelID]  
  -x-appvity-teamid: [TeamID]  
  --Cookie: graphNodeCookie=[ID]  
  --data-binary   [FilterObject] |

URL Endpoint

api/tasks/getPhase/{source -code}/{source-id}

Request Header

1
2
3
--x-appvity-channelId: [ChannelID]
--x-appvity-teamid: [TeamID]
--Cookie: graphNodeCookie=[ID]

Body

No body for this method.

Response

Returns list of phases of a project from source following schema:

1
2
3
4
5
6
7
8
9
10
11
[
  {
    "id": "[PhaseID]",
    "displayName": "[PhaseName]",
    "value": "[PhaseValue]",
    "sprintId": "[SprintID]",
    "attributes": {
      "key": "JJMEOTP-42"
    }
  }
]

“sprintId”: [SprintID] is displayed only when the source code is Jira

Example:

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
[
  {
    "id": "8e364db0-04e4-42c9-9991-2b1eef1a0033",
    "displayName": "Sprint 1",
    "value": "Z Anadea Project\\Sprint 1",
    "attributes": {
      "startDate": "2020-01-01T00:00:00Z",
      "finishDate": "2020-01-31T00:00:00Z",
      "timeFrame": "past"
    }
  },
  {
    "id": "3cf765fb-79cc-48dd-bd40-814ac8e96895",
    "displayName": "Sprint 2",
    "value": "Z Anadea Project\\Sprint 2",
    "attributes": {
      "startDate": "2020-02-03T00:00:00Z",
      "finishDate": "2020-03-04T00:00:00Z",
      "timeFrame": "past"
    }
  },
  {
    "id": "376c6711-356f-4ce7-a1f9-2a0a8e8614ca",
    "displayName": "Sprint 3",
    "value": "Z Anadea Project\\Sprint 3",
    "attributes": {
      "startDate": "2020-03-05T00:00:00Z",
      "finishDate": "2020-04-06T00:00:00Z",
      "timeFrame": "current"
    }
  }
]

Comment

Was this article helpful?
Thanks For Your Feedback
app icon authorize

© Appvity. All rights reserved.

app icon contact us app icon facebook app icon linkedin