Jump to

• Request
• Response

Get Available Object Numbers

post

/config/sim/v1/getAvailableObjectNumbers

Gets available object numbers for a module based on count and starting position.

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

Request body for get available object numbers.

Root Schema : GetAvailableObjNumRequest

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "tag"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value. By default, the enterprise hierUnitId is used.",
            "example":1
        },
        "tag":{
            "type":"string",
            "description":"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.",
            "enum":[
                "employees: 999999999"
            ],
            "example":"employees/employees"
        },
        "start":{
            "type":"integer",
            "description":"Object number determining the starting position for getting the next object numbers.",
            "example":1,
            "default":1
        },
        "count":{
            "type":"integer",
            "description":"Count of object numbers to be returned.",
            "example":1,
            "default":1
        },
        "startFromHighest":{
            "type":"boolean",
            "description":"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,
            "default":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : GetAvailableObjNumResponse

Type: object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value.

  Example: 1
• objectNumbers(required): array objectNumbers
  List of available object numbers

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNumbers"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value.",
            "example":1
        },
        "objectNumbers":{
            "description":"List of available object numbers",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1001,
                1002,
                1004,
                1005
            ]
        }
    }
}

Nested Schema : objectNumbers

Type: array

List of available object numbers

Show Source

• Array of: integer

{
    "description":"List of available object numbers",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1001,
        1002,
        1004,
        1005
    ]
}

Example:

[
    1001,
    1002,
    1004,
    1005
]

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top