Routes

List documents

Request example

curl -X GET \
  https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/documents \
  -H 'X-Parse-Session-Token: Access Token'

Supported GET parameters :
- perPage : Number of documents per page. Activate paging
- page : Selected page number, from 1.
- where : Serialized & url encoded MongoDB request

Example with all parameters

curl -X GET \
  https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/documents?perPage=2&page=2&where=%7B%22city%22%3A%22toulouse%22%7D \
  -H 'X-Parse-Session-Token: Access Token'

Response example

Code : 200

{
    "count": 5,
    "documents": [
        {
            "_id": "xxx",
            "name": "martin",
            "city": "toulouse",
            "updatedAt": "2021-06-03T12:55:13.047Z",
        }
    ]
}

Create a document

Request example

curl --location --request POST 'https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/documents' \
--header 'X-Parse-Session-Token: Access Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Pedro",
    "city": "Buenos Aeres"
}'

Response example

Code : 200

{
    "name": "Pedro",
    "city": "Buenos Aeres",
    "updatedAt": "2021-06-03T16:58:57.993Z",
    "_id": "xxx"
}

Update a document

Request example

curl --location --request PUT 'https://api.prisme.ai/v1/resources/dataflow/DATAFLOW_ID/documents/DOCUMENT_ID' \
--header 'X-Parse-Session-Token: Access Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Pedro",
    "city": "Buenos"
}'

Response example

Code : 200

{
    "_id": "xxx",
    "name": "Pedro",
    "city": "Buenos"
}

Delete a document

Request example

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

Response example

Code : 204