Requirements
requirements Based on 26C
Create, change, delete and look up Requirements, with backlog items and child requirements.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
RqmtId- Required on create
RqmtName- At a glance
- 16 fields0 finders6 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/requirements?fields=Owner,OwnerEmail,ParentRqmtCode,ParentRqmtId,ParentRqmtName&limit=25&onlyData=true
{
"items": [
{
"Owner": "<string>",
"OwnerEmail": "<string>",
"ParentRqmtCode": "<string>",
"ParentRqmtId": 111,
"ParentRqmtName": "<string>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's 26C REST specification.
Fields 16
| Attribute | Type | Use |
|---|---|---|
Owner | text | Optional on createUpdatableSearchable |
OwnerEmail | text | Optional on createUpdatableSearchable |
ParentRqmtCode | text | Optional on createUpdatableSearchable |
ParentRqmtId | number · default 111 | Optional on createUpdatableSearchable |
ParentRqmtName | text | Optional on createUpdatableSearchable |
Priority | text | Optional on createUpdatableSearchable |
PriorityCode | text · max 30 · default MEDIUM | Optional on createUpdatableSearchable |
ProductCode | text · max 30 | Read-onlySearchable |
ProductName | text | Optional on createUpdatableSearchable |
ReleaseName | text · max 50 | Read-onlySearchable |
ReleaseNumber | text · max 30 | Read-onlySearchable |
RqmtCode | text · max 30 | Optional on createUpdatableSearchable |
RqmtId | number | Read-onlySearchable |
RqmtName | text · max 100 | Required on createUpdatableSearchable |
Status | text | Optional on createUpdatableSearchable |
StatusCode | text · max 30 · default DRAFT | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 6
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/requirements/{RqmtId}/child/<name>. Add them to a GET with expand.
BacklogItemsGET · POST · PATCH · DELETE BacklogItems · 23 fieldsAdditionalDetailsBacklogItemCodeBacklogItemIdBacklogItemNameBacklogOwnerBacklogOwnerEmailBacklogPriorityBacklogPriorityCodeBacklogProductCodeBacklogProductNameBacklogReleaseNameBacklogReleaseNumberBacklogStatusBacklogStatusCodeBacklogStorypointsEffortRankRequirementCodeRequirementNameScrumMasterEmailScrumMasterNameSprintUserStoryAcceptanceCriteriaGET · POST · PATCH · DELETE AcceptanceCriterions · 2 fieldsCriteriaIdCriteriaNameChildRequirementsGET · POST · PATCH · DELETE ChildRequirements · 16 fieldsOwnerOwnerEmailParentRqmtCodeParentRqmtIdParentRqmtNamePriorityPriorityCodeProductCodeProductNameReleaseNameReleaseNumberRqmtCodeRqmtIdRqmtNameStatusStatusCodeBacklogItemsGET · POST · PATCH · DELETE BacklogItems · 23 fieldsAdditionalDetailsBacklogItemCodeBacklogItemIdBacklogItemNameBacklogOwnerBacklogOwnerEmailBacklogPriorityBacklogPriorityCodeBacklogProductCodeBacklogProductNameBacklogReleaseNameBacklogReleaseNumberBacklogStatusBacklogStatusCodeBacklogStorypointsEffortRankRequirementCodeRequirementNameScrumMasterEmailScrumMasterNameSprintUserStoryAcceptanceCriteriaGET · POST AcceptanceCriterions · 2 fieldsCriteriaIdCriteriaNameChildRequirementsGET · POST · PATCH · DELETE ChildRequirements · 16 fieldsOwnerOwnerEmailParentRqmtCodeParentRqmtIdParentRqmtNamePriorityPriorityCodeProductCodeProductNameReleaseNameReleaseNumberRqmtCodeRqmtIdRqmtNameStatusStatusCode
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/requirementsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:Owner, notowner. - 4 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.