PUT v1/bunits/{bunitId}/consolequeries/{consoleQueryId}

Update a console query

Request Information

URI Parameters

Name	Description	Type	Additional information
`bunitId`		integer	Required
`consoleQueryId`		integer	Required

Body Parameters

ConsoleQuery

Name	Description	Type	Additional information
`Query`	The query to be used in the console	string	Required.
`Description`	A description of the query	string	None.
`Favorite`	Whether or not the console query is a favorite for the current user	boolean	None.
`Id`	A unique ID for the object.	integer	Read-only.
`CreatedDate`	Time and date the object was created.	date	Read-only.
`ArchivedDate`	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<ConsoleQuery xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>4</Id>
  <CreatedDate>2024-09-18T05:28:37.8955149+02:00</CreatedDate>
  <ArchivedDate>2024-09-18T05:28:37.8955149+02:00</ArchivedDate>
  <Query>sample string 1</Query>
  <Description>sample string 2</Description>
  <Favorite>true</Favorite>
</ConsoleQuery>

Response Information

Resource Description

ConsoleQuery

Name	Description	Type	Additional information
`Query`	The query to be used in the console	string	Required.
`Description`	A description of the query	string	None.
`Favorite`	Whether or not the console query is a favorite for the current user	boolean	None.
`Id`	A unique ID for the object.	integer	Read-only.
`CreatedDate`	Time and date the object was created.	date	Read-only.
`ArchivedDate`	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<ConsoleQuery xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>4</Id>
  <CreatedDate>2024-09-18T05:28:37.8955149+02:00</CreatedDate>
  <ArchivedDate>2024-09-18T05:28:37.8955149+02:00</ArchivedDate>
  <Query>sample string 1</Query>
  <Description>sample string 2</Description>
  <Favorite>true</Favorite>
</ConsoleQuery>