Create Resource

POST

Create a new Resource within your Workspace.

A Resource represents a person, material, or tool that is used within your Projects. When you attach a Resources to more than one Task, the software will schedule the usage of your Resource so that it is not allocated to more than one Task at the same time. The users in your Workspace are also considered Resources. To invite a new User to your Workspace, create a new Resource for that user.

Request

This endpoint expects an object.

firstNamestringRequired

The first name of the person Resource.

Applies to personnel Resources only.

lastNamestringOptional

The last name of the person Resource.

Applies to personnel Resources only.

emailstringOptional

The email address of this Resource.

hourlyRatedoubleOptional

The basic hourly rate for this Resource.

phonestringOptional

The phone number associated with this Resource.

citystringOptional

The city where this Resource is located.

statestringOptional

The state or region where this Resource is located. This value is not constrained to a list of known states or regions.

countrystringOptional

A text field indicating the country in which this Resource is located. This value is not constrained to the list of known ISO 3166 country names or codes.

notesstringOptional

Free-form text notes about this Resource. You may use this field to store extra information about the Resource.

rolestringOptional

The Role privileges associated with this Resource.

Applies to personnel Resources only.

teamslist of stringsOptional

The list of ResourceTeams to which this Resource belongs.

skillslist of stringsOptional

The list of ResourceSkills possessed by this Resource.

Response

This endpoint returns an object.

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

dataobjectOptional

POST

1 curl -X POST /project-api/public/resources \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "firstName": "firstName"
6 }'

200Successful

1 {
2   "error": {
3     "message": "message"
4   },
5   "success": true,
6   "hasError": true,
7   "statusCode": "Continue",
8   "data": {
9     "id": "id",
10     "firstName": "firstName",
11     "lastName": "lastName",
12     "email": "email",
13     "hourlyRate": 1.1,
14     "phone": "phone",
15     "city": "city",
16     "state": "state",
17     "country": "country",
18     "notes": "notes",
19     "approver": {
20       "id": "id",
21       "name": "name"
22     },
23     "teams": [
24       {}
25     ],
26     "skills": [
27       {}
28     ],
29     "onlineDateTime": "2024-01-15T09:30:00Z",
30     "role": "role",
31     "isActive": true
32   }
33 }

Retrieve Resource Skills

Up Next

Built with

1	curl -X POST /project-api/public/resources \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"firstName": "firstName"
6	}'

1	{
2	"error": {
3	"message": "message"
4	},
5	"success": true,
6	"hasError": true,
7	"statusCode": "Continue",
8	"data": {
9	"id": "id",
10	"firstName": "firstName",
11	"lastName": "lastName",
12	"email": "email",
13	"hourlyRate": 1.1,
14	"phone": "phone",
15	"city": "city",
16	"state": "state",
17	"country": "country",
18	"notes": "notes",
19	"approver": {
20	"id": "id",
21	"name": "name"
22	},
23	"teams": [
24	{}
25	],
26	"skills": [
27	{}
28	],
29	"onlineDateTime": "2024-01-15T09:30:00Z",
30	"role": "role",
31	"isActive": true
32	}
33	}