Datafile Copy List – Django REST framework

None

» click to learn about Filtering, Ordering and more...

Accepted filters:

- id: ID (exact)
- created: Created (exact)
- modified: Modified (exact)
- name: URI starts with (istartswith)
- description: [invalid name] contains (icontains)
- autocomplete: Autocomplete filter on the name property (exact)
- owner: Owner Username (exact)
- owned_by: Filter on list of owned by group names [OR] (exact)
- public: Public (exact)
- deleted: Deleted (exact)
- deleted_by: Deleted by (exact)
- deleted_date: Deleted date (exact)
- uri: [invalid name] (exact)
- shortname: [invalid name] (exact)
- is_primary_copy: Is primary copy (exact)
- created_by: Created by Username (exact)
- modified_by: Modified by Username (exact)
- dataset_id: [invalid name] (exact)
- project_id: [invalid name] (exact)
- study_id: [invalid name] (exact)
- assay_id: [invalid name] (exact)
- archive_id: Archive (exact)
- datasetcollection_id: [invalid name] (exact)

Advanced Filtering

You can also filter using a json object to process all search parameters. Currently this filter supports the syntax as produced/used by the http://summitroute.github.io/react-structured-filter/ search UI.

Example

?query={"category":"name","operator":"contains","value":"Y00"},
       {"category":"amount","operator":">","value":"10"},
       {"category":"type__name","operator":"exact","value":"ANTIBODY"}

» more info about the query param..

Preset mappings

- datafile: datafile__name
- datasets: datafile__datasets__name
- archive: archive__name
- storagevolume: storagevolume__name
- removed_by: removed_by__username
- shortname: datafile__name
- readtype: <function filter_datafilecopy_by_readtype at 0x7f8b26503010>
- assays: <function filter_datafilecopy_by_assay at 0x7f8b26501090>
- notes: notes__content
- deleted: <function filter_deleted at 0x7f8cbd712440>
- deleted_by: deleted_by__username
- owner: owner__username
- owned_by: owned_by__name
- created_by: created_by__username
- modified_by: modified_by__username

Operators

- ==
- =
- >=
- >
- <=
- <
- contains
- icontains
- exact
- iexact
- startswith
- istartswith
- endswith
- iendswith

Permission filtering

Based on the current logged in user you can filter for objects that have a particular permission set:

- can_change: True/False, show objects that you can change
- can_delete: True/False, show objects that you can delete

# not applicable - will raise NotAcceptable:
- can_view: as this is always True, you can only view items you are allowed to see

Ordering

You can order on practically any field even spanning relations.

# reverse order on owner username
?ordering=-owner

# order on related field
?ordering=category__version

None None

The default modelviewset used in this project


Add JSONPatch like functionality to bulk update items.


### Bulk Delete

This view also allows for one to bulk delete items. The url needs to be appended by ``/bulk_delete/`` and the ids
need to be given by multiple query_params:

```
{current_url}/bulk_delete/?id=<id_1>,id=<id_2>
```

GET /api/v2/data_management/datafilecopies/?format=api&ordering=created

HTTP 200 OK
Allow: GET, POST, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "previous": null,
    "next": null,
    "current": 1,
    "total": 0,
    "total_pages": 1,
    "results": []
}