Collaboration Order Forecasts
collaborationOrderForecasts Based on 26C
Change, delete and look up Collaboration Order Forecasts, with commit quantities, exception quantities and forecast quantities. No create.
- Operations
- GET (list)GET (one)PATCH (update)DELETE
- Record key
CollaborationOrderForecastId- Required on create
- no create on this resource
- At a glance
- 67 fields1 finders4 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts?fields=B2BOnlyFlag,CollaborationCycleVersion,CollaborationOrderForecastId,CollaborationPlanId,CollaborationPlanName&limit=25&onlyData=true
{
"items": [
{
"B2BOnlyFlag": false,
"CollaborationCycleVersion": 0,
"CollaborationOrderForecastId": 0,
"CollaborationPlanId": 0,
"CollaborationPlanName": "<string, max 30>"
}
],
"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 67
| Attribute | Type | Use |
|---|---|---|
B2BOnlyFlag | yes/no | UpdatableSearchable |
CollaborationCycleVersion | number | Read-onlySearchable |
CollaborationOrderForecastId | number | UpdatableSearchable |
CollaborationPlanId | number | Read-onlySearchable |
CollaborationPlanName | text · max 30 | Read-onlySearchable |
CollaborationSourceId | number | Read-onlySearchable |
CommitDate | date-time | Read-onlySearchable |
CommitDueDate | date-time | Read-onlySearchable |
CommitTotalQuantity | number | Read-onlySearchable |
CorrelationCode | text · max 64 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreatedByPersonId | number | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DropShipFlag | yes/no | Read-onlySearchable |
ForecastTotalCommitHorizonQuantity | number | Read-onlySearchable |
ForecastTotalForecastHorizonQuantity | number | Read-onlySearchable |
InventoryItemId | text · max 255 | Read-onlySearchable |
ItemCategory | text · max 255 | UpdatableSearchable |
ItemDescription | text · max 255 | Read-onlySearchable |
ItemNumber | text · max 255 | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ManufacturerName | text · max 100 | Read-onlySearchable |
ManufacturerPartNumber | text · max 100 | Read-onlySearchable |
NoteToPlanner | text · max 1000 | UpdatableSearchable |
NoteToSupplier | text · max 1000 | UpdatableSearchable |
OnHandPublishedByUserName | text · max 100 | Read-onlySearchable |
OnHandPublishedDate | date-time | Read-onlySearchable |
OnHandQuantity | number | Read-onlySearchable |
PlanningCycleEndDate | date | Read-onlySearchable |
PlanningCycleStartDate | date | Read-onlySearchable |
ProcurementBUId | number | Read-onlySearchable |
ProcurementBUName | text · max 240 | Read-onlySearchable |
PublishedByPersonId | number | Read-onlySearchable |
PublishedByUserName | text · max 255 | Read-onlySearchable |
PublishedDate | date-time | Read-onlySearchable |
ShipFromSupplierAlternateName | text | Read-onlySearchable |
ShipFromSupplierDUNS | text · max 30 | Read-onlySearchable |
ShipFromSupplierId | number | Read-onlySearchable |
ShipFromSupplierName | text · max 360 | Read-onlySearchable |
ShipFromSupplierNumber | text · max 30 | Read-onlySearchable |
ShipFromSupplierSiteId | number | Read-onlySearchable |
ShipFromSupplierSiteName | text · max 240 | Read-onlySearchable |
ShipToCustomerId | number | Read-onlySearchable |
ShipToCustomerName | text · max 255 | Read-onlySearchable |
ShipToCustomerSiteId | number | Read-onlySearchable |
ShipToCustomerSiteName | text · max 255 | Read-onlySearchable |
ShipToOrganizationCode | text · max 255 | Read-onlySearchable |
ShipToOrganizationId | text · max 255 | Read-onlySearchable |
ShipToOrganizationName | text · max 255 | Read-onlySearchable |
ShipToSupplierId | number | Read-onlySearchable |
ShipToSupplierName | text · max 360 | Read-onlySearchable |
ShipToSupplierSiteId | number | Read-onlySearchable |
ShipToSupplierSiteName | text · max 240 | Read-onlySearchable |
SourceSystem | text · max 80 | Read-onlySearchable |
SourceSystemCode | text · max 30 | Read-onlySearchable |
Status | text · max 80 | Read-onlySearchable |
StatusCode | text · max 32 | Read-onlySearchable |
SupplierItemNumber | text · max 255 | Read-onlySearchable |
SupplierOnHandPublishedByUserName | text · max 100 | Read-onlySearchable |
SupplierOnHandPublishedDate | date-time | Read-onlySearchable |
SupplierOnHandQuantity | number | Read-onlySearchable |
SupplyPlanDescription | text · max 100 | Read-onlySearchable |
SupplyPlanName | text · max 30 | Read-onlySearchable |
SupplyPlanVersion | number | Read-onlySearchable |
UOMCode | text · max 3 | Read-onlySearchable |
UnitOfMeasure | text · max 255 | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
vcsFindByCollabOrderForecastId·CollaborationOrderForecastId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 4
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/collaborationOrderForecasts/{CollaborationOrderForecastId}/child/<name>. Add them to a GET with expand.
commitQuantitiesGET · POST Commit Quantities · 15 fields · 1 findersBucketAggregationCodeBucketEndDateBucketIdBucketStartDateCollaborationOrderForecastDetailsIdCollaborationOrderForecastIdCommitDateCommitMismatchReasonCommitMismatchReasonCodeCommittedByPartyCodeCommittedByPersonIdCommittedByUserNameCorrelationCodeQuantityVersionexceptionQuantitiesGET Exception Quantities · 12 fieldsBucketAggregationCodeBucketEndDateBucketIdBucketStartDateCollaborationOrderForecastIdExceptionFactorExceptionIdExceptionTypeCodeMaximumCommitVersionMaximumForecastVersionPrimaryExceptionVariableSecondaryExceptionVariableforecastQuantitiesGET · POST Forecast Quantities · 13 fields · 1 findersBucketAggregationCodeBucketEndDateBucketIdBucketStartDateCollaborationOrderForecastDetailsIdCollaborationOrderForecastIdCorrelationCodePublishSourceCodePublishedByPersonIdPublishedByUserNamePublishedDateQuantityVersionreferenceQuantitiesGET Reference Quantities · 16 fieldsBucketEndDateBucketIdBucketStartDateCollaborationOrderForecastIdDocumentReferenceNumberMeasureNamePublishDatePublishSourceCodePublishedByPersonIdPublishedByUserNamePublisherOrderTypeCodeQuantityRefercenceDetailsIdReferenceHeaderIdReferenceLineIdReferenceLineLocationId
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/collaborationOrderForecastsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
vcsFindByCollabOrderForecastIdfor the agent's main search: its variables become clean tool parameters. - 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:B2BOnlyFlag, notb2bonlyflag. - 62 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.