v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Tasks

Get CoreTaskDoc documents

get/materials/tasks/

Query parameters

batch_idstring nullable

Query by batch identifier

Query by batch identifier

batch_id_not_eqstring nullable

Exclude batch identifier

Exclude batch identifier

batch_id_eq_anystring nullable

Query by a comma-separated list of batch identifiers

Query by a comma-separated list of batch identifiers

batch_id_neq_anystring nullable

Exclude a comma-separated list of batch identifiers

Exclude a comma-separated list of batch identifiers

formulastring nullable

Query by formula including anonymized formula or by including wild cards. A comma delimited string list of anonymous formulas or regular formulas can also be provided.

Query by formula including anonymized formula or by including wild cards. A comma delimited string list of anonymous formulas or regular formulas can also be provided.

elementsstring nullable

Query by elements in the material composition as a comma-separated list

Query by elements in the material composition as a comma-separated list

exclude_elementsstring nullable

Query by excluded elements in the material composition as a comma-separated list

Query by excluded elements in the material composition as a comma-separated list

task_idsstring nullable

Comma-separated list of task_ids to query on

Comma-separated list of task_ids to query on

last_updated_minstring date-time nullable

Minimum last updated UTC datetime

Minimum last updated UTC datetime

last_updated_maxstring date-time nullable

Maximum last updated UTC datetime

Maximum last updated UTC datetime

_forwardboolean

Whether to page forward (True) or backward (False) in the search results.

Whether to page forward (True) or backward (False) in the search results.

_pagination_tokenstring

Pagination token for the next set of results.

Pagination token for the next set of results.

_skipinteger

Number of entries to skip in the search.

Number of entries to skip in the search.

_limitinteger

Max number of entries to return in a single query. Limited to 1000.

Max number of entries to return in a single query. Limited to 1000.

_fieldsstring

Fields to project from CoreTaskDoc as a list of comma separated strings. Fields include: nsites elements nelements composition composition_reduced formula_pretty formula_anonymous chemsys volume density density_atomic symmetry batch_id calc_type completed_at dir_name icsd_id input last_updated orig_inputs output run_type structure tags task_id task_type transformations vasp_objects vasp_version

Fields to project from CoreTaskDoc as a list of comma separated strings. Fields include: nsites elements nelements composition composition_reduced formula_pretty formula_anonymous chemsys volume density density_atomic symmetry batch_id calc_type completed_at dir_name icsd_id input last_updated orig_inputs output run_type structure tags task_id task_type transformations vasp_objects vasp_version

_all_fieldsboolean

Include all fields.

Include all fields.

Response

Search for a CoreTaskDoc