Project Field

Create Project Field

POST

Creates a new ProjectField within your Workspace.

A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace.

Request

This endpoint expects an object.
name
stringRequired
The name of this Field
type
stringRequired

The type of the Field. Valid types are the following:

  • Text
  • Number
  • Date
  • Currency
  • Dropdown

Attempting to create a field with any Type other than these will return an error.

For Dropdown Field, specify the list of choices in the Options field. TODO - This object needs to support a list of options, in case dropdown is selected

shortId
stringOptional
The short Id of this field - human readable identity

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
A ProjectField is a custom field defined within your Workspace. You can define ProjectFields for any integration purpose that is important to your business. Each ProjectField has a data type as well as options in how it is handled. ProjectFields can be edited for each Project within your Workspace.
POST
1curl -X POST /api/data/projects/fields \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "name": "name",
6 "type": "type"
7}'
200
Successful
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue",
12 "data": {
13 "id": "id",
14 "name": "name"
15 }
16}