# Pipeline API

API ini digunakan untuk mendapatkan daftar pipeline, mendapatkan daftar stage, menambahkan pipeline, menambahkan stage, mengedit pipeline, mengedit stage, dll. pada modul Sales SRM.

### **Get Pipeline**

| Method     | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines?start=0\&count=2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Header     | Authorization : Bearer \[generatedToken]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Body       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: \[<br>   {<br>    “id”: “\[id]”,<br>    “spell”: null,<br>    “owner”: “\[owner\_id]”,<br>    “createdDate”: 1594882191871,<br>    “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>    “modifiedDate”: 1595043738737,<br>    “modifiedBy”: “760e1b75a9b4217cb1d75b714c10e263”,<br>    “partial”: null,<br>    “name”: “\[name]”,<br>    “deleted”: null<br>   },<br>   {<br>    “id”: “\[id]”,<br>    “spell”: null,<br>    “owner”: “\[owner\_id]”,<br>    “createdDate”: 1594984676015,<br>    “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>    “modifiedDate”: 1594984695094,<br>    “modifiedBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>    “partial”: null,<br>    “name”: “\[name]”,<br>    “deleted”: null<br>   }<br>  ],<br>  “hasMore”: true,<br>  “nextIndex”: 2,<br>  “prevIndex”: 0,<br>  “totalResults”: 14<br>}</p> |

### **Add Pipeline**

| Method     | POST                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/add                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Header     | Authorization : Bearer \[generatedToken]                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Body       | <p>Body Example :<br>{<br>  “name”: “\[pipeline\_name]”<br>}</p>                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: {<br>   “id”: “\[id]”,<br>   “spell”: null,<br>   “owner”: “\[owner\_id]”,<br>   “createdDate”: 1603187950398,<br>   “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”,<br>   “modifiedDate”: 1603187950398,<br>   “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”,<br>   “partial”: null,<br>   “name”: “\[name]”,<br>   “deleted”: null<br>  },<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p> |

### **Edit Pipeline**

| Method     | PUT                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/edit                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Header     | Authorization : Bearer \[generatedToken]                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Body       | <p>Body Example :<br>{<br>  “id”: “\[id]”,<br>  “name”: “\[name]”<br>}</p>                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: {<br>  “id”: “\[id]”,<br>   “spell”: null,<br>   “owner”: “\[owner\_id]”,<br>   “createdDate”: 1603188226895,<br>   “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”,<br>   “modifiedDate”: 1603188226895,<br>   “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”,<br>   “partial”: null,<br>   “name”: “\[name]”,<br>   “deleted”: null<br>  },<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p> |

### **Get Pipeline by Pipeline Id**

| Method     | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/\[pipeline\_id]                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>pipelineId : \[pipeline\_id]</p>                                                                                                                                                                                                                                                                                                                                                                                                              |
| Body       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: {<br>   “id”: “\[id]”,<br>   “spell”: null,<br>   “owner”: “\[owner\_id]”,<br>   “createdDate”: 1603188226895,<br>   “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”,<br>   “modifiedDate”: 1603188226895,<br>   “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”,<br>   “partial”: null,<br>   “name”: “\[name]”,<br>  “deleted”: null<br>  },<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p> |

### **Delete Pipeline**

| Method     | PUT                                                                                                                                                              |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                 |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/delete/\[pipeline\_id]                                                                                           |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>pipelineId : \[pipeline\_id]</p>                                                                                  |
| Body       |                                                                                                                                                                  |
| Status     | 200                                                                                                                                                              |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: “Pipeline Deleted”,<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p> |

### **Get Stage by Pipeline Id**

| Method     | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/\[pipeline\_id]/stage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>pipelineId : \[pipeline\_id]</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Body       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: \[<br>   {<br>    “id”: “\[id]”,<br>    “spell”: null,<br>    “owner”: “\[owner\_id]”,<br>    “createdDate”: 1594882191929,<br>    “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>    “modifiedDate”: 1602230916218,<br>    “modifiedBy”: “2e6cb05e5c20f1ffda1a1801128546ef”,<br>    “partial”: null,<br>    “pipelineId”: “\[pipeline\_id]”,<br>    “name”: “\[name\_stage]”,<br>    “rotten”: false,<br>    “rottenDuration”: null,<br>    “deleted”: null,<br>    “stageSetting”: “{\”lockedStage\”:\[]}”,<br>    “position”: 0<br>   },<br>   {<br>    “id”: “\[id]”,<br>    “spell”: null,<br>    “owner”: “\[owner\_id]”,<br>    “createdDate”: 1594882191929,<br>    “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>    “modifiedDate”: 1597720033846,<br>    “modifiedBy”: “2e6cb05e5c20f1ffda1a1801128546ef”,<br>    “partial”: null,<br>    “pipelineId”: “\[pipeline\_id]”,<br>    “name”: “\[name\_stage]”,<br>    “rotten”: false,<br>    “rottenDuration”: null,<br>    “deleted”: null,<br>    “stageSetting”: “{\”lockedStage\”:\[]}”,<br>    “position”: 1<br>   },<br>   {<br>    “id”: “\[id]”,<br>    “spell”: null,<br>    “owner”: “\[owner\_id]”,<br>    “createdDate”: 1594882191929,<br>    “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>    “modifiedDate”: 1597721499513,<br>    “modifiedBy”: “2e6cb05e5c20f1ffda1a1801128546ef”,<br>    “partial”: null,<br>    “pipelineId”: “\[pipeline\_id]”,<br>    “name”: “\[name\_stage]”,<br>    “rotten”: false,<br>    “rottenDuration”: null,<br>    “deleted”: null,<br>    “stageSetting”: “{\”lockedStage\”:\[]}”,<br>    “position”: 2<br>   },<br>   {<br>    “id”: “\[id]”,<br>    “spell”: null,<br>    “owner”: “\[owner\_id]”,<br>    “createdDate”: 1594882191929,<br>    “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>    “modifiedDate”: 1597321519041,<br>    “modifiedBy”: “2e6cb05e5c20f1ffda1a1801128546ef”,<br>    “partial”: null,<br>    “pipelineId”: “\[pipeline\_id]”,<br>    “name”: “\[name\_stage]”,<br>    “rotten”: false,<br>    “rottenDuration”: null,<br>    “deleted”: null,<br>    “stageSetting”: “{\”lockedStage\”:\[]}”,<br>    “position”: 3<br>   }<br>  ],<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p> |

### **Get Stage by Stage Id**

| Method     | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/stage/\[stage\_id]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>stageId : \[stage\_id]</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Body       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: {<br>   “id”: “\[id]”,<br>   “spell”: null,<br>   “owner”: “\[owner\_id]”,<br>   “createdDate”: 1594882263294,<br>   “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>   “modifiedDate”: 1594882271052,<br>   “modifiedBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”,<br>   “partial”: null,<br>   “pipelineId”: “\[pipeline\_id]”,<br>   “name”: “”,<br>   “rotten”: false,<br>   “rottenDuration”: null,<br>   “deleted”: true,<br>   “stageSetting”: null,<br>   “position”: 0<br>  },<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p> |

### **Add Stage**

| Method     | POST                                                                                                                                                                            |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/stage/add/\[pipeline\_id]                                                                                                       |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>pipelineId : \[pipeline\_id]</p>                                                                                                 |
| Body       | <p>Body Example:<br>{<br>  “pipelineId”: “\[pipeline\_id]”,<br>  “name”: “\[name\_stage]”,<br>  “rotten”: true,<br>  “rottenDuration”: 0,<br>  “position”: \[position]<br>}</p> |
| Status     | 200                                                                                                                                                                             |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: “Stage Added”,<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p>                     |

### **Edit Stage**

| Method     | PUT                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/stage/edit                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Header     | Authorization : Bearer \[generatedToken]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Body       | <p>{<br>  “id”: “\[id]”,<br>  “pipelineId”: “\[pipeline\_id]”,<br>  “name”: “\[stage\_name]”,<br>  “rotten”: true,<br>  “rottenDuration”: 0,<br>  “position”: \[position],<br>  “totalDealValue”: 0,<br>  “dealCount”: 0<br>}</p>                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Status     | 200                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: {<br>   “id”: “\[id]”,<br>   “spell”: null,<br>   “owner”: “\[owner\_id]”,<br>   “createdDate”: 1603191137902,<br>   “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”,<br>   “modifiedDate”: 1603191137902,<br>   “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”,<br>   “partial”: null,<br>   “pipelineId”: “\[pipeline\_id]”,<br>   “name”: “\[update\_name]”,<br>   “rotten”: true,<br>   “rottenDuration”: 0,<br>   “deleted”: null,<br>   “stageSetting”: null,<br>   “position”: \[position]<br>  },<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p> |

### **Delete Stage**

| Method     | PUT                                                                                                                                                           |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json                                                                                                                                              |
| URL        | http\://\[server]/dolphin/apiv1/graph/pipelines/stage/delete/\[stage\_id]                                                                                     |
| Header     | <p>Authorization : Bearer \[generatedToken]<br>stageId : \[stage\_id]</p>                                                                                     |
| Body       |                                                                                                                                                               |
| Status     | 200                                                                                                                                                           |
| Response   | <p>{<br>  “status”: “success”,<br>  “data”: “Stage Deleted”,<br>  “hasMore”: false,<br>  “nextIndex”: 0,<br>  “prevIndex”: 0,<br>  “totalResults”: 0<br>}</p> |
