Update a backlog item
patch
/fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId}
Request
Path Parameters
- BacklogItemId(required): integer(int64) The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
- RqmtId(required): integer(int64) Unique identifier of the project requirement in the requirement hierarchy.
- RqmtId2(required): integer(int64) The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
- Metadata-Context: string 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: string 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.
Supported Media Types
- application/json
Root Schema : schema
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. - BacklogItemName(required): 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. - 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 : requirements-ChildRequirements-BacklogItems-AcceptanceCriteria-item-patch-request
Type:
Show Source object
- CriteriaName: string Title:
Acceptance Criteria
Maximum Length:140
Condition that must be fulfilled for considering the backlog item to be complete.
Response
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-ChildRequirements-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-ChildRequirements-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.
Links
- AcceptanceCriteria
- Parameters:
- BacklogItemId2:
$request.path.BacklogItemId2
- RqmtId:
$request.path.RqmtId
- RqmtId2:
$request.path.RqmtId2
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. - BacklogItemId2:
Examples
The following example shows how to update a backlog item by submitting a PATCH request on the REST resource using cURL.
cURL Command Example
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.17.08/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems/{BacklogItemId}
Request Body Example
The following shows an example of the request body in JSON format.
{ "BacklogPriorityCode" : "HIGH", "BacklogStatusCode" : "COMPLETE" }
Response Body Example
The following shows an example of the response body in JSON format.
{ { "BacklogItemId": 300100114014086, "BacklogItemCode": "8122", "BacklogItemName": "Backlogexample", "RequirementCode": "62", "RequirementName": "128D43RRF_REQ01", "BacklogPriorityCode": "HIGH", "BacklogPriority": "High", "BacklogStatusCode": "COMPLETE", "BacklogStatus": "Complete", "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, "links" : [ ... ] }