Overview

Views offer a public access to certain dataflow's data, which can be filtered by a MongoDB request and limited to some columns only.

Routes

Create / Update a view

Request example

curl --location --request POST 'https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/view/VIEW_NAME' \
--header 'X-Parse-Session-Token: Access Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": {"city":"Buenoes Aeres"}
}'  

Response example

Code : 200

[
    {
        "name": "Toulouse",
        "query": {
            "city": "toulouse"
        }
    },
    {
        "name": "buenos",
        "query": {
            "city": "Buenoes Aeres"
        }
    }
]

List documents from a view

Request example

curl --location --request GET 'https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/view/VIEW_NAME/documents' \
--header 'X-Parse-Session-Token: Access Token'

Supported GET parameters :
- perPage : Number of documents per page. Activate paging
- page : Selected page number, from 1.

Example with all parameters

curl --location --request GET 'https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/view/VIEW_NAME/documents?perPage=2&page=1' \
--header 'X-Parse-Session-Token: Access Token'

Response example

Code : 200

{
    "count": 3,
    "documents": [
        {
            "_id": "xxx",
            "name": "Martin",
            "city": "toulouse",
            "updatedAt": "2021-06-03T12:55:13.047Z",
            "firstName": "undefinedbla"
        },
        {
            "_id": "xxx",
            "name": "marie",
            "city": "toulouse",
            "updatedAt": "2021-06-03T10:35:44.818Z"
        }
    ]
}

List views

Request example

curl --location --request GET 'https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/view' \
--header 'X-Parse-Session-Token: Access Token'

Response example

Code : 200

[
    {
        "name": "Toulouse",
        "query": {
            "city": "toulouse"
        }
    },
    {
        "name": "buenos",
        "query": {
            "city": "Buenoes Aeres"
        }
    }
]

Delete a view

Request example

curl --location --request DELETE 'https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/view/buenos' \
--header 'X-Parse-Session-Token: Access Token'

Response example

Code : 200

[
    {
        "name": "Toulouse",
        "query": {
            "city": "toulouse"
        }
    }
]