Update

Modifying existing entity records. It allows you to add new tags, remove existing tags, and modify tag values.

Details

  • URL: /api/updateRec

  • Method: POST

  • Request Data Params: A grid of records containing all entity records to be updated on the server.

    Column Required Kind Value description
    id ref An id of the entitiy to update. Can be either UUID or fqname
    Any other tag e.g. name, elec, his one or more (any) Corresponding tag value
  • Response: A grid with a row for each entity updated. Each row corresponds to the request grid and its respective row ordering.


Examples

Change Entity description

  • Request
    POST /api/updateRec HTTP/1.1
    Host: example.on.widesky.cloud
    Authorization: Bearer <authToken>
    Accept: application/json
    Content-Type: application/json
    
    {
      "meta": {
        "ver": "2.0"
      },
      "cols": [
        {
          "name": "id"
        },
        {
          "name": "dis"
        }
      ],
      "rows": [
        {
          "id": "r:16978738-34be-42f9-8195-fa9f450e18bf",
          "dis": "s:My new site description"
        }
      ]
    }
    
  • Response
    {
      "meta": {
        "ver": "2.0"
      },
      "cols": [
        {
          "name": "id"
        },
        {
          "name": "name"
        },
        {
          "name": "dis"
        },
        {
          "name": "site"
        },
        {
          "name": "tz"
        }
      ],
      "rows": [
        {
          "id": "r:16978738-34be-42f9-8195-fa9f450e18bf mySite",
          "name": "s:mySite",
          "dis": "s:My new site description",
          "site": "m:",
          "tz": "s:Brisbane"
        }
      ]
    }