Pipeline API
This API is used to get list pipeline, get list stage, add pipeline, add stage, edit pipeline, edit stage, etc. in the Sales CRM module.
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 | { “status”: “success”, “data”: [ { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1594882191871, “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “modifiedDate”: 1595043738737, “modifiedBy”: “760e1b75a9b4217cb1d75b714c10e263”, “partial”: null, “name”: “[name]”, “deleted”: null }, { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1594984676015, “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “modifiedDate”: 1594984695094, “modifiedBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “partial”: null, “name”: “[name]”, “deleted”: null } ], “hasMore”: true, “nextIndex”: 2, “prevIndex”: 0, “totalResults”: 14 } |
Add Pipeline
Method | POST |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/add |
Header | Authorization : Bearer [generatedToken] |
Body | Body Example : { “name”: “[pipeline_name]” } |
Status | 200 |
Response | { “status”: “success”, “data”: { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1603187950398, “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “modifiedDate”: 1603187950398, “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “partial”: null, “name”: “[name]”, “deleted”: null }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Edit Pipeline
Method | PUT |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/edit |
Header | Authorization : Bearer [generatedToken] |
Body | Body Example : { “id”: “[id]”, “name”: “[name]” } |
Status | 200 |
Response | { “status”: “success”, “data”: { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1603188226895, “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “modifiedDate”: 1603188226895, “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “partial”: null, “name”: “[name]”, “deleted”: null }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Get Pipeline by Pipeline Id
Method | GET |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/[pipeline_id] |
Header | Authorization : Bearer [generatedToken] pipelineId : [pipeline_id] |
Body | |
Status | 200 |
Response | { “status”: “success”, “data”: { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1603188226895, “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “modifiedDate”: 1603188226895, “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “partial”: null, “name”: “[name]”, “deleted”: null }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Delete Pipeline
Method | PUT |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/delete/[pipeline_id] |
Header | Authorization : Bearer [generatedToken] pipelineId : [pipeline_id] |
Body | |
Status | 200 |
Response | { “status”: “success”, “data”: “Pipeline Deleted”, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Get Stage by Pipeline Id
Method | GET |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/[pipeline_id]/stage |
Header | Authorization : Bearer [generatedToken] pipelineId : [pipeline_id] |
Body | |
Status | 200 |
Response | { “status”: “success”, “data”: [ { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1594882191929, “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “modifiedDate”: 1602230916218, “modifiedBy”: “2e6cb05e5c20f1ffda1a1801128546ef”, “partial”: null, “pipelineId”: “[pipeline_id]”, “name”: “[name_stage]”, “rotten”: false, “rottenDuration”: null, “deleted”: null, “stageSetting”: “{\”lockedStage\”:[]}”, “position”: 0 }, { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1594882191929, “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “modifiedDate”: 1597720033846, “modifiedBy”: “2e6cb05e5c20f1ffda1a1801128546ef”, “partial”: null, “pipelineId”: “[pipeline_id]”, “name”: “[name_stage]”, “rotten”: false, “rottenDuration”: null, “deleted”: null, “stageSetting”: “{\”lockedStage\”:[]}”, “position”: 1 }, { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1594882191929, “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “modifiedDate”: 1597721499513, “modifiedBy”: “2e6cb05e5c20f1ffda1a1801128546ef”, “partial”: null, “pipelineId”: “[pipeline_id]”, “name”: “[name_stage]”, “rotten”: false, “rottenDuration”: null, “deleted”: null, “stageSetting”: “{\”lockedStage\”:[]}”, “position”: 2 }, { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1594882191929, “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “modifiedDate”: 1597321519041, “modifiedBy”: “2e6cb05e5c20f1ffda1a1801128546ef”, “partial”: null, “pipelineId”: “[pipeline_id]”, “name”: “[name_stage]”, “rotten”: false, “rottenDuration”: null, “deleted”: null, “stageSetting”: “{\”lockedStage\”:[]}”, “position”: 3 } ], “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Get Stage by Stage Id
Method | GET |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/stage/[stage_id] |
Header | Authorization : Bearer [generatedToken] stageId : [stage_id] |
Body | |
Status | 200 |
Response | { “status”: “success”, “data”: { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1594882263294, “createdBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “modifiedDate”: 1594882271052, “modifiedBy”: “c04ca68f4c031e5c7cd6d3675b67e3a5”, “partial”: null, “pipelineId”: “[pipeline_id]”, “name”: “”, “rotten”: false, “rottenDuration”: null, “deleted”: true, “stageSetting”: null, “position”: 0 }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Add Stage
Method | POST |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/stage/add/[pipeline_id] |
Header | Authorization : Bearer [generatedToken] pipelineId : [pipeline_id] |
Body | Body Example: { “pipelineId”: “[pipeline_id]”, “name”: “[name_stage]”, “rotten”: true, “rottenDuration”: 0, “position”: [position] } |
Status | 200 |
Response | { “status”: “success”, “data”: “Stage Added”, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Edit Stage
Method | PUT |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/stage/edit |
Header | Authorization : Bearer [generatedToken] |
Body | { “id”: “[id]”, “pipelineId”: “[pipeline_id]”, “name”: “[stage_name]”, “rotten”: true, “rottenDuration”: 0, “position”: [position], “totalDealValue”: 0, “dealCount”: 0 } |
Status | 200 |
Response | { “status”: “success”, “data”: { “id”: “[id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1603191137902, “createdBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “modifiedDate”: 1603191137902, “modifiedBy”: “ac2c37cf90ee51edf54b2e4bc2298e03”, “partial”: null, “pipelineId”: “[pipeline_id]”, “name”: “[update_name]”, “rotten”: true, “rottenDuration”: 0, “deleted”: null, “stageSetting”: null, “position”: [position] }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Delete Stage
Method | PUT |
Media Type | application/json |
URL | http://[server]/dolphin/apiv1/graph/pipelines/stage/delete/[stage_id] |
Header | Authorization : Bearer [generatedToken] stageId : [stage_id] |
Body | |
Status | 200 |
Response | { “status”: “success”, “data”: “Stage Deleted”, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 } |
Last updated