コンテンツにスキップ
backlog-cli

Add a custom field to the project

POST
/projects/{projectIdOrKey}/customFields

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectIdOrKey
required
string

Request Body required

Section titled “Request Body required ”
object
typeId
required

Custom field type code.

  • 1: Text
  • 2: TextArea
  • 3: Numeric
  • 4: Date
  • 5: SingleList
  • 6: MultipleList
  • 7: CheckBox
  • 8: RadioButton
number
Allowed values: 1 2 3 4 5 6 7 8
name
required
string
description
string
required
boolean
applicableIssueTypes
Array<integer>
min

Min value (for Numeric type).

number format: double
max

Max value (for Numeric type).

number format: double
initialValue

Initial value (for Numeric/Date type).

string
unit

Unit (for Numeric type).

string
initialValueType

Initial value type for Date (1: Today, 2: Start of project, 3: End of project).

integer format: int32
initialDate

Initial date (for Date type).

string format: date
allowInput

Allow input of items (for list types).

boolean
allowAddItem

Allow adding items (for list types).

boolean
items
Array<string>

Responses

Section titled “ Responses ”

201

Section titled “201 ”

The request has succeeded and a new resource has been created as a result.

Custom field definition.

object
id
required
integer format: int64
typeId
required

Custom field type code.

  • 1: Text
  • 2: TextArea
  • 3: Numeric
  • 4: Date
  • 5: SingleList
  • 6: MultipleList
  • 7: CheckBox
  • 8: RadioButton
number
Allowed values: 1 2 3 4 5 6 7 8
name
required
string
description
required
string
required
required
boolean
applicableIssueTypes
required
Array<integer>
allowAddItem
required
boolean
nullable
items
required
Array<object>
nullable

Custom field list item.

object
id
required
integer format: int64
name
required
string
displayOrder
required
integer format: int32

default

Section titled “default ”

An unexpected error response.

Error response wrapper returned by all Backlog API error responses.

object
errors
required
Array<object>

Individual error detail returned by the Backlog API.

object
message
required

Error message.

string
code
required

Error code.

  • 1: InternalError
  • 2: LicenceError
  • 3: LicenceExpiredError
  • 4: AccessDeniedError
  • 5: UnauthorizedOperationError
  • 6: NoResourceError
  • 7: InvalidRequestError
  • 8: SpaceOverCapacityError
  • 9: ResourceOverflowError
  • 10: TooLargeFileError
  • 11: AuthenticationError
  • 12: RequiredMFAError
  • 13: TooManyRequestsError
integer format: int32
moreInfo
required

Additional information about the error.

string