...
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
org | String | Required. The name of the Org. | N/A | DevOrg |
start | Integer | The start timestamp in milliseconds. | N/A | 1426809189000 |
end | Integer | The start timestamp in milliseconds. | N/A | 1426852861000 |
offset | Integer | The start point of the records. | 0 | 0 |
limit | Integer | The maximum number of runtimes to return in a query. The maximum possible is 1000. | 10 | 25 |
last_hours | Integer | Returns data for last n hours. The maximum limit is 2160 hours (90 days). | 1 | 48 |
pipe_name | String | Returns data for a particular Pipeline. | N/A | test pipeline |
org_wide | Boolean | Returns data for whole org including all phases. | N/A | global prod |
state | String | Indicates one of the following Pipeline states.
| N/A | Started |
invoker | String | Returns data for users who invoke the API call with this parameter. Invoker. The type of triggering mechanism for the Pipeline (case sensitive)
| N/A | invoker=scheduled |
plex_label | String | Returns the runtime information for a particular Snaplex label. | N/A | east plex |
cc_label | String | Returns the information for a particular cc label (JCC node’s hostname). | N/A | node 2 |
user_id | String | Returns information for particular users. | N/A | user_id=user_a@example.com,user_b@example.com |
project_path | String | Returns the runtime information for particular project.
| N/A | /Snaplogic/projects/test_project |
mode | String | Indicates one of the two following modes for the Pipeline:
| N/A | Standard |
Request Example
Panel |
---|
GET /api/1/rest/public/runtime/dev_org2?snaplogic?offset=0 |
Response Example
Code Block |
---|
{ "response_map": { "entries": [ { "cc_label "pipe_id": "canxl-jcc1729cd6375-b460-4456-8fa7-08a85756394f", "documents": 56894, "userhas_idlints": "username@example.com"false, "ccid": "550b27a34c345d2157d11a57", "parent_pipeline"documents": null1, "runtime_path_id": "snaplogic/rt/cloud/dev", "parentuser_ruuidid": null"schelluri@snaplogic.com", "subpipes": {}, "state_timestamp"ccid": "2015-03-19T23:21:16.094000+00:0060af8acdf0bb32d4cf1a6371", "label": "file_descriptors", "state"child_has_lints": "Completed"false, "create_time": "2015-03-19T23:21:01.959000+00:00", "invoker "runtime_path_id": "scheduledsnaplogic/rt/cloud/dev", "pipe_fqid": "0e601294-8506-466c-8e19-da76e0e4bceb", "id"parent_ruuid": "5e80c4a052e99318640a9a03d8681d0d_e929e44c-771ff513-44cb4fe4-a353984e-1cecd91b1501a8a37533cc23", "runtime_label": "cloud3835" "subpipes": {}, ] "total": 213, "limit"state_timestamp": 10,"2021-06-11T21:03:45.685000+00:00", "offset "error_documents": 0, }, "http_status_code": 200 } |
Viewing Information on Specific Pipeline Runtimes
Endpoint
GET /api/1/rest/public/runtime/<Org>/<ruuid>?
Description
Returns Pipeline information for the specified Runtime ID (ruuid).
Parameters
...
The level of detail:
Summary or Detail.
...
Request Example
Panel |
---|
GET /api/1/rest/public/runtime/DevOrg/5ed97bd3-8de0-4957-946b-437bd3bc0172 |
...
Code Block |
---|
{ "response_map":{ "entries":[ { "label": "SUB - Generic Parameters for Pipelines", "path_id": "/snaplogic/projects/projects-Production-VerizonProd", "state": "Completed", "create_time": "2021-06-11T21:03:45.685000+00:00", "invoker": "nested_pipeline", "duration": 0, "cc_label": "pa22sl-jcc-04c336c2838755d63", "id": "52e99318640a9a03d8681d0d_0daa1437-bc43-46ec-8858-1e95cc1887d2", "runtime_label": "cloud-dev", "mode": "standard" }, { "pipe_id": "f1988c3f-265a-4168-919e-b67275297b82", "has_lints": false, "documents": 0, "user_id": "schelluri@snaplogic.com", "ccid": "60af8acdf0bb32d4cf1a6371", "child_has_lints": false, "runtime_path_id": "snaplogic/rt/cloud/dev", "parent_ruuid": "52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0b", "subpipes": {}, "state_timestamp": "2021-06-11T20:36:37.495000+00:00", "error_documents": 0, "label": "Internal - Join and Aggregate", "path_id": "/snaplogic/projects/projects-Production-VerizonProd", "state": "Failed", "create_time": "2021-06-11T20:36:37.495000+00:00", "invoker": "nested_pipeline", "duration": 0, "cc_label": "pa22sl-jcc-04c336c2838755d63", "id": "52e99318640a9a03d8681d0d_665d5ce2-7fe3-4789-8dee-ce8a089d2509", "runtime_label": "cloud-dev", "mode": "standard" }, { "pipe_id": "f1988c3f-265a-4168-919e-b67275297b82", "has_lints": false, "documents": 0, "user_id": "schelluri@snaplogic.com", "ccid": "60af8acdf0bb32d4cf1a6371", "child_has_lints": false, "runtime_path_id": "snaplogic/rt/cloud/dev", "pipeparent_idruuid": "29cd637552e99318640a9a03d8681d0d_1af484cb-b460f380-44564941-8fa7ad27-08a85756394fd6e6c04c2a0b", "has_lints":false, "subpipes": {}, "documents":1, "userstate_idtimestamp":"schelluri@snaplogic.com", "2021-06-11T20:36:37.489000+00:00", "ccid":"60af8acdf0bb32d4cf1a6371",error_documents": 0, "child_has_lintslabel":false, "Internal - Join and Aggregate", "runtime_path_id":"snaplogic/rt/cloud/dev", "parentpath_ruuidid":"52e99318640a9a03d8681d0d_e929e44c-f513-4fe4-984e-a8a37533cc23 "/snaplogic/projects/projects-Production-VerizonProd", "subpipes":{ "state": "Failed", "create_time": "2021-06-11T20:36:37.489000+00:00", }, "state_timestampinvoker":"2021-06-11T21:03:45.685000+00:00 "nested_pipeline", "error_documents "duration": 0, "cc_label": "SUB - Generic Parameters for Pipelines",pa22sl-jcc-04c336c2838755d63", "path_id":"/snaplogic/projects/projects-Production-VerizonProd "52e99318640a9a03d8681d0d_b9ed5a7b-e02c-446b-b2c2-8f9214ece448", "state "runtime_label": "Completedcloud-dev", "create_time "mode":"2021-06-11T21:03:45.685000+00:00", "standard" "invoker":"nested_pipeline"}, "duration":0,{ "ccpipe_labelid": "pa22sl-jcc-04c336c2838755d63",f1988c3f-265a-4168-919e-b67275297b82", "id":"52e99318640a9a03d8681d0d_0daa1437-bc43-46ec-8858-1e95cc1887d2"has_lints": false, "documents": 0, "runtimeuser_labelid":"cloud-dev "schelluri@snaplogic.com", "modeccid": "standard60af8acdf0bb32d4cf1a6371", }, "child_has_lints": false, { "piperuntime_path_id":"f1988c3f-265a-4168-919e-b67275297b82", "snaplogic/rt/cloud/dev", "hasparent_lintsruuid":false, "52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0b", "documentssubpipes":0 {}, "userstate_idtimestamp":"schelluri@snaplogic.com", "2021-06-11T20:36:37.477000+00:00", "ccid":"60af8acdf0bb32d4cf1a6371", "childerror_has_lintsdocuments":false 0, "runtime_path_id":"snaplogic/rt/cloud/dev", "label": "Internal - Join and Aggregate", "parent_ruuid":"52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0b", "subpipespath_id":{ "/snaplogic/projects/projects-Production-VerizonProd", "state": "Failed", }, "statecreate_timestamptime": "2021-06-11T20:36:37.495000477000+00:00", "error_documents":0, "invoker": "nested_pipeline", "labelduration":"Internal 0, - Join and Aggregate", "pathcc_idlabel":"/snaplogic/projects/projects-Production-VerizonProd "pa22sl-jcc-04c336c2838755d63", "stateid":"Failed", "52e99318640a9a03d8681d0d_7b6c36a2-0f44-4839-8d82-19a6ec7548b9", "createruntime_timelabel": "2021-06-11T20:36:37.495000+00:00",cloud-dev", "invokermode": "nested_pipelinestandard", "duration":0,}, { "cc_label":"pa22sl-jcc-04c336c2838755d63", "pipe_id": "52e99318640a9a03d8681d0d_665d5ce2f1988c3f-7fe3265a-47894168-8dee919e-ce8a089d2509b67275297b82", "runtimehas_labellints":"cloud-dev", false, "modedocuments":"standard" 0, }, "user_id": "schelluri@snaplogic.com", { "pipe_idccid":"f1988c3f-265a-4168-919e-b67275297b82", "60af8acdf0bb32d4cf1a6371", "child_has_lints": false, "documents":0 "runtime_path_id": "snaplogic/rt/cloud/dev", "userparent_idruuid":"schelluri@snaplogic.com", "52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0b", "ccidsubpipes":"60af8acdf0bb32d4cf1a6371", {}, "child_has_lints":falsestate_timestamp": "2021-06-11T20:36:37.453000+00:00", "runtimeerror_path_iddocuments":"snaplogic/rt/cloud/dev" 0, "parent_ruuid "label": "52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0bInternal - Join and Aggregate", "subpipes":{ "path_id": "/snaplogic/projects/projects-Production-VerizonProd", "state": "Failed", }, "statecreate_timestamptime": "2021-06-11T20:36:37.489000453000+00:00", "error_documents":0 "invoker": "nested_pipeline", "labelduration":"Internal 0, - Join and Aggregate", "pathcc_idlabel":"/snaplogic/projects/projects-Production-VerizonProd", "pa22sl-jcc-04c336c2838755d63", "stateid":"Failed "52e99318640a9a03d8681d0d_5dd5e8c4-2a57-48ae-baaa-e61d2fca5903", "createruntime_timelabel": "2021-06-11T20:36:37.489000+00:00cloud-dev", "invokermode": "nested_pipelinestandard", "duration":0}, "cc_label":"pa22sl-jcc-04c336c2838755d63",{ "pipe_id": "52e99318640a9a03d8681d0d_b9ed5a7b29cd6375-e02cb460-446b4456-b2c28fa7-8f9214ece44808a85756394f", "runtimehas_labellints":"cloud-dev" false, "modedocuments":"standard" 0, }, "user_id": {"schelluri@snaplogic.com", "pipe_idccid":"f1988c3f-265a-4168-919e-b67275297b82", "60af8acdf0bb32d4cf1a6371", "child_has_lints": false, "documents":0, "runtime_path_id": "snaplogic/rt/cloud/dev", "userparent_idruuid":"schelluri@snaplogic.com", "52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0b", "ccidsubpipes":"60af8acdf0bb32d4cf1a6371" {}, "childstate_has_lints":false,timestamp": "2021-06-11T20:36:37.448000+00:00", "runtimeerror_path_iddocuments":"snaplogic/rt/cloud/dev" 0, "parent_ruuid":"52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0b", "label": "SUB - Generic Parameters for Pipelines", "subpipes":{ "path_id": "/snaplogic/projects/projects-Production-VerizonProd", }"state": "Failed", "statecreate_timestamptime": "2021-06-11T20:36:37.477000448000+00:00", "error_documents":0, "invoker": "nested_pipeline", "duration": 0, "cc_label":"Internal - Join and Aggregate", "pa22sl-jcc-04c336c2838755d63", "path_id":"/snaplogic/projects/projects-Production-VerizonProd "52e99318640a9a03d8681d0d_0e705bf1-06bd-4d15-bc37-18b73992e120", "state "runtime_label": "Failedcloud-dev", "create_timemode":"2021-06-11T20:36:37.477000+00:00", "standard" "invoker":"nested_pipeline",}, { "duration":0, "ccpipe_labelid": "pa22sl-jcc-04c336c2838755d63",5913896a-6661-4f51-a0c5-d651e3fec3eb", "id":"52e99318640a9a03d8681d0d_7b6c36a2-0f44-4839-8d82-19a6ec7548b9"has_lints": false, "runtime_label":"cloud-dev", "documents": 0, "modeuser_id": "standardadube@snaplogic.com", }, "ccid": "60af8acdf0bb32d4cf1a6371", { "pipechild_has_idlints":"f1988c3f-265a-4168-919e-b67275297b82" false, "has_lints "runtime_path_id":false, "snaplogic/rt/cloud/dev", "documents":0, "parent_ruuid": null, "user_id":"schelluri@snaplogic.com", "ccidsubpipes":"60af8acdf0bb32d4cf1a6371", {}, "childstate_has_lints":false,timestamp": "2021-06-11T21:03:38.225000+00:00", "runtimeerror_path_iddocuments":"snaplogic/rt/cloud/dev" 0, "parent_ruuid":"52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0b", "label": "HTTP Router", "subpipes":{ "path_id": "/snaplogic/Akhilesh/Snaplogic", "state": "Failed", }, "statecreate_timestamptime": "2021-06-11T2011T21:3603:37.453000225000+00:00", "error_documents":0, "invoker": "always_on", "labelduration":"Internal 20, - Join and Aggregate", "pathcc_idlabel":"/snaplogic/projects/projects-Production-VerizonProd", "pa22sl-jcc-04c336c2838755d63", "stateid":"Failed "52e99318640a9a03d8681d0d_37a3a034-3096-4297-ba95-cbe9aa7c78a6", "createruntime_timelabel": "2021-06-11T20:36:37.453000+00:00",cloud-dev", "invokermode": "nested_pipelinestandard", "duration":0}, "cc_label":"pa22sl-jcc-04c336c2838755d63",{ "pipe_id": "52e99318640a9a03d8681d0d_5dd5e8c45913896a-2a576661-48ae4f51-baaaa0c5-e61d2fca5903d651e3fec3eb", "runtimehas_labellints":"cloud-dev", false, "modedocuments":"standard" 0, }, "user_id": {"adube@snaplogic.com", "pipe_idccid":"29cd6375-b460-4456-8fa7-08a85756394f "60af8acdf0bb32d4cf1a6371", "child_has_lints": false, "documents":0, "runtime_path_id": "snaplogic/rt/cloud/dev", "userparent_idruuid":"schelluri@snaplogic.com", null, "ccidsubpipes":"60af8acdf0bb32d4cf1a6371", {}, "childstate_has_lints":falsetimestamp": "2021-06-11T20:58:44.116000+00:00", "runtimeerror_path_iddocuments":"snaplogic/rt/cloud/dev", 0, "parent_ruuidlabel":"52e99318640a9a03d8681d0d_1af484cb-f380-4941-ad27-d6e6c04c2a0b "HTTP Router", "subpipes":{ "path_id": "/snaplogic/Akhilesh/Snaplogic", "state": "Failed", }, "statecreate_timestamptime": "2021-06-11T20:3658:3721.448000116000+00:00", "error_documents":0, "invoker": "always_on", "labelduration":"SUB -26, Generic Parameters for Pipelines", "pathcc_idlabel":"/snaplogic/projects/projects-Production-VerizonProd "pa22sl-jcc-04c336c2838755d63", "stateid":"Failed", "52e99318640a9a03d8681d0d_e39b48a7-1505-4090-b71e-1cea6f36638e", "createruntime_timelabel": "2021-06-11T20:36:37.448000+00:00",cloud-dev", "invokermode": "nested_pipelinestandard", "duration":0}, "cc_label":"pa22sl-jcc-04c336c2838755d63",{ "pipe_id": "52e99318640a9a03d8681d0d_0e705bf15913896a-06bd6661-4d154f51-bc37a0c5-18b73992e120d651e3fec3eb", "runtimehas_labellints":"cloud-dev", false, "mode":"standard" }"documents": 0, { "pipe"user_id":"5913896a-6661-4f51-a0c5-d651e3fec3eb", "adube@snaplogic.com", "has_lintsccid":false "60af8acdf0bb32d4cf1a6371", "documents "child_has_lints":0 false, "user "runtime_path_id":"adube@snaplogic.com "snaplogic/rt/cloud/dev", "ccid":"60af8acdf0bb32d4cf1a6371" "parent_ruuid": null, "child_has_lints":false "subpipes": {}, "runtimestate_path_idtimestamp":"snaplogic/rt/cloud/dev", "2021-06-11T20:52:57.956000+00:00", "parenterror_ruuiddocuments":null 0, "subpipeslabel":{ "HTTP Router", "path_id": "/snaplogic/Akhilesh/Snaplogic", },"state": "Failed", "statecreate_timestamptime": "2021-06-11T2111T20:0352:3856.225000956000+00:00",", "invoker": "always_on", "error_documentsduration":0 17, "cc_label":"HTTP Router "pa22sl-jcc-04c336c2838755d63", "path_id":"/snaplogic/Akhilesh/Snaplogic", "52e99318640a9a03d8681d0d_4b0ac276-3c37-4029-895d-9489172a6471", "stateruntime_label": "Failedcloud-dev", "create_timemode":"2021-06-11T21:03:37.225000+00:00", "standard" }, { "invoker":"always_on", "durationpipe_id":20 "5913896a-6661-4f51-a0c5-d651e3fec3eb", "cchas_labellints":"pa22sl-jcc-04c336c2838755d63" false, "iddocuments":"52e99318640a9a03d8681d0d_37a3a034-3096-4297-ba95-cbe9aa7c78a6", 0, "runtimeuser_labelid":"cloud-dev "adube@snaplogic.com", "modeccid": "standard60976b35ff8ab1a0fa5cfe02", }, "child_has_lints": false, { "piperuntime_path_id":"5913896a-6661-4f51-a0c5-d651e3fec3eb", "snaplogic/rt/cloud/dev", "hasparent_lintsruuid":false null, "documentssubpipes":0 {}, "userstate_idtimestamp":"adube@snaplogic.com "2021-06-11T20:47:53.905000+00:00", "ccid":"60af8acdf0bb32d4cf1a6371" "error_documents": 0, "child_has_lints":false, "label": "HTTP Router", "runtime_path_id": "/snaplogic/rtAkhilesh/cloud/devSnaplogic", "parent_ruuid "state":null, "Failed", "subpipescreate_time":{ "2021-06-11T20:47:52.905000+00:00", "invoker": "always_on", }, "duration": 17, "state_timestamp":"2021-06-11T20:58:44.116000+00:00", "errorcc_documentslabel":0, "pa22sl-jcc-0db57ce2fd6d7116b", "labelid":"HTTP Router "52e99318640a9a03d8681d0d_796794c4-ebdb-4adb-82e9-096a71bdef5a", "pathruntime_idlabel":"/snaplogic/Akhilesh/Snaplogic", "cloud-dev", "statemode": "Failed",standard" } "create_time":"2021-06-11T20:58:21.116000+00:00", ], "invokertotal":"always_on", 127, "limit": 10, "durationoffset":26, 0 }, "http_status_code": "cc_label":"pa22sl-jcc-04c336c2838755d63", "id":"52e99318640a9a03d8681d0d_e39b48a7-1505-4090-b71e-1cea6f36638e", "runtime_label":"cloud-dev",200 } |
Viewing Information on Specific Pipeline Runtimes
Endpoint
GET /api/1/rest/public/runtime/<Org>/<ruuid>?
Description
Returns Pipeline information for the specified Runtime ID (ruuid).
Parameters
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
org | String | Required. The name of the Org. | N/A | DevOrg |
ruuid | String | The runtime ID for the Pipeline. | N/A | 5b042afda9206611281b7328_abd5b58a-3caf-4b83-bec4-7ffd3ba7fd1u |
level | String | The level of detail: Summary or Detail. | Summary | Detail |
Request Example
Panel |
---|
GET /api/1/rest/public/runtime/DevOrg/5ed97bd3-8de0-4957-946b-437bd3bc0172 |
Response Example
Code Block |
---|
{ "response_map":{ "entries":[ "mode":"standard" { }, "prepare_handoff_timestamp":"2015-03-20T18:50:04.742000+00:00", { "pipefeed_idcall":"5913896a-6661-4f51-a0c5-d651e3fec3eb"false, "hasclass_lintsfqid":false"ab3d6766-1848-4509-8916-4393d88a65ce_3", "documentsduration":0132, "userparent_idruuid":"adube@snaplogic.com"null, "ccidcreate_time":"60af8acdf0bb32d4cf1a63712015-03-20T18:50:02.372000+00:00", "childsnode_has_lintsid":false"54d85e7e4c345d5194e85cfc", "runtimeorg_pathsnode_id":"snaplogic/rt/cloud/dev52b32bdbf17d831ac1750257", "parentenv_ruuidmap":null, "subpipesinstance_version":{1, "user_id":"user@snaplogic.com", }"project_snode_id":"52b7cf69f17d83721b7276e3", "state_timestamp":"2021-06-11T20:52:57.956000+00:00",notification":{ "error_documentsstates":0,[ "label":"HTTP Router",Failed" ], "path_idrecipients":"/snaplogic/Akhilesh/Snaplogic",user7@snaplogic.com" "state":"Failed"}, "create_timelabel":"2021-06-11T20:52:56.956000+00:00Mysql-Redshiftbulkloadtestfeb", "invokerclass_version":"always_on"3, "durationstate":17"Completed", "ccSnaplex_label":"pa22slcloud-jccdev/canxl-04c336c2838755d63jcc1", "idtime_stamp":"52e99318640a9a03d8681d0d_4b0ac2762015-3c37-4029-895d-9489172a647103-20T18:52:15.041000+00:00", "runtimeerror_labellist":"cloud-dev",[ "mode":"standard" }, ], { "pipe_id":"5913896a-6661-4f51-a0c5-d651e3fec3eb""cc_start_ms":1426877404998, "has_lintsinvoker":false"user@snaplogic.com", "documents":0"poll_time_stamp":"2015-03-20T18:52:15.193000+00:00", "user_idccid":"adube@snaplogic.com550c4bbf4c345d21557dd39a", "cciddelivery_options":"60976b35ff8ab1a0fa5cfe02"null, "childcc_hasexternal_lints":falseuri":"http://canxl-jccl.snaplogic.com:8090", "runtime_path_id":"snaplogicSnaplogic/rt/cloud/devcloud2", "parentdocuments_ruuidcount":null100000, "subpipesfailure":{null, "reason":null, }"ruuid":"5b042afda9206611281b7328_abd5b58a-3caf-4b83-bec4-7ffd3ba7fd1u", "state_timestamp":"2021-06-11T20:47:53.905000+00:00"parent_pipeline_fqid":null, "errorcc_end_documentsms":01426877535191, "runtime_label":"HTTP Routercloud-dev", "pathcc_poll_idms":"/snaplogic/Akhilesh/Snaplogic"1426313535190, "stateclass_id":"Failedab3d6766-1848-011-8916-4393d88a65ce", "createstatistics_time_stamp":"20212015-0603-11T2020T18:4750:5202.905000372000+00:00", "cc_prepare_start_ms":1426877404757, "invokerinstance_id":"always_on5ed97bd3-8de0-4957-946b-437bdy950172", "durationparent_pipeline_ruuid":17null, "ccplex_labelpath":"pa22sl-jcc-0db57ce2fd6d7116b/snaplogic/shared/cloud2", "idresolution":"52e99318640a9a03d8681d0d_796794c4-ebdb-4adb-82e9-096a71bdef5a"null, "runtime_label":"cloud-dev"cc_prepare_end_ms":1426852604907, "modepipe_invoker":"standardscheduled" } , ], "total":127http_status_code", "limit":10, 200 "offset":0 },] "http_status_code":200} } |
Pipeline Runtime Field Descriptions
...