- General
- Endpoints
Capacity Resource Type Stage
GET
/board/{board_id}/capacity/resource_type/stage
Capacity
Request
Path Params
board_id
string <uuid>
required
Example:
0d646fe8-b4a8-4586-b5ce-84286402e207
Query Params
date_range_start
string
required
Example:
2024-01-01
date_range_end
string
required
Example:
2025-01-01
time_frame
enum<string>
write-onlyoptional
Allowed values:
dayweekmonthquarteryear
Default:
day
Example:
day
Header Params
x-api-key
string
required
Default:
{{api_key}}
x-api-env
string
required
Default:
{{api_env}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.vplan.com/v1/board/0d646fe8-b4a8-4586-b5ce-84286402e207/capacity/resource_type/stage?date_range_start=2024-01-01&date_range_end=2025-01-01' \
--header 'x-api-key;' \
--header 'x-api-env;'Responses
🟢200OK
application/json
Body
data
array [object {3}]
required
date
string
required
stage
array [object {2}]
required
total
object
required
Example
{
"data": [
{
"date": "string",
"stage": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"resource_type": {
"employee": {
"id": "employee",
"time_available": 0,
"time_planned": 0
},
"machine": {
"id": "machine",
"time_available": 0,
"time_planned": 0
},
"cell": {
"id": "cell",
"time_available": 0,
"time_planned": 0
}
}
}
],
"total": {
"employee": {
"time_available": 0,
"time_planned": 0
},
"machine": {
"time_available": 0,
"time_planned": 0
},
"cell": {
"time_available": 0,
"time_planned": 0
}
}
}
]
}Modified at 2024-10-04 09:04:55