Collaboration Relationships
collaborationRelationships Based on 26C
Create, change, delete and look up Collaboration Relationships, with collaboration planners. Actions include mass delete and mass update.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE2 actions
- Record key
RelationshipNumber- Required on create
- none marked
- At a glance
- 54 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/collaborationRelationships?fields=AdjustCommits,AdjustOrderForecasts,AttributeId,B2BMessagingConfigured,CollaborationUOMCode&limit=25&onlyData=true
{
"items": [
{
"AdjustCommits": "N",
"AdjustOrderForecasts": "N",
"AttributeId": 0,
"B2BMessagingConfigured": "<string, max 255>",
"CollaborationUOMCode": "<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 54
| Attribute | Type | Use |
|---|---|---|
AdjustCommits | text · max 1 · default N | Optional on createUpdatableSearchable |
AdjustOrderForecasts | text · max 1 · default N | Optional on createUpdatableSearchable |
AttributeId | number | Optional on createSearchable |
B2BMessagingConfigured | text · max 255 | Read-onlySearchable |
CollaborationUOMCode | text | Optional on createUpdatableSearchable |
CollaborationUOMSourceCode | text · max 32 · default ORA_VCS_UOMSOURCE_PUB | Optional on createUpdatableSearchable |
CollaborationUOMSourceName | text · max 255 | Optional on createUpdatableSearchable |
CollaborationUnitOfMeasure | text | Optional on createUpdatableSearchable |
CommitHorizonInDays | number | Optional on createUpdatableSearchable |
CommitPeriod | text · max 32 | Optional on createUpdatableSearchable |
CommitPeriodDays | number | Optional on createUpdatableSearchable |
CommitQuantity | text · max 32 | Optional on createUpdatableSearchable |
CommitQuantityPercentage | number | Optional on createUpdatableSearchable |
CommitSlaInDays | number | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DropShipFlag | yes/no | Read-onlySearchable |
EffectiveEndDate | date | Optional on createUpdatableSearchable |
EffectiveStartDate | date | Optional on createUpdatableSearchable |
ForecastHorizonInDays | number | Optional on createUpdatableSearchable |
InventoryItemId | number | Optional on createUpdatableSearchable |
ItemCategory | text · max 255 | Optional on createUpdatableSearchable |
ItemDescription | text · max 255 | Read-onlySearchable |
ItemNumber | text | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ManufacturerName | text · max 100 | Optional on createUpdatableSearchable |
ManufacturerPartNumber | text · max 100 | Optional on createUpdatableSearchable |
ObjectVersionNumber | number | Optional on createUpdatableSearchable |
ProcurementBU | text | Optional on createUpdatableSearchable |
ProcurementBUId | number | Read-onlySearchable |
RelationshipId | number | Read-onlySearchable |
RelationshipNumber | number · default -1 | Read-onlySearchable |
ShipFromSupplierAlternateName | text | Read-onlySearchable |
ShipFromSupplierDUNS | text · max 30 | Read-onlySearchable |
ShipFromSupplierId | number | Read-onlySearchable |
ShipFromSupplierName | text | Optional on createUpdatableSearchable |
ShipFromSupplierNumber | text · max 30 | Read-onlySearchable |
ShipFromSupplierSiteId | number | Optional on createUpdatableSearchable |
ShipFromSupplierSiteName | text | Optional on createUpdatableSearchable |
ShipToOrganizationCode | text | Optional on createUpdatableSearchable |
ShipToOrganizationId | number | Optional on createUpdatableSearchable |
ShipToOrganizationName | text · max 255 | Read-onlySearchable |
ShipToSupplierAlternateName | text | Read-onlySearchable |
ShipToSupplierDUNS | text · max 30 | Read-onlySearchable |
ShipToSupplierId | number | Read-onlySearchable |
ShipToSupplierName | text · max 360 | Read-onlySearchable |
ShipToSupplierNumber | text · max 30 | Read-onlySearchable |
ShipToSupplierSiteId | number | Read-onlySearchable |
ShipToSupplierSiteName | text · max 15 | Read-onlySearchable |
SlaAction | text · max 32 | Optional on createUpdatableSearchable |
SourceSystem | text · max 255 | Read-onlySearchable |
SourceSystemCode | text · max 30 | Read-onlySearchable |
ViewOrderForecasts | text · max 1 · default N | 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.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
RowFinder·RelationshipNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/collaborationRelationships/{RelationshipNumber}/child/<name>. Add them to a GET with expand.
collaborationPlannersGET Planners · 7 fieldsFullAccessFlagPersonIdPlannerSecurityContextSecurityContextCodeStatusStatusCode
Actions 2
POST …/action/massDelete·RelationshipIdArrayPOST …/action/massUpdate·CommitQuantityCommitSlaInDaysCommitHorizonInDaysForecastHorizonInDaysCommitQuantityActionEffectiveStartDateActionEffectiveEndDateActionRelationshipIdArrayCommitPeriodActionCommitPeriodDaysSlaValueAdjustOrderForecastsCommitQuantityPercentageCollaborationUOMSourceCodeSlaActionManufacturerNameEffectiveEndDateCommitSlaInDaysActionManufacturerPartNumberCollaborationUOMCodeForecastHorizonInDaysActionEffectiveStartDateCommitHorizonInDaysActionAdjustCommitsCommitPeriodViewOrderForecasts
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/collaborationRelationshipsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
RowFinderfor 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:AdjustCommits, notadjustcommits. - 24 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. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.