Skip to main content

Edit a domain​

Edits a specific domain 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 domain to edit

  • description object
  • translationId integer

    the translationId of the description item to edit

  • text string

    the description text to edit

  • label object[]

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

  • translationId integer

    the translationId of the domain 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 label. e.g. en, de,...

  • deletedLabels object[]

    array containing all the label to be deleted from the sensor

  • translationId integer

    the translationId of the label to be deleted

  • value string

    the label text itself

  • lang string

    languageCode for the language of the label. e.g. en, de,...

  • phenomenon object[]

    array with the phenomena connected to the domain

  • phenomenon integer

    the id of the phenomenon to connect

  • exists boolean

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

  • deletedPhenomena object[]

    array with the phenomena to be disconnected from the domain

  • phenomenon integer

    the id of the phenomenon to disconnect

  • exists boolean

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

Responses

OK

Schema
  • id integer

    the id of the created domain

  • slug string

    the slug of the created domain

  • validation boolean

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

  • labelId integer

    the id of the created translation item

  • descriptionId integer

    the id of the created translation item