Get information about staff plan

Note

This API is used for getting data of staff planning (assigned task hours of members).

Action	Parameters	Options	Description
`get`	`type`	`project` and `assignee`	Get values by each project or assignee.
	`name`		Filter with project name.
	`time`	`monthly` and `yearly`	Arrange the payload by monthly or yearly.
	`project`	`fixed` and `opportunity`	Fixed is order received/ Opportunity is order not received yet projects.
	`range`	`enabled` and `disabled`	Searching with date range or not.
	`start_date`		Search start date.
	`end_date`		Search end date.

Endpoint

GET

/api/v2/staffplan/?type={type}&name=&time={time}&project={project}&range={range}&start_date={start_date}&end_date={end_date}

Example Request

cURLJavascriptJavaPython

curl --location --request GET 'https://app.engineerforce.io/api/v2/staffplan/?type=project&name=&time=monthly&project=opportunity&range=enabled&start_date=01/01/2023&end_date=30/06/2023'\
--header 'Authorization: API-Token {{YOUR_API_TOKEN}}'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://app.engineerforce.io/api/v2/staffplan/?type=project&name=&time=monthly&project=opportunity&range=enabled&start_date=01/01/2023&end_date=30/06/2023',
  headers: { 'Authorization': 'API-Token {{YOUR_API_TOKEN}}' }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url('https://app.engineerforce.io/api/v2/staffplan/?type=project&name=&time=monthly&project=opportunity&range=enabled&start_date=01/01/2023&end_date=30/06/2023')
  .method("GET", body)
  .addHeader("Authorization", "API-Token {{YOUR_API_TOKEN}}")
  .build();
Response response = client.newCall(request).execute();

import requests

url = 'https://app.engineerforce.io/api/v2/staffplan/?type=project&name=&time=monthly&project=opportunity&range=enabled&start_date=01/01/2023&end_date=30/06/2023'

payload={}
headers = {'Authorization': 'API-Token {{YOUR_API_TOKEN}}' }

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Example Response

Example

[{
    "projectName": "システム開発",
    "projectID": 1000,
    "scheduleStart": "2023/01",
    "scheduleEnd": "2023/01",
    "totalRiskTimeHourValue": 0,
    "totalRiskTimeDayValue": 0,
    "totalRiskTimeWeekValue": 0,
    "totalRiskTimeMonthValue": 0,
    "taskPlan": [{
        "name": "John Doe",
        "mailAddress": "johndoe@test.io",
        "planDate": "2023/01",
        "totalRiskTimeHourValue": 0,
        "totalRiskTimeDayValue": 0,
        "totalRiskTimeWeekValue": 1.0,
        "totalRiskTimeMonthValue": 0
    }]
}]