Jump to

• Request
• Response

Add Hierarchy Nodes

post

/config/sim/v2/hierarchy/zones/nodes

Add a Hierarchy Node of hierType 'Zone'

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Hierarchy Node insert request body

Root Schema : schema

Type: object

Model for Node Object Insert Request

Show Source

• hierUnitId: integer
  Hierarchy Unit Id of the node. This field is supported for nodeTypes 'Location' and 'RVC'.

  Example: 1
• name: object name
  Name of the zone. This field is only supported and required for nodeType 'Zone'.
• nodeType(required): string
  Type of the node to be inserted (Location/RVC/Zone)

  Example: Zone
• objectNum: integer
  Object Number of the zone. This field is only supported and required for nodeType 'Zone'.

  Example: 12
• options: string

  A string of values 0s and 1s of length 16 representing the options for the hierarchy node

  Position(starts from 1)	Description
  1	EnforceUniquePropertiesWithinZone
  2	EnforceUniqueRVCsWithinZone
  3	restrictModulesInChildZones
  4	allRVCsfromSameLocation
  5	sortAlphabetically

  
  

  List of bits that can be set for a particular zoneType

  ZoneType	List of valid bits (starts from 1)
  NULL	3, 5
  1	1, 2, 3, 5
  2	2, 3, 4, 5

  Example: 0000000000000000
• parentHierUnitId(required): integer
  HierUnitId of the zone/enterprise under which the node is to be inserted.

  Example: 3599
• zoneType: integer
  Default Value: null

  Type of the zone. This field is only supported for nodeType 'Zone'.

  zoneType	Eligible Child Nodes
  NULL	NA
  1	Locations and RVCs
  2	RVCs only

  Example: 1

{
    "description":"Model for Node Object Insert Request",
    "type":"object",
    "required":[
        "nodeType",
        "parentHierUnitId"
    ],
    "properties":{
        "nodeType":{
            "description":"Type of the node to be inserted (Location/RVC/Zone)",
            "type":"string",
            "example":"Zone"
        },
        "parentHierUnitId":{
            "description":"HierUnitId of the zone/enterprise under which the node is to be inserted.",
            "type":"integer",
            "example":3599
        },
        "objectNum":{
            "description":"Object Number of the zone. This field is only supported and required for nodeType 'Zone'.",
            "type":"integer",
            "example":12
        },
        "name":{
            "description":"Name of the zone. This field is only supported and required for nodeType 'Zone'.",
            "type":"object",
            "example":{
                "1":"Currency",
                "2":"W??hrung",
                "3":"Divisa"
            }
        },
        "zoneType":{
            "description":"<p>Type of the zone. This field is only supported for nodeType 'Zone'.</p>\n\n<table>\n<tr><th> zoneType </th><th> Eligible Child Nodes</th></tr>\n<tr><td> NULL     </td><td> NA                 </td></tr>\n<tr><td> 1        </td><td> Locations and RVCs </td></tr>\n<tr><td> 2        </td><td> RVCs only          </td></tr>\n</table>\n",
            "type":"integer",
            "default":"null",
            "example":1
        },
        "hierUnitId":{
            "description":"Hierarchy Unit Id of the node. This field is supported for nodeTypes 'Location' and 'RVC'.",
            "type":"integer",
            "example":1
        },
        "options":{
            "type":"string",
            "example":"0000000000000000",
            "description":"<p>A string of values 0s and 1s of length 16 representing the options for the hierarchy node</p>\n \n<table> \n  <tr><th> Position(starts from 1) </th><th> Description </th></tr>\n  <tr><td> 1 </td><td> EnforceUniquePropertiesWithinZone </td></tr>\n  <tr><td> 2 </td><td> EnforceUniqueRVCsWithinZone </td></tr>\n  <tr><td> 3 </td><td> restrictModulesInChildZones </td></tr>\n  <tr><td> 4 </td><td> allRVCsfromSameLocation </td></tr>\n  <tr><td> 5 </td><td> sortAlphabetically </td></tr>\n</table>\n<br>\n\n<p>List of bits that can be set for a particular zoneType</p>\n\n<table>\n  <tr><th> ZoneType </th><th> List of valid bits (starts from 1)  </th></tr>\n  <tr><td> NULL     </td><td> 3, 5               </td></tr>\n  <tr><td> 1        </td><td> 1, 2, 3, 5         </td></tr>\n  <tr><td> 2        </td><td> 2, 3, 4, 5         </td></tr>\n</table>\n"
        }
    }
}

Nested Schema : name

Type: object

Name of the zone. This field is only supported and required for nodeType 'Zone'.

Example:

{
    "1":"Currency",
    "2":"W??hrung",
    "3":"Divisa"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Insert operation executed successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• hierStrucId: integer
  Unique hierarchy structure value.

  Example: 1

{
    "type":"object",
    "properties":{
        "hierStrucId":{
            "type":"integer",
            "description":"Unique hierarchy structure value.",
            "example":1
        }
    }
}

Back to Top