Get all backlog items
get
/fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/BacklogItems
Request
Path Parameters
-
RqmtId(required): integer(int64)
Unique identifier of the project requirement in the requirement hierarchy.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a resource by the specified primary key.
Finder Variables:- BacklogItemId; integer; Unique identifier of the backlog item.
- PrimaryKey: Finds a resource by the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BacklogItemCode; string; Unique code of the backlog item.
- BacklogItemId; integer; Unique identifier of the backlog item.
- BacklogItemName; string; Name of the backlog item.
- BacklogOwnerEmail; string; Email of the backlog item owner.
- BacklogPriority; string; Name of the backlog item priority.
- BacklogProductCode; string; Unique code of the product assigned to the backlog item.
- BacklogReleaseNumber; string; Unique number of the product release assigned to the backlog item.
- BacklogStatus; string; Name of the backlog item status.
- BacklogStatusCode; string; Unique code of the backlog item status.
- RequirementCode; string; Unique code of the requirement.
- ScrumMasterEmail; string; Email of the scrum master.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : requirements-BacklogItems
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requirements-BacklogItems-item-response
Type:
Show Source
object
-
AcceptanceCriteria: array
AcceptanceCriterions
Title:
AcceptanceCriterions
The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete. -
AdditionalDetails: string
Title:
Additional Details
Maximum Length:2000
Additional description for the backlog item. -
BacklogItemCode: string
Title:
Backlog Item Code
Maximum Length:30
Unique code of the backlog item. -
BacklogItemId: integer
(int64)
Title:
Backlog Item ID
Read Only:true
Unique identifier of the backlog item. -
BacklogItemName: string
Title:
Backlog Item Name
Maximum Length:100
Name of the backlog item. -
BacklogOwner: string
Title:
Backlog Item Owner
Name of the backlog item owner. -
BacklogOwnerEmail: string
Title:
Backlog Item Owner E-Mail
Email of the backlog item owner. -
BacklogPriority: string
Title:
Backlog Item Priority
Name of the backlog item priority. -
BacklogPriorityCode: string
Title:
Backlog Item Priority Code
Maximum Length:30
Default Value:MEDIUM
Unique code of the backlog item priority. -
BacklogProductCode: string
Title:
Product Code
Unique code of the product assigned to the backlog item. -
BacklogProductName: string
Title:
Product
Maximum Length:255
Name of the product assigned to the backlog item. -
BacklogReleaseName: string
Title:
Release Name
Name of the product release. -
BacklogReleaseNumber: string
Title:
Release Number
Unique number of the product release assigned to the backlog item. -
BacklogStatus: string
Title:
Backlog Item Status
Name of the backlog item status. -
BacklogStatusCode: string
Title:
Backlog Item Status Code
Maximum Length:30
Default Value:DRAFT
Unique code of the backlog item status. -
BacklogStorypoints: integer
(int64)
Title:
Story Points
A measure to determine the complexity of a backlog item. -
Effort: integer
(int64)
Title:
Effort
Effort in days to complete the backlog item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Rank: integer
(int32)
Title:
Rank
Number assigned to the backlog item to maintain a prioritized list of backlog items. -
RequirementCode: string
Title:
Requirement Code
Unique code of the requirement. -
RequirementName: string
Title:
Requirement Name
Name of the requirement. -
ScrumMasterEmail: string
Title:
Scrum Master E-Mail
Email of the scrum master. -
ScrumMasterName: string
Title:
Scrum Master
Name of the backlog item scrum master. -
Sprint: string
Title:
Sprint
Maximum Length:255
Name of the sprint associated with the backlog item. -
UserStory: string
Title:
User Story
Maximum Length:2000
An informative definition of the backlog item which helps to estimate the effort.
Nested Schema : AcceptanceCriterions
Type:
array
Title:
AcceptanceCriterions
The acceptance criteria resource is used to view,create, or modify acceptance criteria of a backlogitem. Acceptance criteria is a condition that must be fulfilled for a backlog item to be complete.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requirements-BacklogItems-AcceptanceCriteria-item-response
Type:
Show Source
object
-
CriteriaId: integer
(int64)
Title:
Acceptance Criteria ID
Read Only:true
Unique identifier of the acceptance criteria under the backlog item. -
CriteriaName: string
Title:
Acceptance Criteria
Maximum Length:140
Condition that must be fulfilled for considering the backlog item to be complete. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to get all backlog items by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.17.08/requirements/{RqmtId}/child/BacklogItems
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "BacklogItemId": 300100114014086, "BacklogItemCode": "8122", "BacklogItemName": "Backlogexample", "RequirementCode": "62", "RequirementName": "128D43RRF_REQ01", "BacklogPriorityCode": "LOW", "BacklogPriority": "Low", "BacklogStatusCode": "DRAFT", "BacklogStatus": "Draft", "BacklogOwnerEmail": null, "BacklogOwner": null, "ScrumMasterEmail": "prj_mark_taylor_in_grp@oracle.com", "ScrumMasterName": "Mark Taylor", "BacklogStorypoints": 8, "BacklogProductCode": null, "BacklogProductName": null, "BacklogReleaseNumber": null, "BacklogReleaseName": null, "Sprint": null, "Rank": null, "Effort": null, "UserStory": null, "AdditionalDetails": null, [... ] }