v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Grain Boundaries

Get GrainBoundaryDoc documents

get/materials/grain_boundaries/

Query parameters

material_idsstring nullable

Comma-separated list of material_id values to query on

Comma-separated list of material_id values to query on

sigma_maxinteger nullable

Query for maximum value of sigma

Query for maximum value of sigma

sigma_mininteger nullable

Query for minimum value of sigma

Query for minimum value of sigma

sigmainteger nullable

Value of sigma.

Value of sigma.

sigma_not_eqinteger nullable

Query for sigma being not equal to an exact value

Query for sigma being not equal to an exact value

sigma_eq_anystring

Query for sigma being any of these values. Provide a comma separated list.

Query for sigma being any of these values. Provide a comma separated list.

sigma_neq_anystring

Query for sigma being not any of these values. Provide a comma separated list.

Query for sigma being not any of these values. Provide a comma separated list.

rotation_angle_maxnumber nullable

Query for maximum value of rotation_angle

Query for maximum value of rotation_angle

rotation_angle_minnumber nullable

Query for minimum value of rotation_angle

Query for minimum value of rotation_angle

gb_energy_maxnumber nullable

Query for maximum value of gb_energy

Query for maximum value of gb_energy

gb_energy_minnumber nullable

Query for minimum value of gb_energy

Query for minimum value of gb_energy

w_sep_maxnumber nullable

Query for maximum value of w_sep

Query for maximum value of w_sep

w_sep_minnumber nullable

Query for minimum value of w_sep

Query for minimum value of w_sep

typestring nullable

Grain boundary type.

Grain boundary type.

chemsysstring nullable

Dash-delimited string of elements in the material.

Dash-delimited string of elements in the material.

pretty_formulastring nullable

Formula of the material.

Formula of the material.

gb_planestring nullable

Miller index of the grain boundary plane as comma delimitd integers.

Miller index of the grain boundary plane as comma delimitd integers.

rotation_axisstring nullable

Miller index of the rotation axis as comma delimitd integers.

Miller index of the rotation axis as comma delimitd integers.

_pageinteger

Page number to request (takes precedent over _limit and _skip).

Page number to request (takes precedent over _limit and _skip).

_per_pageinteger

Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000.

Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000.

_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 GrainBoundaryDoc as a list of comma separated strings. Fields include: material_id sigma type rotation_axis gb_plane rotation_angle gb_energy initial_structure final_structure pretty_formula w_sep structure chemsys last_updated

Fields to project from GrainBoundaryDoc as a list of comma separated strings. Fields include: material_id sigma type rotation_axis gb_plane rotation_angle gb_energy initial_structure final_structure pretty_formula w_sep structure chemsys last_updated

_all_fieldsboolean

Include all fields.

Include all fields.

Response

Search for a GrainBoundaryDoc