Skip to main content

Edit a phenomenon​

Edits a specific phenomenon by the information given in the requestBody

Header Parameters
  • Authorization string required

    Token retrieved from the opensensemap API LogIn

Request Body required
  • id integer

    the id of the phenomenon to edit

  • description object
  • translationId integer

    the translationId of the description to edit

  • text string

    the description text to edit

  • markdown object
  • translationId integer

    the translationId of the markdown to edit

  • text string

    the markdown text to edit

  • label object[]

    array with label objects in different languages specified for the phenomenon to be edited

  • translationId integer

    the translationId of the label to be edited, 'null' if it is a newly created label

  • value string

    the label text itself

  • lang string

    languageCode for the language of the markdown text. e.g. en, de,...

  • deletedLabels object[]

    array containing all the label to be deleted from the phenomena

  • translationId integer

    the translationId of the label to be deleted

  • value string

    the label text itself

  • lang string

    languageCode for the language of the markdown text. e.g. en, de,...

  • domain object[]

    array with the domains connected to the phenomenon

  • domain integer

    the id of the domain to connect

  • exists boolean

    'true' if it is an existing domain connection, 'false' if it is a new domain connection

  • deletedDomains object[]

    array with the domains to be disconnected from the phenomenon

  • domain integer

    the id of the domain to disconnect

  • exists boolean

    'true' if it is an existing domain connection, 'false' if it is a new domain connection

  • unit object[]

    array with the units and ranges the phenomenon is measured in

  • unitUri integer

    the id of the unit to connect

  • min integer

    minimum of the unit range

  • max integer

    maximum of the unit range

  • rovId integer

    the id of the value range the phenomenon is connected to; 'null' if it is a newly created connection and the range object does not exist yet

  • deletedUnits object[]

    array with the units and ranges to be disconnected and deleted from the phenomenon

  • unitUri integer

    the id of the unit to disconnect

  • min integer

    minimum of the unit range

  • max integer

    maximum of the unit range

  • rovId integer

    the id of the value range the phenomenon is connected to

Responses

OK

Schema
  • id integer

    the id of the phenomenon

  • slug string

    the slug of the phenomenon

  • validation boolean

    boolean that is true if the information is validated by an admin

  • labelId integer

    the id of the translation item

  • descriptionId integer

    the id of the translation item

  • markdownId integer

    the id of the translation item