Features API

This page describes how to work with Features using REST API

Using the Features API

API Description can be found in our Swagger docs here:

https://app.swaggerhub.com/apis/ProdCamp/prodcamp_app/v1.0#/Features/post_api_v1_features

get
Query parameters
GetRefsbooleanOptional
SprintlessbooleanOptional
OnlyActivebooleanOptional
OnlyArchivedbooleanOptional
OnlyBacklogbooleanOptional
catstring[]Optional
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
Responses
get
/api/v1/features
200

Success

post
Query parameters
notifyCustomersbooleanOptionalDefault: false
Body
featureValuenumber · doubleOptional
idinteger · int32Optional
colorstring | nullableOptional
namestring | nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
isPublicbooleanOptional
upvotesCountinteger · int32Optional
commentsCountinteger · int32Optional
commentsTotalCountinteger · int32Optional
estimationinteger · int64Optional
Responses
post
/api/v1/features
200

Success

get
Query parameters
GetRefsbooleanOptional
SprintlessbooleanOptional
OnlyActivebooleanOptional
OnlyArchivedbooleanOptional
OnlyBacklogbooleanOptional
catstring[]Optional
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
Responses
get
/api/v1/features/advanced
200

Success

get
Query parameters
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
OnlyActivebooleanOptionalDefault: false
OnlyArchivedbooleanOptionalDefault: false
Responses
get
/api/v1/features/refs
200

Success

get
Path parameters
indexinteger · int32Required
Responses
get
/api/v1/features/{index}
200

Success

put
Path parameters
indexinteger · int32Required
Body
featureValuenumber · doubleOptional
idinteger · int32Optional
colorstring | nullableOptional
namestring | nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
isPublicbooleanOptional
upvotesCountinteger · int32Optional
commentsCountinteger · int32Optional
commentsTotalCountinteger · int32Optional
estimationinteger · int64Optional
Responses
put
/api/v1/features/{index}
200

Success

delete
Path parameters
indexinteger · int32Required
Responses
delete
/api/v1/features/{index}

No content

get
Path parameters
indexinteger · int32Required
Responses
get
/api/v1/features/{index}/comments
post
Path parameters
indexinteger · int32Required
Body
idstring | nullableOptional
contentstring | nullableOptional
isPublicbooleanOptional
sentViainteger · enumOptionalPossible values:
firstNamestring | nullableOptional
lastNamestring | nullableOptional
fullNamestring | nullableOptional
emailstring | nullableOptional
isThreadStarterbooleanOptional
threadStarterIdstring | nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
Responses
post
/api/v1/features/{index}/comments
put
Path parameters
indexinteger · int32Required
commentIdstringRequired
Body
statebooleanOptional
Responses
put
/api/v1/features/{index}/comments/{commentId}/public
delete
Path parameters
indexinteger · int32Required
commentIdstringRequired
Responses
delete
/api/v1/features/{index}/comments/{commentId}
put
Body
idsinteger · int32[] | nullableOptional
modelany | nullableOptional
Responses
put
/api/v1/features/batch/update
204

Success

No content

put
Body
idsinteger · int32[] | nullableOptional
modelany | nullableOptional
Responses
put
/api/v1/features/batch/delete

No content

get
Responses
get
/api/v1/features/priorities
200

Success

get
Responses
get
/api/v1/features/statuses
200

Success

get
Responses
get
/api/v1/features/types
200

Success

Last updated

Was this helpful?