Sign in

v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Surface Properties

Get SurfacePropDoc documents

get/materials/surface_properties/

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

weighted_surface_energy_EV_PER_ANG2_maxnumber nullable

Query for maximum value of weighted_surface_energy_EV_PER_ANG2

Query for maximum value of weighted_surface_energy_EV_PER_ANG2

weighted_surface_energy_EV_PER_ANG2_minnumber nullable

Query for minimum value of weighted_surface_energy_EV_PER_ANG2

Query for minimum value of weighted_surface_energy_EV_PER_ANG2

weighted_surface_energy_maxnumber nullable

Query for maximum value of weighted_surface_energy

Query for maximum value of weighted_surface_energy

weighted_surface_energy_minnumber nullable

Query for minimum value of weighted_surface_energy

Query for minimum value of weighted_surface_energy

surface_anisotropy_maxnumber nullable

Query for maximum value of surface_anisotropy

Query for maximum value of surface_anisotropy

surface_anisotropy_minnumber nullable

Query for minimum value of surface_anisotropy

Query for minimum value of surface_anisotropy

shape_factor_maxnumber nullable

Query for maximum value of shape_factor

Query for maximum value of shape_factor

shape_factor_minnumber nullable

Query for minimum value of shape_factor

Query for minimum value of shape_factor

weighted_work_function_maxnumber nullable

Query for maximum value of weighted_work_function

Query for maximum value of weighted_work_function

weighted_work_function_minnumber nullable

Query for minimum value of weighted_work_function

Query for minimum value of weighted_work_function

has_reconstructedboolean nullable

Whether an entry or material has a reconstructed surface.

Whether an entry or material has a reconstructed surface.

_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 SurfacePropDoc as a list of comma separated strings. Fields include: surfaces weighted_surface_energy_EV_PER_ANG2 weighted_surface_energy surface_anisotropy pretty_formula shape_factor weighted_work_function has_reconstructed material_id structure

Fields to project from SurfacePropDoc as a list of comma separated strings. Fields include: surfaces weighted_surface_energy_EV_PER_ANG2 weighted_surface_energy surface_anisotropy pretty_formula shape_factor weighted_work_function has_reconstructed material_id structure

_all_fieldsboolean

Include all fields.

Include all fields.

Response

Search for a SurfacePropDoc