1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Requirements
  4. ChildRequirements
  5. BacklogItems

Create backlog items

post

/fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/BacklogItems

Request

Path Parameters
  • Unique identifier of the project requirement in the requirement hierarchy.
  • 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
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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-post-request
Type: object
Show Source
  • Title: Acceptance Criteria
    Maximum Length: 140
    Condition that must be fulfilled for considering the backlog item to be complete.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : requirements-ChildRequirements-BacklogItems-item-response
Type: object
Show Source
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-response
Type: object
Show Source
  • Title: Acceptance Criteria ID
    Read Only: true
    Unique identifier of the acceptance criteria under the backlog item.
  • Title: Acceptance Criteria
    Maximum Length: 140
    Condition that must be fulfilled for considering the backlog item to be complete.
  • Links
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.
Back to Top

Examples

The following example shows how to create a backlog item by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -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

Example of Request Body

The following example shows the contents of the request body in JSON format

{
"BacklogItemName" : "Backlogexample",
"BacklogPriorityCode" : "LOW",
"BacklogStatusCode"  : "DRAFT",
"BacklogStorypoints" : 8,
"ScrumMasterName" : "Mark Taylor"

}

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,
  "links": [...
  ]
}
Back to Top