Skip to content

objectType InterfaceParam

Input parameters for services

InterfaceParamivoa:nonnegativeInteger intf_indexivoa:string nameivoa:string unitivoa:string ucdivoa:string utypeivoa:integer stdivoa:string datatypeivoa:string extended_schemaivoa:string extended_typeivoa:string arraysizeivoa:string delimivoa:string param_useivoa:string param_description

Members

name type mult description
intf_index ivoa:nonnegativeInteger The index of the interface this parameter belongs to.
name ivoa:string The name of the parameter.
unit ivoa:string optional The unit associated with all values in the parameter.
ucd ivoa:string optional A unified content descriptor that describes the scientific content of the parameter.
utype ivoa:string optional An identifier for a role in a data model that the data in this parameter represents.
std ivoa:integer If 1, the meaning and use of this parameter is reserved and defined by a standard model. If 0, it represents a database-specific parameter that effectively extends beyond the standard.
datatype ivoa:string optional The type of the data contained in the parameter.
extended_schema ivoa:string optional An identifier for the schema that the value given by the extended attribute is drawn from.
extended_type ivoa:string optional A custom type for the values this parameter contains.
arraysize ivoa:string optional The shape of the array that constitutes the value, e.g., 4, , 4, 5x4, or 5x*, as specified by VOTable.
delim ivoa:string optional The ivoa:string that is used to delimit elements of an array value when arraysize is not '1'.
param_use ivoa:string optional An indication of whether this parameter is required to be provided for the application or service to work properly (one of required, optional, ignored, or NULL).
param_description ivoa:string optional A free-text description of the parameter's contents.

Containment

This is contained by Resource