Get Available Object Numbers
post
/config/sim/v2/getAvailableObjectNumbers
Gets available object numbers for a module based on count and starting position.
Request
Supported Media Types
- application/json
- multipart/form-data
Request body for get available object numbers.
Root Schema : GetAvailableObjNumRequest
Type:
Show Source
object
-
count:
integer
Default Value:
1
Count of object numbers to be returned.Example:1
-
hierUnitId:
integer
Unique hierarchy unit value. By default, the enterprise hierUnitId is used.Example:
1
-
start:
integer
Default Value:
1
Object number determining the starting position for getting the next object numbers.Example:1
-
startFromHighest:
boolean
Default Value:
false
This can be used if you need to know the available object numbers after the highest value in use. If true, the value of start field is ignored.Example:true
-
tag(required):
string
Allowed Values:
[ "employees: 999999999" ]
Unique tag or insert endpoint of the object for which the available object numbers are requested. Refer to enum for allowed objects and the corresponding maximum values.Example:employees/employees
Response
Supported Media Types
- application/json
200 Response
A list of available object numbers for the module and the hierarchy where the object numbers can be added.
Root Schema : GetAvailableObjNumResponse
Type:
Show Source
object
-
hierUnitId(required):
integer
Unique hierarchy unit value.Example:
1
-
objectNumbers(required):
array objectNumbers
List of available object numbers
Nested Schema : objectNumbers
Type:
array
List of available object numbers
Show Source
Example:
[
"1001",
"1002",
"1004",
"1005"
]