Update a child requirement
patch
/fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/ChildRequirements/{RqmtId2}/child/ChildRequirements/{RqmtId3}
Request
Path Parameters
-
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=
-
RqmtId3(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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Owner: string
Title:
Requirement Owner
Name of the requirement owner. -
OwnerEmail: string
Title:
Requirement Owner E-Mail
Email of the requirement owner. -
ParentRqmtCode: string
Title:
Parent Requirement Code
Unique code of the parent requirement. -
ParentRqmtId: integer
(int64)
Title:
Parent Requirement ID
Default Value:111
Unique identifier of the parent requirement. -
ParentRqmtName: string
Title:
Parent Requirement Name
Name of the parent requirement. -
Priority: string
Title:
Requirement Priority
Priority of the requirement. -
PriorityCode: string
Title:
Requirement Priority Code
Maximum Length:30
Default Value:MEDIUM
Unique code of the requirement priority. -
ProductName: string
Title:
Product Name
Name of the product. -
RqmtCode: string
Title:
Requirement Code
Maximum Length:30
Unique code of the requirement in the requirement hierarchy. -
RqmtName: string
Title:
Requirement Name
Maximum Length:100
Name of the requirement. -
Status: string
Title:
Requirement Status
Status of the requirement. -
StatusCode: string
Title:
Requirement Status Code
Maximum Length:30
Default Value:DRAFT
Unique code of the requirement status.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-ChildRequirements-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Owner: string
Title:
Requirement Owner
Name of the requirement owner. -
OwnerEmail: string
Title:
Requirement Owner E-Mail
Email of the requirement owner. -
ParentRqmtCode: string
Title:
Parent Requirement Code
Unique code of the parent requirement. -
ParentRqmtId: integer
(int64)
Title:
Parent Requirement ID
Default Value:111
Unique identifier of the parent requirement. -
ParentRqmtName: string
Title:
Parent Requirement Name
Name of the parent requirement. -
Priority: string
Title:
Requirement Priority
Priority of the requirement. -
PriorityCode: string
Title:
Requirement Priority Code
Maximum Length:30
Default Value:MEDIUM
Unique code of the requirement priority. -
ProductCode: string
Title:
Product Code
Read Only:true
Maximum Length:30
Unique code of the product. -
ProductName: string
Title:
Product Name
Name of the product. -
ReleaseName: string
Title:
Release Name
Read Only:true
Maximum Length:50
Name of the product release. -
ReleaseNumber: string
Title:
Release Number
Read Only:true
Maximum Length:30
Unique number of the product release. -
RqmtCode: string
Title:
Requirement Code
Maximum Length:30
Unique code of the requirement in the requirement hierarchy. -
RqmtId: integer
(int64)
Title:
Requirement ID
Read Only:true
Unique identifier of the project requirement in the requirement hierarchy. -
RqmtName: string
Title:
Requirement Name
Maximum Length:100
Name of the requirement. -
Status: string
Title:
Requirement Status
Status of the requirement. -
StatusCode: string
Title:
Requirement Status Code
Maximum Length:30
Default Value:DRAFT
Unique code of the requirement status.
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 update a child requirement 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}}
Request Body Example
The following shows an example of the request body in JSON format.
{ "RqmtName": "REQ01.2", "StatusCode": "COMPLETE", "OwnerEmail": "prj_mark_taylor_in_grp@oracle.com", "PriorityCode": "HIGH" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "RqmtId": 300100114014089, "RqmtName": "REQ01.2", "OwnerEmail": "prj_mark_taylor_in_grp@oracle.com", "Owner": "Mark Taylor", "RqmtCode": "9063", "StatusCode": "COMPLETE", "Status": "Complete", "PriorityCode": "HIGH", "Priority": "High", "ParentRqmtId": 300100111073040, "ParentRqmtCode": "62", "ParentRqmtName": "128D43RRF_REQ01", "ReleaseNumber": null, "ReleaseName": null, "ProductCode": null, "ProductName": null, "links":[ ... ] }