Update ReportDefinition

PUT

api

sys

reportdefinitions

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/reportdefinitions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "QueryJson": "<string>",
  "RunCount": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/reportdefinitions"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "QueryJson": "<string>",
    "RunCount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    QueryJson: '<string>',
    RunCount: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/reportdefinitions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Updates an existing ReportDefinition record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ReportDefinition-Edit role.

Request Body

Required Fields

integer

required

The Id of the ReportDefinition record to update.

integer

required

ID of the business that owns this report.

string

required

Report name shown in the library.

string

required

ReportQuery JSON document (version 1). Use report_catalog to discover entities and field paths and report_query to test the query before saving..

integer

required

Number of times the report has been run.

Optional Fields

string

Optional description of what the report shows.

string

Folder used to group reports in the library (e.g. Bookings, Billing).

string

VisualizationDocument JSON: { “type”: “table|number|bar|line|area|pie”, “settings”: { … } }.

boolean

Visible to every user of the business; when false only the owner sees it.

integer

User who created the report (set automatically).

string

UTC time the report was last run.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/sys/reportdefinitions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "QueryJson": "",
    "RunCount": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdefinitions',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      QueryJson: '',
      RunCount: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/sys/reportdefinitions',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'QueryJson': '',
        'RunCount': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the reportdefinition was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ReportDefinition was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[email protected]",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update ReportDefinition

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/reportdefinitions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "QueryJson": "<string>",
  "RunCount": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/reportdefinitions"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Name": "<string>",
    "QueryJson": "<string>",
    "RunCount": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    Name: '<string>',
    QueryJson: '<string>',
    RunCount: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/reportdefinitions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400