Structure Nodes

Structure node represents your company structure. On this page, we’ll dive into the different structure node endpoints you can use to manage your structure programmatically. We'll look at how to upload and update structure nodes.

The Structure Node model

The structure node model contains all the information about your structure nodes, including the name, structure node key, parent key and node type.

Properties

Name
key
Type
string
Description
Unique identifier for the structure node.
Name
name
Type
string
Description
The full name of the structure node.
Name
parentKey
Type
string | null
Description
The key of the structure node parent.
Name
isStore
Type
boolean
Description
Is that node related to the store.

POST/integrations/structureNodes

Update all structure nodes

This endpoint allows you to upload all your structure nodes. It replaces all the existing nodes with uploaded ones. See the code examples for how to upload your Structure Nodes through ProShedule API.

Required attributes

Name
body
Type
Array<structureNode>
Description
An array of structure node objects.

Request

POST

/integrations/structureNodes

curl https://api.proschedule.ambraisoft.com/integrations/structureNodes \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer {token}" \
  --data-raw '[
    {
      "key": "Market_1",
      "name": "Market North",
      "parentKey": null,
      "isStore": false
    },
    {
      "key": "Store_1",
      "name": "Store in City Center",
      "parentKey": Market_1,
      "isStore": true
    }
  ]'

Response

  {
      "message": "2 structure node(s) uploaded",
      "status": 200
  }