milia.api.dataset — onaio/milia 0.9.3-rc2

add-tags clj/s

(add-tags dataset-id tags)

Add tags to a dataset

add-xls-report clj/s

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

Add xls report link to dataset

all clj/s

(all username)

Return all the datasets for an account.

clone clj/s

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

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

create clj

(create params)

(create params project-id)

Create a new dataset from a file.

create-multiple-submission-reviews clj/s

(create-multiple-submission-reviews {:keys [status instances note]})

Create a submission review

create-submission-review clj/s

(create-submission-review {:keys [status instance note]})

Create a submission review

create-xform-meta-permissions clj/s

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

Integer String String -> Channel HttpResponse

data clj/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.

delete clj/s

(delete dataset-id)

Delete a dataset by ID.

delete-submission-review clj/s

(delete-submission-review instance)

download clj

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

Download dataset in specified format.

download-synchronously clj/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-xls-report clj/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

edit-history clj/s

(edit-history dataset-id instance-id)

Returns a submission's edit history

edit-link clj/s

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

Return link to online data entry.

file-ext-query-param-map clj/s

file-import clj

(file-import dataset-id {:keys [filename] :as media-file} & [overwrite?])

Import csv or xls file data to existing form

filename-for-format clj/s

(filename-for-format dataset-id format)

Return filename taking format special cases into account.

files clj/s

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

filter-submission-review-by-instance clj/s

(filter-submission-review-by-instance {:keys [instance status note]})

form clj/s

(form dataset-id)

(form dataset-id format)

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

get-media-file-extension clj/s

(get-media-file-extension filename)

get-submission-review clj/s

(get-submission-review submission-review-id)

Get a submission review

link-xform-or-dataview-as-media clj/s

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

Link xform or dataview as media

list-submission-reviews clj/s

(list-submission-reviews)

List a submission review

metadata clj/s

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

Show dataset metadata.

move-to-project clj/s

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

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

new-form-owner clj/s

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

Set a new form owner

online-data-entry-link clj/s

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

Return link to online data entry.

patch clj

(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.

public clj/s

(public username)

Return all public datasets for a specific user.

record clj/s

(record dataset-id record-id)

Retrieve a record from the dataset.

tags clj/s

(tags dataset-id)

Returns tags for a dataset

type->download-path clj/s multimethod

type->endpoint clj/s multimethod

update clj/s

(update dataset-id params)

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

update-form-name clj/s

(update-form-name dataset-id params)

Update the title of a form

update-sharing clj/s

(update-sharing dataset-id username role)

Share dataset with specific user

update-submission-review clj/s

(update-submission-review {:keys [submission-review-id status note]})

Update a submission review

update-xform-meta-permissions clj/s

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

Integer Integer String String -> Channel HttpResponse

upload-file clj

(upload-file submission-id file)

Upload metadata file for a submission

upload-media clj

(upload-media datasetd-id media-file)

Upload media for a form