PUT v1/bunits/{bunitId}/nodenamingrule

Updates an existing naming rule.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId The ID of the business unit of the naming rule integer

Required

Body Parameters

the updated naming rule object

NodeNamingRule
NameDescriptionTypeAdditional information
SetNamesManually Names are set manually by the user when activating a backup node
boolean

None.

Counter A counter indicating what the next number will be
Applicable only if not set manually
integer

None.

NumberOfDigits Number of digits used
integer

None.

Rule The rule applied when creating name for backup node
string

None.

ReplacementCharacter Replacement character used when illegal characters are found.
string

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:
<NodeNamingRule xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>6</Id>
  <CreatedDate>2024-06-17T14:33:25.4781334+02:00</CreatedDate>
  <ArchivedDate>2024-06-17T14:33:25.4781334+02:00</ArchivedDate>
  <SetNamesManually>true</SetNamesManually>
  <Counter>2</Counter>
  <NumberOfDigits>3</NumberOfDigits>
  <Rule>sample string 4</Rule>
  <ReplacementCharacter>sample string 5</ReplacementCharacter>
</NodeNamingRule>

Response Information

Resource Description

The updated naming rule

NodeNamingRule
NameDescriptionTypeAdditional information
SetNamesManually Names are set manually by the user when activating a backup node
boolean

None.

Counter A counter indicating what the next number will be
Applicable only if not set manually
integer

None.

NumberOfDigits Number of digits used
integer

None.

Rule The rule applied when creating name for backup node
string

None.

ReplacementCharacter Replacement character used when illegal characters are found.
string

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:
<NodeNamingRule xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>6</Id>
  <CreatedDate>2024-06-17T14:33:25.48013+02:00</CreatedDate>
  <ArchivedDate>2024-06-17T14:33:25.48013+02:00</ArchivedDate>
  <SetNamesManually>true</SetNamesManually>
  <Counter>2</Counter>
  <NumberOfDigits>3</NumberOfDigits>
  <Rule>sample string 4</Rule>
  <ReplacementCharacter>sample string 5</ReplacementCharacter>
</NodeNamingRule>