ORESTAPI model field



Request

ItemDescriptionNotes
endpoint/orestapi/model/fieldDedicated endpoint to get information about fields of a model
typeGET
Header
Authorization

Bearer access_token

See ORESTAPI authorization header


Params
model

the related model

  • string
  • mandatory
  • sample: project.task

Required parameter, if not supplied, the request will be denied

fields

list of fields containing information that should be returned about the fields of the model

  • list of strings
  • optional
  • sample: ["name","field_description","ttype","help"]

if empty, than all information about the fields are returned which can be a huge list

non-existing field names will be ignored

respects model configuration settings

useful fields:

  • name: the technical name of the field
  • field_description: the human readable name of the field
  • ttype: the type of the field (eg: binary, char, text, etc)
  • help: additional information about the field


Response