Retrieve details of tasks from catalog

GET https://{controlplane_path}/api/1/rest/public/catalog/{env_org}/tasks
Retrieve list of tasks in the environment.

Prerequisites

  • Environment (Org) admin permissions

Path parameters

Parameter Description Required
controlplane_path The path to the SnapLogic control plane: elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic. For example:
  • uat.elastic.snaplogic.com
  • emea.snaplogic.com
Yes
env_org The name of the SnapLogic Environment/Org. Yes

Query parameters

None

Response

A successful response includes a Code 200 OK where:
  • list: The list of pipelines.
  • page: The current page of results.
  • content: Each JSON object contains details of the all the Tasks in the Org.
 {
"size": 0,
"page": 0,
"total_pages": 0,
"total_elements": 0,
"sync_status": "",
"content": [
json1, json2, json3
 ]
}

Example

Assuming a task request in a development environment: https://cdn.elastic.snaplogicdev.com/api/1/rest/public/catalog/DEV/tasks


    {
    "size": 2,
    "page": 0,
    "total_pages": 1,
    "total_elements": 2,
    "sync_status": "finished",
    "content": [
                    
    {
    "name": "\"['Test63_adm_2_ _TT', 'quotes and commas']\"_20240625170434501444",
    "path": "DEV/Automation/custom_meta_data_import",
    "job_id": "667adc83b0076ba0f9602c64",
    "enabled": true,
    "schedule": null,
    "pipeline": {
    "name": "SalesForce_To_SnowFlake_Pipeline",
    "sources": [
    {
    "name": "Salesforce"
    }
    ],
    "targets": [],
    "accounts": [],
    "snode_id": "667ad878d789b44de9dbaf8d",
    "pipeline_id": "051433d9-ce2a-4308-aa76-916d8608dcef"
    },
    "type": "triggered",
    "created_by": "[email protected]",
    "created_at": "2024-06-25T15:04:35.483Z",
    "updated_at": "2024-06-25T15:04:35.483Z",
    "snode_id": "667adc832017253a43e3d891",
    "custom_metadata": {
    "customField1": "",
    "customField2": "",
    "customField3": "",
    "custom_field_1": ""
    },
    "operational_data": {
    "total_executions": 0,
    "stopped_executions": 0,
    "successful_executions": 0,
    "failed_executions": 0,
    "execution_failure_rate": 0.0,
    "average_duration_ms": 0,
    "average_docs_processed": 0
    },
    "plex_path": "DEV/shared/Cloud",
    "last_run_date": "1990-01-01T00:00:00.000Z",
    "last_run_status": "-"
    },
    {
    "name": "\"['Test63_adm_2_ _TT2', 'quotes and commas2']\"_20240625170744625027",
    "path": "DEV/Automation/custom_meta_data_import",
    "job_id": "667add42e192042322c72c56",
    "enabled": true,
    "schedule": null,
    "pipeline": {
    "name": "SalesForce_To_SnowFlake_Pipeline",
    "sources": [
    {
    "name": "Salesforce"
    }
    ],
    "targets": [],
    "accounts": [],
    "snode_id": "667ad878d789b44de9dbaf8d",
    "pipeline_id": "051433d9-ce2a-4308-aa76-916d8608dcef"
    },
    "type": "triggered",
    "created_by": "[email protected]",
    "created_at": "2024-06-25T15:07:46.192Z",
    "updated_at": "2024-06-25T15:07:46.192Z",
    "snode_id": "667add427404cf7e83bb70aa",
    "custom_metadata": {
    "customField1": "",
    "customField2": "",
    "customField3": "",
    "custom_field_1": ""
    },
    "operational_data": {
    "total_executions": 0,
    "stopped_executions": 0,
    "successful_executions": 0,
    "failed_executions": 0,
    "execution_failure_rate": 0.0,
    "average_duration_ms": 0,
    "average_docs_processed": 0
    },
    "plex_path": "DEV/shared/Cloud",
    "last_run_date": "1990-01-01T00:00:00.000Z",
    "last_run_status": "-"
    },