StarterTemplate ASP.NET Host

<back to all web services

RequestRequirementsAllPost

Requirements service

The following routes are available for this service:
POST/service/api/v1/projects/{ProjectId}/requirements/searchReturns a list of requirements in a projectThe authenticating user must have the Read privilege for Requirements. This method fully equivalent to GET method, but this one allows you to send large filter string.
Parameters:
NameParameterData TypeRequiredDescription
OffsetqueryintNoThe number of requirements to skip before counting the returned requirements
LimitqueryintNoThe maximum number of requirements to return
ProjectIdpathintYesThe ID of the project that contains requirements

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/RequestRequirementsAllPost HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	limit: 0,
	project_id: 0,
	filter: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			id: 0,
			project_id: 0,
			title: String,
			active: False,
			status: String,
			__permissions: 
			{
				acl: 0
			},
			act_finish: 0001-01-01,
			act_hrs: 0,
			act_start: 0001-01-01,
			assigned_to_name: String,
			assignee_user_id: 0,
			business_rule: String,
			comments: String,
			date_created: 0001-01-01,
			date_last_escalated: 0001-01-01,
			date_opened: 0001-01-01,
			date_updated: 0001-01-01,
			description: String,
			est_finish: 0001-01-01,
			est_hrs: 0,
			est_hrs_remaining: 0,
			est_start: 0001-01-01,
			folder_id: 0,
			folder_name: String,
			grouping: String,
			import_id: 0,
			keywords: String,
			last_escalation_rule: String,
			last_escalation_rule_id: 0,
			nbr_escalations: 0,
			nbr_events: 0,
			nbr_files: 0,
			nbr_notes: 0,
			nbr_tasks: 0,
			notes_description: String,
			opened_by: 0,
			opened_by_company: String,
			opened_by_email: String,
			opened_by_name: String,
			original_id: 0,
			owner_name: String,
			owner_user_id: 0,
			pct_complete: 0,
			sub_grouping: String,
			update_user_id: 0,
			user_name: String
		}
	]
}