1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Product Lifecycle Management
  4. Requirement Specifications

Create a requirement specification

post

/fscmRestApi/resources/11.13.18.05/requirementSpecifications

Request

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 : Requirement Team Members
Type: array
Title: Requirement Team Members
The Requirement Team Members resource manages the users who are authorized to access the requirement specification.
Show Source
Nested Schema : Requirement Versions
Type: array
Title: Requirement Versions
The Requirement Versions resource manages the versions of a requirement specification.
Show Source
Nested Schema : requirementSpecifications-RequirementTeam-item-post-request
Type: object
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-item-post-request
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments of a requirement.
Show Source
Nested Schema : Requirement Line Items
Type: array
Title: Requirement Line Items
The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-Attachments-item-post-request
Type: object
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-RequirementLineItem-item-post-request
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments of a requirement.
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-post-request
Type: object
Show Source
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 : requirementSpecifications-item-response
Type: object
Show Source
Nested Schema : Requirement Team Members
Type: array
Title: Requirement Team Members
The Requirement Team Members resource manages the users who are authorized to access the requirement specification.
Show Source
Nested Schema : Requirement Versions
Type: array
Title: Requirement Versions
The Requirement Versions resource manages the versions of a requirement specification.
Show Source
Nested Schema : requirementSpecifications-RequirementTeam-item-response
Type: object
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments of a requirement.
Show Source
Nested Schema : Requirement Line Items
Type: array
Title: Requirement Line Items
The Requirement Line Items resource manages the requirements within a requirement specification. Each requirement line has priority and estimates. The estimates roll up to the top-level requirement.
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-Attachments-item-response
Type: object
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-RequirementLineItem-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments of a requirement.
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-response
Type: object
Show Source
Links
RequirementTeam
Parameters:
  • RequirementId: $request.path.RequirementId
The Requirement Team Members resource manages the users who are authorized to access the requirement specification.
RequirementVersion
Parameters:
  • RequirementId: $request.path.RequirementId
The Requirement Versions resource manages the versions of a requirement specification.
Back to Top

Examples

This example describes how to create a requirement specification.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/requirementSpecifications"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates. 

{
	"Name": "Flying-Bike-Requirements",
	"RequirementType" : "REQUIREMENTS_SPECIFICATION"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"Name": "Flying-Bike-Requirements",
	"LatestVersionId": 300100240957737,
	"LatestVersionNumber": 1,
	"RequirementId": 300100240957736,
	"RequirementType": "REQUIREMENTS_SPECIFICATION",
	"RequirementTypeName": "Requirements Specification",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736",
		"name": "requirementSpecifications",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736",
		"name": "requirementSpecifications",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736/child/RequirementTeam",
		"name": "RequirementTeam",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/requirementSpecifications/300100240957736/child/RequirementVersion",
		"name": "RequirementVersion",
		"kind": "collection"
	}
	]
}
Back to Top