Business direction

Create business direction#

Creates a new Business direction object.

POST
/orgstruct/business-dirs

Request body:

Attribute	Type	Description	Nullable
externalId	String	Business direction external id	true
name	String	Business direction name	false
createTask	Boolean	Whether users of this business direction can create tasks	true
geoCheckStart	String	Geolocation check when starting a task/checklist response: `accept, ignore`	true
geoCheckFinish	String	Geolocation check when finishing a task/checklist response: `accept, ignore`	true
active	Boolean	Whether the business direction is active. Default `true`	true

Examples

curl --request POST https://api.qvalon.com/v1/orgstruct/business-dirs \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"name":"Merchandising","createTask":true,"active":true}'

200 OK

{
  "id": 1007,
  "name": "Merchandising",
  "createTask": true,
  "system": false,
  "geoCheckStart": "accept",
  "geoCheckFinish": "accept",
  "observeMyShopTask": false,
  "active": true,
  "rolesAndLevels": {}
}

Update business direction#

Updates an existing business direction by id. Returns the updated Business direction object.

PUT
/orgstruct/business-dirs/{id}

Request body:

Attribute	Type	Description	Nullable
externalId	String	Business direction external id	true
name	String	Business direction name	false
createTask	Boolean	Whether users of this business direction can create tasks	true
geoCheckStart	String	Geolocation check when starting a task/checklist response: `accept, ignore`	true
geoCheckFinish	String	Geolocation check when finishing a task/checklist response: `accept, ignore`	true
active	Boolean	Whether the business direction is active	true

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/business-dirs/1007 \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"name":"Merchandising","createTask":true,"active":true,"geoCheckStart":"ignore","geoCheckFinish":"ignore"}'

200 OK

{
  "id": 1007,
  "name": "Merchandising",
  "createTask": true,
  "system": false,
  "geoCheckStart": "ignore",
  "geoCheckFinish": "ignore",
  "observeMyShopTask": false,
  "active": true,
  "rolesAndLevels": {}
}

List business directions#

Returns a list of Business direction objects.

GET
/orgstruct/business-dirs

Request parameters:

Request Parameter	Type	Description	Required
ids	List of integers	Find business directions by ids	false
nameLike	String	Find business direction by name	false
onlyActive	Boolean	Get only active business directions. Default `true`	false

Examples

curl https://api.qvalon.com/v1/orgstruct/business-dirs?ids=1001,1002 \
--header 'Authorization: Bearer <your_token>'

200 OK

[
  {
    "id": 1001,
    "name": "Merchandising",
    "createTask": true,
    "system": true,
    "geoCheckStart": "accept",
    "geoCheckFinish": "ignore",
    "observeMyShopTask": true,
    "active": true,
    "rolesAndLevels": {}
  },
  {
    "id": 1002,
    "name": "Undefined",
    "createTask": true,
    "system": true,
    "geoCheckStart": "ignore",
    "geoCheckFinish": "ignore",
    "observeMyShopTask": false,
    "active": true,
    "rolesAndLevels": {}
  }
]

Get business direction dependency#

Returns the Business direction dependency object: which other business directions' tasks/checklists this business direction can see and act on.

GET
/orgstruct/business-dirs/{id}/dependency

Examples

curl https://api.qvalon.com/v1/orgstruct/business-dirs/1007/dependency \
--header 'Authorization: Bearer <your_token>'

200 OK

{
  "forTasks": [
    1007,
    1001
  ],
  "forChecklists": [
    1007
  ]
}

Add business direction dependency#

Adds dependent business directions, in addition to the ones already set.

POST
/orgstruct/business-dirs/{id}/dependency

Request body:

Attribute	Type	Description	Nullable
forTasks	List of integers	ids of the business directions for which tasks can additionally be seen/assigned	true
forChecklists	List of integers	ids of business directions for which inspections can additionally be planned	true

Examples

curl --request POST https://api.qvalon.com/v1/orgstruct/business-dirs/1007/dependency \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"forTasks":[1002],"forChecklists":[]}'

200 OK

{}

Replace business direction dependency#

Replaces the business direction's dependent directions with the given ones — anything not in the list is removed.

PUT
/orgstruct/business-dirs/{id}/dependency

Request body:

Attribute	Type	Description	Nullable
forTasks	List of integers	ids of the business directions for which tasks can be seen/assigned	false
forChecklists	List of integers	ids of business directions for which inspections can be planned	false

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/business-dirs/1007/dependency \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"forTasks":[1007,1001],"forChecklists":[1007]}'

200 OK

{}

Remove business direction dependency#

Removes the given dependent business directions; anything not listed is left as is.

DELETE
/orgstruct/business-dirs/{id}/dependency

Request body:

Attribute	Type	Description	Nullable
forTasks	List of integers	ids of the business directions to stop sharing tasks with	true
forChecklists	List of integers	ids of business directions to stop sharing checklist planning with	true

Examples

curl --request DELETE https://api.qvalon.com/v1/orgstruct/business-dirs/1007/dependency \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"forTasks":[1002],"forChecklists":[]}'

200 OK

{}

Remove all business direction dependencies#

Removes all dependent business directions (for both tasks and checklists).

DELETE
/orgstruct/business-dirs/{id}/dependency/clear

Examples

curl --request DELETE https://api.qvalon.com/v1/orgstruct/business-dirs/1007/dependency/clear \
--header 'Authorization: Bearer <your_token>'

200 OK

{}