Item Categories
itemCategories Based on 26C
Create, change and look up Item Categories, with translatable attributes. Actions include share category.
The record key itemCategoriesUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)6 actions
- Record key
itemCategoriesUniqID- Required on create
CatalogIdCategoryCodeCategoryName- At a glance
- 17 fields3 finders4 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/itemCategories?fields=CatalogCode,CatalogControlLevel,CatalogControlLevelValue,CatalogId,CatalogName&limit=25&onlyData=true
{
"items": [
{
"CatalogCode": "<string, max 255>",
"CatalogControlLevel": 0,
"CatalogControlLevelValue": "<string, max 255>",
"CatalogId": 0,
"CatalogName": "<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 17
| Attribute | Type | Use |
|---|---|---|
CatalogCode | text · max 255 | Optional on createUpdatableSearchable |
CatalogControlLevel | number | Read-onlySearchable |
CatalogControlLevelValue | text · max 255 | Read-only |
CatalogId | number | Required on createSearchable |
CatalogName | text · max 30 | Read-onlySearchable |
CategoryCode | text · max 820 | Required on createUpdatableSearchable |
CategoryId | number | Optional on createSearchable |
CategoryName | text · max 250 | Required on createUpdatableSearchable |
CreationDateTime | date-time | Read-onlySearchable |
Description | text · max 240 | Optional on createUpdatableSearchable |
EndDate | date | Optional on createUpdatableSearchable |
ItemsOnlyFlag | yes/no · max 30 · default false | Optional on createUpdatableSearchable |
LastUpdateDateTime | date-time | Read-onlySearchable |
ParentCategoryCode | text · max 255 | Optional on createUpdatableSearchable |
ParentCategoryId | number | Read-onlySearchable |
SharedFlag | yes/no · max 1 | Read-onlySearchable |
StartDate | date | 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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByFunctionalAreaId·FunctionalAreaIdfindDefaultCategories·Bind_CatalogCodefindParentCategories·Bind_CatalogCode
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/itemCategories/{itemCategoriesUniqID}/child/<name>. Add them to a GET with expand.
DFFGET · POST · PATCH Descriptive Flexfields for Item Categories · 3 fieldsCategoryId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET · POST · PATCH · DELETE Attachments · 29 fieldsAsyncTrackerIdCategoryNameContentRepositoryFileCheckedOutByContentRepositoryFileSharedCreatedByCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDocumentURLDownloadInfoErrorStatusCodeErrorStatusMessageFileContentsFileNameFileUrlLastUpdateDateLastUpdatedByTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameattachmentDFFGET · POST · PATCH · DELETE Attached Documents Descriptive Flexfield · 3 fieldsAttachedDocumentId__FLEX_Context__FLEX_Context_DisplayValuetranslatableAttributesGET · POST · PATCH Translatable Attributes · 7 fieldsCategoryIdCategoryNameCreationDateTimeDescriptionLanguageLastUpdateDateTimeSourceLanguage
Actions 6
POST …/action/shareCategory·copyFlagincludeChildrenFlagtargetCategoryCodesourceCategoryCodecopyItemsFlagtargetCatalogCodesourceCatalogCodePOST …/{itemCategoriesUniqID}/child/attachments/{attachmentsUniqID}/action/cancelCheckOutPOST …/{itemCategoriesUniqID}/child/attachments/{attachmentsUniqID}/action/checkIn·fileNamefiletitlecontentTypePOST …/{itemCategoriesUniqID}/child/attachments/{attachmentsUniqID}/action/checkOutPOST …/{itemCategoriesUniqID}/child/attachments/{attachmentsUniqID}/action/fetchVersionsPOST …/{itemCategoriesUniqID}/child/attachments/{attachmentsUniqID}/action/updateActiveVersion·versionId
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/itemCategoriesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByFunctionalAreaIdfor 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:CatalogCode, notcatalogcode. - 7 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- 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.