PUT api/Equations

Updates an existing Equation

Request Information

URI Parameters

None.

Body Parameters

Equation information to use for the upate

Update_Equation
NameDescriptionTypeAdditional information
ID

integer

None.

Name

string

None.

Description

string

None.

OwnerID

integer

None.

OwnerType

integer

None.

Reference

string

None.

Formula

string

None.

Items

Collection of Update_EquationItem

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "ID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "OwnerID": 1,
  "OwnerType": 1,
  "Reference": "sample string 4",
  "Formula": "sample string 5",
  "Items": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "ShortName": "sample string 3",
      "DisplayIndex": 1
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "ShortName": "sample string 3",
      "DisplayIndex": 1
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Information about the updated Equation

GetEquationsResponse
NameDescriptionTypeAdditional information
Equations

Array of Equations

Collection of Equation

None.

Messages

Array of messages

Collection of Message

None.

ServerInformation

Relevant information regarding the Server

ServerInformation

None.

VersionInformation

Relevant information regarding the API's version

VersionInformation

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "Equations": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "OwnerID": 1,
      "OwnerType": 1,
      "Reference": "sample string 4",
      "Formula": "sample string 5",
      "Items": [
        {
          "ID": 1,
          "Name": "sample string 2",
          "ShortName": "sample string 3",
          "DisplayIndex": 1
        },
        {
          "ID": 1,
          "Name": "sample string 2",
          "ShortName": "sample string 3",
          "DisplayIndex": 1
        }
      ]
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "OwnerID": 1,
      "OwnerType": 1,
      "Reference": "sample string 4",
      "Formula": "sample string 5",
      "Items": [
        {
          "ID": 1,
          "Name": "sample string 2",
          "ShortName": "sample string 3",
          "DisplayIndex": 1
        },
        {
          "ID": 1,
          "Name": "sample string 2",
          "ShortName": "sample string 3",
          "DisplayIndex": 1
        }
      ]
    }
  ],
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:25:10.7347274+10:00",
    "BuildDateUTC": "2025-11-09T21:25:10.7347274+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}