Liking cljdoc? Tell your friends :D

milia.api.dataset


add-tagsclj/s

(add-tags dataset-id tags)

Add tags to a dataset

Add tags to a dataset
sourceraw docstring

add-xls-reportclj/s

(add-xls-report dataset-id uuid filename)

Add xls report link to dataset

Add xls report link to dataset
sourceraw docstring

allclj/s

(all username)

Return all the datasets for an account.

Return all the datasets for an account.
sourceraw docstring

cloneclj/s

(clone dataset-id username & {:keys [project-id]})

Clone the dataset given by ID into the account with the given username.

Clone the dataset given by ID into the account with the given username.
sourceraw docstring

createclj

(create params)
(create params project-id)

Create a new dataset from a file.

Create a new dataset from a file.
sourceraw docstring

create-xform-meta-permissionsclj/s

(create-xform-meta-permissions dataset-id editor-meta-role dataentry-meta-role)

Integer String String -> Channel HttpResponse

Integer String String -> Channel HttpResponse
sourceraw docstring

csv-importclj

(csv-import dataset-id media-file)

Upload CSV data to existing form

Upload CSV data to existing form
sourceraw docstring

dataclj/s≠

clj
(data dataset-id
      &
      {:keys [format raw? must-revalidate? accept-header query-params data-id
              auth-token]})
cljs
(data dataset-id
      &
      {:keys [format raw? must-revalidate? accept-header query-params data-id
              auth-token]
       :or {:format "json"}})

Return the data associated with a dataset.

Return the data associated with a dataset.
sourceraw docstring

deleteclj/s

(delete dataset-id)

Delete a dataset by ID.

Delete a dataset by ID.
sourceraw docstring

downloadclj

(download dataset-id format & [async data-type export-options])

Download dataset in specified format.

Download dataset in specified format.
sourceraw docstring

download-synchronouslyclj/s

(download-synchronously dataset-id
                        format
                        &
                        {:keys [accept-header submission-id dataview?]})

Download form data in specified format. The synchronicity here refers to the server side. This will still return a channel, not data, in CLJS. The options map (last parameter) has the following keys: :accept-header Defaults to application/json :submission-id The id of the submission whose data the client requires. The function returns data for all submissions if this is not provided. :dataview? Boolean flag indicating whether the data belongs to a filtered dataview

Download form data in specified format. The synchronicity here refers to the
server side. This will still return a channel, not data, in CLJS.
The options map (last parameter) has the following keys:
:accept-header Defaults to application/json
:submission-id The id of the submission whose data the client requires. The
 function returns data for all submissions if this is not provided.
:dataview? Boolean flag indicating whether the data belongs to a filtered
 dataview
sourceraw docstring

download-xls-reportclj/s

(download-xls-report dataset-id meta-id filename)
(download-xls-report dataset-id meta-id filename data-id)

Download xls report from the j2x service

Download xls report from the j2x service
sourceraw docstring

edit-historyclj/s

(edit-history dataset-id instance-id)

Returns a submission's edit history

Returns a submission's edit history
sourceraw docstring

(edit-link username project-id dataset-id instance-id)

Return link to online data entry.

Return link to online data entry.
sourceraw docstring

filename-for-formatclj/s

(filename-for-format dataset-id format)

Return filename taking format special cases into account.

Return filename taking format special cases into account.
sourceraw docstring

filesclj/s

(files instance-id project-id & {:keys [no-cache? dataset-id]})
source

formclj/s

(form dataset-id)
(form dataset-id format)

Download form as JSON string or file in specified format if format passed.

Download form as JSON string or file in specified format if format passed.
sourceraw docstring

(link-xform-or-dataview-as-media object-type object-id media-filename xform-id)

Link xform or dataview as media

Link xform or dataview as media
sourceraw docstring

metadataclj/s

(metadata dataset-id & {:keys [no-cache?]})

Show dataset metadata.

Show dataset metadata.
sourceraw docstring

move-to-projectclj/s

(move-to-project dataset-id project-id)

Move a dataset to a project use account if no owner passed.

Move a dataset to a project use account if no owner passed.
sourceraw docstring

new-form-ownerclj/s

(new-form-owner dataset-id new-owner)

Set a new form owner

Set a new form owner
sourceraw docstring

online-data-entry-linkclj/s

(online-data-entry-link dataset-id)

Return link to online data entry.

Return link to online data entry.
sourceraw docstring

patchclj

(patch dataset-id
       params
       &
       {:keys [suppress-4xx-exceptions?] :or {suppress-4xx-exceptions? true}})

Set the metadata for a dataset using PATCH. Only a subset of the required parameters are needed.

Set the metadata for a dataset using PATCH. Only a subset of the
required parameters are needed.
sourceraw docstring

publicclj/s

(public username)

Return all public datasets for a specific user.

Return all public datasets for a specific user.
sourceraw docstring

recordclj/s

(record dataset-id record-id)

Retrieve a record from the dataset.

Retrieve a record from the dataset.
sourceraw docstring

tagsclj/s

(tags dataset-id)

Returns tags for a dataset

Returns tags for a dataset
sourceraw docstring

type->download-pathclj/s

source

type->endpointclj/s

source

updateclj/s

(update dataset-id params)

Set the metadata for a dataset using PUT. All parameters must be passed.

Set the metadata for a dataset using PUT. All parameters must be passed.
sourceraw docstring

update-form-nameclj/s

(update-form-name dataset-id params)

Update the title of a form

Update the title of a form
sourceraw docstring

update-sharingclj/s

(update-sharing dataset-id username role)

Share dataset with specific user

Share dataset with specific user
sourceraw docstring

update-xform-meta-permissionsclj/s

(update-xform-meta-permissions dataset-id
                               metadata-id
                               editor-meta-role
                               dataentry-meta-role)

Integer Integer String String -> Channel HttpResponse

Integer Integer String String -> Channel HttpResponse
sourceraw docstring

upload-fileclj

(upload-file submission-id file)

Upload metadata file for a submission

Upload metadata file for a submission
sourceraw docstring

upload-mediaclj

(upload-media datasetd-id media-file)

Upload media for a form

Upload media for a form
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close