1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Requirements

Get all requirements

get

/fscmRestApi/resources/11.13.18.05/requirements

Request

Query Parameters
  • 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).
  • 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
  • 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:
      • RqmtId; integer; Unique identifier of the project requirement in the requirement hierarchy.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • Owner; string; Name of the requirement owner.
    • OwnerEmail; string; Email of the requirement owner.
    • ParentRqmtCode; string; Unique code of the parent requirement.
    • ParentRqmtId; integer; Unique identifier of the parent requirement.
    • ParentRqmtName; string; Name of the parent requirement.
    • Priority; string; Priority of the requirement.
    • PriorityCode; string; Unique code of the requirement priority.
    • ProductCode; string; Unique code of the product.
    • ProductName; string; Name of the product.
    • ReleaseName; string; Name of the product release.
    • ReleaseNumber; string; Unique number of the product release.
    • RqmtCode; string; Unique code of the requirement in the requirement hierarchy.
    • RqmtId; integer; Unique identifier of the project requirement in the requirement hierarchy.
    • RqmtName; string; Name of the requirement.
    • Status; string; Status of the requirement.
    • StatusCode; string; Unique code of the requirement status.
  • 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
  • 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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : requirements-item-response
Type: object
Show Source
Nested Schema : BacklogItems
Type: array
Title: BacklogItems
The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.
Show Source
Nested Schema : ChildRequirements
Type: array
Title: ChildRequirements
The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.
Show Source
Nested Schema : requirements-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-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
Nested Schema : requirements-ChildRequirements-item-response
Type: object
Show Source
Nested Schema : BacklogItems
Type: array
Title: BacklogItems
The backlog item resource is used to view,create, or modify backlog items. A backlog item represents a unit of work that can be accomplished within a sprint.
Show Source
Nested Schema : ChildRequirements
Type: array
Title: ChildRequirements
The requirements resource is used to view,create, or modify a requirement. A requirement can be a functionality or a feature planned to be delivered in a product.
Show Source
Nested 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
Nested Schema : requirements-ChildRequirements-ChildRequirements-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all requirements 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

Example of Response Body

The following example shows the contents of the response body in JSON format.

 { "RqmtId": 300100111073040, "RqmtName": "128D43RRF_REQ01", "OwnerEmail": "prj_mark_taylor_in_grp@oracle.com", "Owner": "Mark Taylor", "RqmtCode": "62", "StatusCode": "DRAFT", "Status": "Draft", "PriorityCode": "MEDIUM", "Priority": "Medium", "ParentRqmtId": 111, "ParentRqmtCode": "1", "ParentRqmtName": "All Requirements", "ReleaseNumber": null, "ReleaseName": null, "ProductCode": "PJT", "ProductName": "PROJECT MANAGEMENT", "links": [... ] }, { "RqmtId": 300100111073041, "RqmtName": "128D43RRF_REQ01.1", "OwnerEmail": "prj_mark_taylor_in_grp@oracle.com", "Owner": "Mark Taylor", "RqmtCode": "63", "StatusCode": "DRAFT", "Status": "Draft", "PriorityCode": "MEDIUM", "Priority": "Medium", "ParentRqmtId": 300100111073040, "ParentRqmtCode": "62", "ParentRqmtName": "128D43RRF_REQ01", "ReleaseNumber": null, "ReleaseName": null, "ProductCode": "PJT", "ProductName": "PROJECT MANAGEMENT", "links": [... ] },
Back to Top