ml-modules.root.data-hub.data-services.entitySearch.exportSearchAsCSV.api Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of marklogic-data-hub Show documentation

Library for Creating an Operational Data Hub on MarkLogic

There is a newer version: 6.1.1

{
    "functionName": "exportSearchAsCSV",
    "description": "Export the results of a saved query as CSV",
    "params": [
        {
            "name": "structuredQuery",
            "datatype": "string"
        },
        {
            "name": "searchText",
            "datatype": "string",
            "nullable" : true
        },
        {
            "name": "queryOptions",
            "datatype": "string"
        },
        {
            "name": "schemaName",
            "datatype": "string"
        },
        {
            "name": "viewName",
            "datatype": "string"
        },
        {
            "name": "limit",
            "datatype": "long",
            "nullable" : true
        },
        {
            "name": "sortOrder",
            "datatype": "array",
            "$javaClass": "com.fasterxml.jackson.databind.node.ArrayNode"
        },
        {
            "name": "columns",
            "datatype": "string",
            "multiple" : true
        }
    ],
    "return": {
        "datatype": "textDocument",
        "$javaClass": "java.io.Reader",
        "description": "Returns the CSV results of Optic API search"
    }
}