Collaboration Document Definitions
collaborationDocumentDefinitions Based on 26C
Change and look up Collaboration Document Definitions, with document actions, document parameters and measures. No create.
- Operations
- GET (list)GET (one)PATCH (update)
- Record key
DocumentId- Required on create
- no create on this resource
- At a glance
- 18 fields0 finders7 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions?fields=CollaborationObjectCode,CreatedBy,CreationDate,CustomerLevel,CustomerLevelCode&limit=25&onlyData=true
{
"items": [
{
"CollaborationObjectCode": "<string, max 30>",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"CustomerLevel": "<string, max 80>",
"CustomerLevelCode": "<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 18
| Attribute | Type | Use |
|---|---|---|
CollaborationObjectCode | text · max 30 | Searchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CustomerLevel | text · max 80 | Read-onlySearchable |
CustomerLevelCode | text · max 30 | Searchable |
DocumentId | number | Read-onlySearchable |
DocumentTypeCode | text · max 60 | Searchable |
DocumentTypeName | text · max 80 | UpdatableSearchable |
ItemLevel | text · max 80 | Read-onlySearchable |
ItemLevelCode | text · max 30 | Searchable |
ItemResolution | text · max 80 | Read-onlySearchable |
ItemResolutionCode | text · max 30 | Searchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
OrganizationLevel | text · max 80 | Read-onlySearchable |
OrganizationLevelCode | text · max 30 | Searchable |
Status | text · max 80 | UpdatableSearchable |
StatusCode | text · max 30 | UpdatableSearchable |
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 7
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/<name>. Add them to a GET with expand.
documentActionsGET · POST · DELETE Document Actions · 7 fieldsActionCodeActionIdActionNameCreatedByCreationDateLastUpdateDateLastUpdatedBydocumentActionParticipantsGET · POST · DELETE Document Action Participants · 8 fieldsActionIdCreatedByCreationDateLastUpdateDateLastUpdatedByParticipantCodeParticipantIdParticipantNamedocumentParametersGET · PATCH Document Parameters · 9 fields · 1 findersCreatedByCreationDateInstanceParameterIdLastUpdateDateLastUpdatedByParameterCodeParameterNameParameterValueSecondParameterValuemeasuresGET · POST · PATCH · DELETE Measures · 11 fieldsCreatedByCreationDateDataTypeCodeDocumentMeasureIdLastUpdateDateLastUpdatedByMeasureIdMeasureTypeCodeMeasureTypeNameParticipantOwnerCodeParticipantOwnerNamemeasureActionsGET · POST · DELETE Measure Actions · 7 fieldsActionCodeActionIdActionNameCreatedByCreationDateLastUpdateDateLastUpdatedBymeasureActionParticipantsGET · POST Measure Action Participants · 8 fieldsActionIdCreatedByCreationDateLastUpdateDateLastUpdatedByParticipantCodeParticipantIdParticipantNamemeasureParametersGET · POST · PATCH Measure Parameters · 9 fields · 1 findersCreatedByCreationDateInstanceParameterIdLastUpdateDateLastUpdatedByParameterCodeParameterNameParameterValueSecondParameterValue
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitionsand 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:CollaborationObjectCode, notcollaborationobjectcode. - 9 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.