MeiroDocs
APIMeiro Integrations API

Configurations

+ Parameters

Section: Group Configurations. Base URL: https://api.instance_name.meiro.io/.

Configurations [/workspaces/{workspace_id}/configurations{?limit,offset,order_by,order_dir,load_full_structure}]

List All Configurations [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • load_full_structure (number, optional) - Full data structure return flag

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configurations": [
        {
            "id": 100,
            "user_id": 200,
            "workspace_id": 300,
            "component_id": 400,
            "name": "config name",
            "description": "config description",
            "input_settings": {
                "inputs": {
                    500: {
                        "filters": ["*.csv", "*.json"]
                    }
                }
            },
            "settings": {},
            "oauth_settings": {},
            "frontend_settings": {},
            "continue_on_failure": 0,
            "disabled": 0,
            "deleted": 0,
            "auth_link": "https://oauth-server.link",
            "created": "2017-01-01 15:35:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC"
    }
}

Create a Configuration [POST]

  • Parameters

    • load_full_structure (number, optional) - Full data structure return flag

  • Attributes

    • name: example config (string)
    • component_id: 400 (number)
    • settings: {} (string) - optional (json)
    • input_settings: {"inputs": {"500": {"filters": ["*.csv", "*.json"]}}} (string) - optional (json)
    • description: config description (string) - optional
    • continue_on_failure: 0 (number) - optional
    • disabled: 0 (number) - optional

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 201 (application/json)

{
    "configuration": {
        "id": 100,
        "user_id": 200,
        "workspace_id": 300,
        "component_id": 400,
        "name": "example config",
        "description": "config description",
        "input_settings": {
            "inputs": {
                500: {
                    "filters": ["*.csv", "*.json"]
                }
            }
        },
        "settings": "{}",
        "oauth_settings": {},
        "frontend_settings": {},
        "continue_on_failure": 0,
        "disabled": 0,
        "deleted": 0,
        "auth_link": "https://oauth-server.link",
        "created": "2017-01-01 15:35:00"
    }
}

Update multiple configurations [PATCH]

  • Parameters

    • load_full_structure (number, optional) - Full data structure return flag

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

    • Body

[
    {
        "id": 100,
        "component_id": 400,
        "name": "example config",
        "description": "config description",
        "input_settings": {
            "inputs": {
                500: {
                    "filters": ["*.csv", "*.json"]
                }
            }
        },
        "settings": "{}",
        "frontend_settings": {},
        "continue_on_failure": 0,
        "disabled": 0,
    }
]
  • Response 200 (application/json)
{
    "configurations": [
        {
            "id": 100,
            "user_id": 200,
            "workspace_id": 300,
            "component_id": 400,
            "name": "example config",
            "description": "config description",
            "input_settings": {
                "inputs": {
                    500: {
                        "filters": ["*.csv", "*.json"]
                    }
                }
            },
            "settings": "{}",
            "oauth_settings": {},
            "frontend_settings": {},
            "continue_on_failure": 0,
            "disabled": 0,
            "deleted": 0,
            "auth_link": "https://oauth-server.link",
            "created": "2017-01-01 15:35:00"
        }
    ]
}

Configuration [/workspaces/{workspace_id}/configurations/{configuration_id}{?load_full_structure}]

  • Parameters
    • load_full_structure (number, optional) - Full data structure return flag

Retrieve a Configuration [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration": {
        "id": 100,
        "user_id": 200,
        "workspace_id": 300,
        "component_id": 400,
        "name": "config name",
        "description": "config description",
        "input_settings": {
            "inputs": {
                500: {
                    "filters": ["*.csv", "*.json"]
                }
            }
        },
        "settings": {},
        "oauth_settings": {},
        "frontend_settings": {},
        "continue_on_failure": 0,
        "disabled": 0,
        "deleted": 0,
        "auth_link": "https://oauth-server.link",
        "created": "2017-01-01 15:35:00"
    }
}

Modify a Configuration [PATCH]

  • Attributes

    • name: example config (string)
    • settings: {} (string) - optional (json)
    • input_settings: {"inputs": {"500": {"filters": ["*.csv", "*.json"]}}} (string) - optional (json)
    • description: config description (string) - optional
    • continue_on_failure: 0 (number) - optional
    • disabled: 0 (number) - optional

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration": {
        "configuration": {
        "id": 100,
        "user_id": 200,
        "workspace_id": 300,
        "component_id": 400,
        "name": "example config",
        "description": "config description",
        "input_settings": {
            "inputs": {
                500: {
                    "filters": ["*.csv", "*.json"]
                }
            }
        },
        "settings": {},
        "oauth_settings": {},
        "frontend_settings": {},
        "continue_on_failure": 0,
        "disabled": 0,
        "deleted": 0,
        "auth_link": "https://oauth-server.link",
        "created": "2017-01-01 15:35:00"
    }
    }
}

Delete a Configuration [DELETE]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "message": "OK"
}

Clone Configuration [POST]

  • Attributes

    • workspace_id: 123 (number) - optional

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration": {
        "id": 100,
        "user_id": 200,
        "workspace_id": 300,
        "component_id": 400,
        "name": "clone_example config",
        "description": "config description",
        "input_settings": {
            "inputs": {
                500: {
                    "filters": ["*.csv", "*.json"]
                }
            }
        },
        "settings": {},
        "oauth_settings": {},
        "frontend_settings": {},
        "continue_on_failure": 0,
        "disabled": 0,
        "deleted": 0,
        "auth_link": "https://oauth-server.link",
        "created": "2017-01-01 15:35:00"
    }
}

Configuration's history list [/workspaces/{workspace_id}/configurations/{configuration_id}/history{?limit,offset,order_by,order_dir,load_full_structure}]

Retrieve a Configuration's History List [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • load_full_structure (number, optional) - Full data structure return flag

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "history_list": [
        {
            "id": null,
            "configuration": {
                "id": 200,
                "user_id": 300,
                "workspace_id": 400,
                "component_id": 500,
                "name": "config updated name",
                "description": "config description",
                "input_settings": {
                    "inputs": {
                        500: {
                            "filters": ["*.csv", "*.json"]
                        }
                    }
                },
                "settings": {},
                "oauth_settings": {},
                "frontend_settings": {},
                "continue_on_failure": 0,
                "disabled": 0,
                "created": "2017-01-01 15:35:00"
            },
            "previous_history": {
                "id": 100,
                "configuration": {
                    "id": 200,
                    "user_id": 300,
                    "workspace_id": 400,
                    "component_id": 500,
                    "name": "config name",
                    "description": "config description",
                    "input_settings": {
                        "inputs": {
                            500: {
                                "filters": ["*.csv", "*.json"]
                            }
                        }
                    },
                    "settings": {},
                    "oauth_settings": {},
                    "frontend_settings": {},
                    "continue_on_failure": 0,
                    "disabled": 0,
                    "created": "2017-01-01 11:35:00"
                }
            }
        },
        {
            "id": "100",
            "configuration": {
                "id": 200,
                "user_id": 300,
                "workspace_id": 400,
                "component_id": 500,
                "name": "config name",
                "description": "config description",
                "input_settings": {
                    "inputs": {
                        500: {
                            "filters": ["*.csv", "*.json"]
                        }
                    }
                },
                "settings": {},
                "oauth_settings": {},
                "frontend_settings": {},
                "continue_on_failure": 0,
                "disabled": 0,
                "created": "2017-01-01 11:35:00"
            }
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC"
    }
}

Configuration's history item [/workspaces/{workspace_id}/configurations/{configuration_id}/history/{history_id}{?load_full_structure}]

Retrieve a Configuration's History Item [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "history": {
        "id": "100",
        "configuration": {
            "id": 200,
            "user_id": 300,
            "workspace_id": 400,
            "component_id": 500,
            "name": "config example",
            "description": "config description",
            "input_settings": {
                "inputs": {
                    500: {
                        "filters": ["*.csv", "*.json"]
                    }
                }
            },
            "settings": {},
            "oauth_settings": {},
            "frontend_settings": {},
            "continue_on_failure": 0,
            "disabled": 0,
            "created": "2017-01-01 15:35:00"
        },
        "previous_history": {
            "id": 200,
            "configuration": {
                "id": 200,
                "user_id": 300,
                "workspace_id": 400,
                "component_id": 500,
                "name": "config name",
                "description": "config description",
                "input_settings": {
                    "inputs": {
                        500: {
                            "filters": ["*.csv", "*.json"]
                        }
                    }
                },
                "settings": {},
                "oauth_settings": {},
                "frontend_settings": {},
                "continue_on_failure": 0,
                "disabled": 0,
                "created": "2017-01-01 11:35:00"
            }
        }
    }
}

Revert a Configuration's History Item [PATCH]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration": {
        "id": 100,
        "user_id": 200,
        "workspace_id": 300,
        "component_id": 400,
        "name": "config name",
        "description": "config description",
        "input_settings": {
            "inputs": {
                500: {
                    "filters": ["*.csv", "*.json"]
                }
            }
        },
        "settings": {},
        "oauth_settings": {},
        "frontend_settings": {},
        "continue_on_failure": 0,
        "disabled": 0,
        "created": "2017-01-01 15:35:00"
    }
}

Trashed Configurations [/workspaces/{workspace_id}/configurations/trash{?limit,offset,order_by,order_dir,load_full_structure}]

  • Parameters
    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • load_full_structure (number, optional) - Full data structure return flag

List All Trashed Configurations [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "trashed_configurations": [
        {
            "id": 100,
            "user_id": 200,
            "workspace_id": 300,
            "component_id": 400,
            "name": "config name",
            "description": "config description",
            "input_settings": {
                "inputs": {
                    500: {
                        "filters": ["*.csv", "*.json"]
                    }
                }
            },
            "settings": {},
            "continue_on_failure": 0,
            "disabled": 0,
            "deleted": 1,
            "created": "2017-01-01 15:35:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC"
    }
}

Trashed Configuration [/workspaces/{workspace_id}/configurations/trash/{configuration_id}{?load_full_structure}]

  • Parameters
    • load_full_structure (number, optional) - Full data structure return flag

Restore a Trashed Configuration [PATCH]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration": {
        "configuration": {
        "id": 100,
        "user_id": 200,
        "workspace_id": 300,
        "component_id": 400,
        "name": "example config",
        "description": "config description",
        "input_settings": {
            "inputs": {
                500: {
                    "filters": ["*.csv", "*.json"]
                }
            }
        },
        "settings": {},
        "continue_on_failure": 0,
        "disabled": 0,
        "deleted": 0,
        "created": "2017-01-01 15:35:00"
    }
    }
}

Configuration Jobs [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs{?limit,offset,order_by,order_dir,include_settings,load_full_structure}]

  • Entity's status possible values: waiting, running, finished, error, canceled

List All Configuration Jobs [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • include_settings (number, optional) - If the flag is set to 0, the job's settings is excluded from the response
    • load_full_structure (number, optional) - Full data structure return flag

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration_jobs": [
        {
            "id": 100,
            "user_id": 200,
            "configuration_id": 300,
            "workspace_job_id": 400,
            "status": "waiting",
            "settings": {},
            "stats": {
                "data_volumes": {
                    "/in": 10.0,
                    "/out": 20.0
                },
                "files_count": {
                    "/in": 2,
                    "/out": 3
                },
                "statuses_history": {
                    "waiting": "2017-11-04 07:57:12",
                    "running": "2017-11-04 07:57:14",
                    "finished": "2017-11-04 07:57:20",
                }
            },
            "created": "2017-01-01 15:35:00",
            "origin_created": "2017-01-01 15:30:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC",
        "include_settings": 1
    }
}

Run a Configuration Job [POST]

  • Parameters

    • load_full_structure (number, optional) - Full data structure return flag

  • Attributes

    • workspace_job_id: 400 (number)

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 201 (application/json)

{
    "configuration_job": {
        "id": 100,
        "user_id": 200,
        "configuration_id": 300,
        "workspace_job_id": 400,
        "status": "waiting",
        "settings": {},
        "stats": {
            "data_volumes": {
                "/in": 10.0,
                "/out": 20.0
            },
            "files_count": {
                "/in": 2,
                "/out": 3
            },
            "statuses_history": {
                "waiting": "2017-11-04 07:57:12",
                "running": "2017-11-04 07:57:14",
                "finished": "2017-11-04 07:57:20",
            }
        },
        "created": "2017-01-01 15:35:00"
    }
}

Project Configuration Jobs [/configuration_jobs{?limit,offset,order_by,order_dir,load_full_structure,include_settings,include_deleted_entities_jobs}]

  • Parameters
    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • load_full_structure (number, optional) - Full data structure return flag
    • include_settings (number, optional) - If the flag is set to 0, the job's settings is excluded from the response
    • include_deleted_entities_jobs (number, optional) - Load deleted entities' jobs flag

List All Configuration Jobs in a Project [GET]

  • Entity's status possible values: waiting, running, finished, error, canceled

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration_jobs": [
        {
            "id": 100,
            "user_id": 200,
            "configuration_id": 300,
            "workspace_job_id": 400,
            "status": "waiting",
            "settings": {},
            "stats": {},
            "created": "2017-01-01 15:35:00",
            "origin_created": "2017-01-01 15:30:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC",
        "include_settings": 1
    }
}

Workspace Configuration Jobs [/workspaces/{workspace_id}/configuration_jobs{?limit,offset,order_by,order_dir,include_settings,load_full_structure,include_deleted_configuration_jobs}]

  • Entity's status possible values: waiting, running, finished, error, canceled

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • load_full_structure (number, optional) - Full data structure return flag
    • include_settings (number, optional) - If the flag is set to 0, the job's settings is excluded from the response
    • include_deleted_configuration_jobs (number, optional) - Load deleted configurations' jobs flag

List All Configuration Jobs in a Workspace [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration_jobs": [
        {
            "id": 100,
            "user_id": 200,
            "configuration_id": 300,
            "workspace_job_id": 400,
            "status": "waiting",
            "settings": {},
            "stats": {},
            "created": "2017-01-01 15:35:00",
            "origin_created": "2017-01-01 15:30:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC",
        "include_settings": 1
    }
}

Workspace Job Configuration Jobs [/workspaces/{workspace_id}/jobs/{job_id}/configuration_jobs{?limit,offset,order_by,order_dir,include_settings,load_full_structure,include_deleted_configuration_jobs}]

  • Entity's status possible values: waiting, running, finished, error, canceled

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • load_full_structure (number, optional) - Full data structure return flag
    • include_settings (number, optional) - If the flag is set to 0, the job's settings is excluded from the response
    • include_deleted_configuration_jobs (number, optional) - oad deleted configurations' jobs flag

List All Configuration Jobs in a Workspace Job [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration_jobs": [
        {
            "id": 100,
            "user_id": 200,
            "configuration_id": 300,
            "workspace_job_id": 400,
            "status": "waiting",
            "settings": {},
            "stats": {},
            "created": "2017-01-01 15:35:00",
            "origin_created": "2017-01-01 15:30:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC",
        "include_settings": 1
    }
}

Configurations' Last Jobs [/workspaces/{workspace_id}/configurations/last_jobs{?configuration_ids,load_full_structure}]

  • Entity's status possible values: waiting, running, finished, error, canceled

  • Parameters

    • configuration_ids (array, optional) - Wanted configuration IDs
    • load_full_structure (number, optional) - Full data structure return flag

List Configurations' Last Jobs [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "last_configuration_jobs": [
        {
            "configuration_id": 300,
            "last_job": {
                "id": 100,
                "user_id": 200,
                "configuration_id": 300,
                "workspace_job_id": 400,
                "status": "waiting",
                "settings": {},
                "stats": {
                    "data_volumes": {
                        "/in": 10.0,
                        "/out": 20.0
                    },
                    "files_count": {
                        "/in": 2,
                        "/out": 3
                    },
                    "statuses_history": {
                        "waiting": "2017-11-04 07:57:12",
                        "running": "2017-11-04 07:57:14",
                        "finished": "2017-11-04 07:57:20",
                    }
                },
                "created": "2017-01-01 15:35:00",
                "origin_created": "2017-01-01 15:30:00"
            }
        }
    ],
    "selection_settings": {
        "configuration_ids": [300]
    }
}

Configuration Job [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs/{job_id}{?load_full_structure}]

  • Parameters
    • load_full_structure (number, optional) - Full data structure return flag

Retrieve a Configuration Job [GET]

  • Entity's status possible values: waiting, running, finished, error, canceled

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration_job": {
        "id": 100,
        "user_id": 200,
        "configuration_id": 300,
        "workspace_job_id": 400,
        "status": "waiting",
        "settings": {},
        "stats": {
            "data_volumes": {
                "/in": 10.0,
                "/out": 20.0
            },
            "files_count": {
                "/in": 2,
                "/out": 3
            },
            "statuses_history": {
                "waiting": "2017-11-04 07:57:12",
                "running": "2017-11-04 07:57:14",
                "finished": "2017-11-04 07:57:20",
            }
        },
        "created": "2017-01-01 15:35:00",
        "origin_created": "2017-01-01 15:30:00"
    }
}

Cancel a Configuration Job [DELETE]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "message": "OK"
}

Configuration job's history list [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs/{job_id}/history{?limit,offset,order_by,order_dir,include_settings,load_full_structure}]

  • Entity's status possible values: waiting, running, finished, error, canceled

Retrieve a Configuration job's History List [GET]

  • Parameters

    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • include_settings (number, optional) - If the flag is set to 0, the job's settings is excluded from the response
    • load_full_structure (number, optional) - Full data structure return flag

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "history_list": [
        {
            "id": null,
            "configuration_job": {
                "id": 200,
                "user_id": 300,
                "configuration_id": 400,
                "workspace_job_id": 500,
                "status": "waiting",
                "settings": {},
                "stats": {},
                "created": "2017-01-01 15:35:00"
            },
            "previous_history": {
                "id": 100,
                "configuration_job": {
                    "id": 200,
                    "user_id": 300,
                    "configuration_id": 400,
                    "workspace_job_id": 500,
                    "status": "waiting",
                    "settings": {},
                    "stats": {},
                    "created": "2017-01-01 11:35:00"
                }
            }
        },
        {
            "id": "100",
            "configuration_job": {
                "id": 200,
                "user_id": 300,
                "configuration_id": 400,
                "workspace_job_id": 500,
                "status": "waiting",
                "settings": {},
                "stats": {},
                "created": "2017-01-01 11:35:00"
            }
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC",
        "include_settings": 1
    }
}

Configuration job's history item [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs/{job_id}/history/{history_id}{?load_full_structure}]

Retrieve a Configuration job's History Item [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "history": {
        "id": "100",
        "configuration_job": {
            "id": 200,
            "user_id": 300,
            "configuration_id": 400,
            "workspace_job_id": 500,
            "status": "running",
            "settings": {},
            "stats": {},
            "created": "2017-01-01 15:35:00"
        },
        "previous_history": {
            "id": 200,
            "configuration_job": {
                "id": 200,
                "user_id": 300,
                "configuration_id": 400,
                "workspace_job_id": 500,
                "status": "waiting",
                "settings": {},
                "stats": {},
                "created": "2017-01-01 11:35:00"
            }
        }
    }
}

Configuration Logs [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs/{job_id}/logs{?limit,offset,order_by,order_dir,load_full_structure}]

  • Parameters
    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • order_by (string, optional) - Ordered column name
    • order_dir (string, optional) - Ordering direction
    • load_full_structure (number, optional) - Full data structure return flag

List All Configuration Logs [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configuration_logs": [
        {
            "id": 100,
            "configuration_job_id": 200,
            "level": "info",
            "text": "log text",
            "created": "2017-01-01 15:35:00"
        }
    ],
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "order_by": "id",
        "order_dir": "ASC"
    }
}

Configuration Data [/workspaces/{workspace_id}/configurations/{configuration_id}/data]

Delete Configuration Data [DELETE]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "message": "ok"
}

Configuration input data preview [/workspaces/{workspace_id}/configurations/{configuration_id}/data/input/preview{?load_full_structure,limit,offset,name_filter}]

  • Parameters
    • load_full_structure (number, optional) - Full data structure return flag
    • limit (number, optional) - Limit of the returned input files
    • offset (number, optional) - Offset for the returned input files
    • name_filter (string, optional) - Files' name filter

List Configuration Input Data Previews [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "data_preview": [
        {
            "id": 1,
            "file_name": "in/files/input_file.txt",
            "file_size": 0.09,
            "file_rows_count": "10",
            "last_modified_date": "2017-10-24 10:30:00",
            "first_lines": [
                "This is first line\n",
                "This is second line\n"
            ],
            "file_download_token": "1234567890abcdef",
            "parent_configuration_id": 10
        }
    ],
    "files_total_count": 1,
    "download_token": "1234567890abcdef",
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "name_filter": null
    }
}

Configuration input file preview [/workspaces/{workspace_id}/configurations/{configuration_id}/data/input/preview/{preview_id}{?load_full_structure}]

  • Parameters
    • load_full_structure (number, optional) - Full data structure return flag

Retrieve Configuration Input File Preview [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "input_file_preview": {
        "file_name": "in/files/input_file.txt",
        "file_size": 0.09,
        "file_rows_count": "10",
        "last_modified_date": "2017-10-24 10:30:00",
        "first_lines": [
            "This is first line\n",
            "This is second line\n"
        ],
        "file_download_token": "1234567890abcdef",
        "parent_configuration_id": 10
    }
}

Configuration output data preview [/workspaces/{workspace_id}/configurations/{configuration_id}/data/output/preview{?limit,offset,name_filter}]

  • Parameters
    • limit (number, optional) - Limit of the returned output files
    • offset (number, optional) - Offset for the returned output files
    • name_filter (string, optional) - Files' name filter

List Configuration Output Data Previews [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "data_preview": [
        {
            "id": 1,
            "file_name": "out/files/input_file.txt",
            "file_size": 0.09,
            "file_rows_count": "10",
            "last_modified_date": "2017-10-24 10:30:00",
            "first_lines": [
                "This is first line\n",
                "This is second line\n"
            ],
            "file_download_token": "1234567890abcdef"
        }
    ],
    "files_total_count": 1,
    "download_token": "1234567890abcdef",
    "selection_settings": {
        "limit": 20,
        "offset": null,
        "name_filter": null
    }
}

Configuration output file preview [/workspaces/{workspace_id}/configurations/{configuration_id}/data/output/preview/{preview_id}]

Retrieve Configuration Output File Preview [GET]

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "output_file_preview": {
        "file_name": "in/files/input_file.txt",
        "file_size": 0.09,
        "file_rows_count": "10",
        "last_modified_date": "2017-10-24 10:30:00",
        "first_lines": [
            "This is first line\n",
            "This is second line\n"
        ],
        "file_download_token": "1234567890abcdef"
    }
}

Configuration File [/configuration_file{?file_download_token}]

  • Parameters
    • file_download_token (string) - File download token

Download Configuration File [GET]

  • Response 200 (application/json)

Configuration Input Files [/configuration_input_files{?download_token}]

  • Parameters
    • download_token (string) - Input files download token

Download Configuration Input Files [GET]

  • Response 200 (application/json)

Configuration Output Files [/configuration_output_files{?download_token}]

  • Parameters
    • download_token (string) - Output files download token

Download Configuration Output Files [GET]

  • Response 200 (application/json)

Configuration Settings Search [/configuration_settings_search{?search_text,limit,offset,workspace_id,load_full_structure}]

List Configurations With a Given String in Settings [GET]

  • Parameters

    • search_text (string) - Searched text
    • workspace_id (number, optional) - The search will be performed only in this workspace if the ID is provided
    • limit (number, optional) - Limit of the number of records returned
    • offset (number, optional) - Offset for the number of records returned
    • load_full_structure (number, optional) - Full data structure return flag

  • Request

    • Headers

      X-Access-Token: 1234567890abcdef

  • Response 200 (application/json)

{
    "configurations": [
        {
            "id": 100,
            "user_id": 200,
            "workspace_id": 300,
            "component_id": 400,
            "name": "config name",
            "description": "config description",
            "input_settings": {
                "inputs": {
                    500: {
                        "filters": ["*.csv", "*.json"]
                    }
                }
            },
            "settings": {
                "param": "value"
            },
            "oauth_settings": {},
            "frontend_settings": {},
            "continue_on_failure": 0,
            "disabled": 0,
            "deleted": 0,
            "auth_link": "https://oauth-server.link",
            "created": "2017-01-01 15:35:00"
        }
    ],
    "selection_settings": {
        "search_text": "value",
        "workspace_id": none,
        "limit": 20,
        "offset": null,
    }
}

Components

+ Parameters

OAuth Repositories

+ Parameters

On this page

Configurations [/workspaces/{workspace_id}/configurations{?limit,offset,order_by,order_dir,load_full_structure}]List All Configurations [GET]Create a Configuration [POST]Update multiple configurations [PATCH]Configuration [/workspaces/{workspace_id}/configurations/{configuration_id}{?load_full_structure}]Retrieve a Configuration [GET]Modify a Configuration [PATCH]Delete a Configuration [DELETE]Clone Configuration [POST]Configuration's history list [/workspaces/{workspace_id}/configurations/{configuration_id}/history{?limit,offset,order_by,order_dir,load_full_structure}]Retrieve a Configuration's History List [GET]Configuration's history item [/workspaces/{workspace_id}/configurations/{configuration_id}/history/{history_id}{?load_full_structure}]Retrieve a Configuration's History Item [GET]Revert a Configuration's History Item [PATCH]Trashed Configurations [/workspaces/{workspace_id}/configurations/trash{?limit,offset,order_by,order_dir,load_full_structure}]List All Trashed Configurations [GET]Trashed Configuration [/workspaces/{workspace_id}/configurations/trash/{configuration_id}{?load_full_structure}]Restore a Trashed Configuration [PATCH]Configuration Jobs [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs{?limit,offset,order_by,order_dir,include_settings,load_full_structure}]List All Configuration Jobs [GET]Run a Configuration Job [POST]Project Configuration Jobs [/configuration_jobs{?limit,offset,order_by,order_dir,load_full_structure,include_settings,include_deleted_entities_jobs}]List All Configuration Jobs in a Project [GET]Workspace Configuration Jobs [/workspaces/{workspace_id}/configuration_jobs{?limit,offset,order_by,order_dir,include_settings,load_full_structure,include_deleted_configuration_jobs}]List All Configuration Jobs in a Workspace [GET]Workspace Job Configuration Jobs [/workspaces/{workspace_id}/jobs/{job_id}/configuration_jobs{?limit,offset,order_by,order_dir,include_settings,load_full_structure,include_deleted_configuration_jobs}]List All Configuration Jobs in a Workspace Job [GET]Configurations' Last Jobs [/workspaces/{workspace_id}/configurations/last_jobs{?configuration_ids,load_full_structure}]List Configurations' Last Jobs [GET]Configuration Job [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs/{job_id}{?load_full_structure}]Retrieve a Configuration Job [GET]Cancel a Configuration Job [DELETE]Configuration job's history list [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs/{job_id}/history{?limit,offset,order_by,order_dir,include_settings,load_full_structure}]Retrieve a Configuration job's History List [GET]Configuration job's history item [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs/{job_id}/history/{history_id}{?load_full_structure}]Retrieve a Configuration job's History Item [GET]Configuration Logs [/workspaces/{workspace_id}/configurations/{configuration_id}/jobs/{job_id}/logs{?limit,offset,order_by,order_dir,load_full_structure}]List All Configuration Logs [GET]Configuration Data [/workspaces/{workspace_id}/configurations/{configuration_id}/data]Delete Configuration Data [DELETE]Configuration input data preview [/workspaces/{workspace_id}/configurations/{configuration_id}/data/input/preview{?load_full_structure,limit,offset,name_filter}]List Configuration Input Data Previews [GET]Configuration input file preview [/workspaces/{workspace_id}/configurations/{configuration_id}/data/input/preview/{preview_id}{?load_full_structure}]Retrieve Configuration Input File Preview [GET]Configuration output data preview [/workspaces/{workspace_id}/configurations/{configuration_id}/data/output/preview{?limit,offset,name_filter}]List Configuration Output Data Previews [GET]Configuration output file preview [/workspaces/{workspace_id}/configurations/{configuration_id}/data/output/preview/{preview_id}]Retrieve Configuration Output File Preview [GET]Configuration File [/configuration_file{?file_download_token}]Download Configuration File [GET]Configuration Input Files [/configuration_input_files{?download_token}]Download Configuration Input Files [GET]Configuration Output Files [/configuration_output_files{?download_token}]Download Configuration Output Files [GET]Configuration Settings Search [/configuration_settings_search{?search_text,limit,offset,workspace_id,load_full_structure}]List Configurations With a Given String in Settings [GET]