itemStructures
itemStructures Based on 26C
Create, change and look up itemStructures, with component and expansion.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)5 actions
- Record key
BillSequenceId- Required on create
EffectivityControlItemIdOrganizationId- At a glance
- 23 fields2 finders10 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/itemStructures?fields=AlternateBOMDesignator,BillSequenceId,ChangeNotice,CommonBillSequenceId,CommonItemNumber&limit=25&onlyData=true
{
"items": [
{
"AlternateBOMDesignator": "<string, max 80>",
"BillSequenceId": 0,
"ChangeNotice": "<string>",
"CommonBillSequenceId": 0,
"CommonItemNumber": "<string, max 300>"
}
],
"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 23
| Attribute | Type | Use |
|---|---|---|
AlternateBOMDesignator | text · max 80 | Optional on createSearchable |
BillSequenceId | number | Read-onlySearchable |
ChangeNotice | text | Read-onlySearchable |
CommonBillSequenceId | number | Optional on createUpdatableSearchable |
CommonItemNumber | text · max 300 | Read-onlySearchable |
CommonOrganizationCode | text · max 18 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDateTime | date-time | Read-onlySearchable |
Description | text · max 240 | Optional on createUpdatableSearchable |
EffectivityControl | number | Required on createSearchable |
EffectivityControlValue | text | Optional on createSearchable |
ItemId | text · max 240 | Required on createSearchable |
ItemNumber | text | Optional on createSearchable |
LastUpdateDateTime | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
OrganizationCode | text | Optional on createSearchable |
OrganizationId | text · max 240 | Required on createSearchable |
OriginalSystemReference | text · max 50 | Optional on createUpdatableSearchable |
RequestId | number | Read-onlySearchable |
SourceItemNumber | text · max 300 | Read-onlySearchable |
SourceOrganizationCode | text · max 18 | Read-onlySearchable |
StructureName | text | Optional on createSearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
AltKey·AlternateBOMDesignatorItemIdOrganizationIdCreateACLFinder
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 10
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/<name>. Add them to a GET with expand.
ComponentGET · POST · PATCH Component · 69 fieldsACDTypeValueAbsoluteYieldAcdTypeAutoRequestMaterialFlagBasisTypeBasisValueBillSequenceIdChangeIdChangeLineIdChangeNoticeCheckATPFlagCommentsCompAlternateBomDesignatorCompletionTypeCompletionTypeValueComponentItemClassComponentItemIdComponentItemNumberComponentItemStructureNameComponentSequenceIdComponentTypeComponentTypeValueContributeToYieldContributeToYieldValueCreatedByCreationDateTimeEndDateTimeEnforceIntRequirementsEnforceIntegerRequirementsValueFindNumberFromNumberImplementationDateTimeIncludeOnShipDocsFlagInstantiabilityCodeInstantiabilityValueItemSequenceNumberLastUpdateDateTimeLastUpdateLoginLastUpdatedByMaximumQuantityMinimumQuantityMutuallyExclusiveFlagOldComponentSequenceIdOptionalFlagOrganizationIdPlanningPercentPrimaryUOMCodePrimaryUOMCodeValuePrimaryUOMValueProductTypeProductTypeValueQuantityQuantityRelatedFlagReplacedByReplacedByFindNumberReplacesRequiredForRevenueFlagRequiredToShipFlagSalesOrderBasisValueShowInSalesShowInSalesValueSoBasisStartDateTimeSuggestedOperationSequenceSupplyTypeToNumberUsePlaceholderFlagWipSupplyTypeYieldComponentDFFGET · POST · PATCH Change Order Affected Item Structure Component Descriptive Flexfields · 3 fieldsComponentSequenceId__FLEX_Context__FLEX_Context_DisplayValueReferenceDesignatorGET · POST · PATCH · DELETE ReferenceDesignator · 9 fieldsACDTypeACDTypeValueChangeLineIdChangeNoticeCreationDateTimeDescriptionLastUpdateDateTimeReferenceDesignatorReferenceDesignatorSequenceIdReferenceDesignatorDFFGET · POST · PATCH Change Order Affected Item Reference Designator Descriptive Flexfields · 3 fieldsRefDesigSequenceId__FLEX_Context__FLEX_Context_DisplayValueSubstituteComponentGET · POST · PATCH · DELETE SubstituteComponent · 12 fieldsACDTypeACDTypeValueChangeNoticeCreationDateTimeEnforceIntegerRequirementsValueLastUpdateDateTimePrimaryUOMValuePriorityQuantitySubstituteComponentIdSubstituteComponentItemNumberSubstituteComponentSequenceIdSubstituteComponentDFFGET · POST · PATCH Change Order Affected Item Substitute Component Descriptive Flexfields · 3 fieldsSubCompSequenceId__FLEX_Context__FLEX_Context_DisplayValueWhereUsedGET WhereUsed · 22 fieldsBasisValueComponentBillSequenceIdComponentItemDescriptionComponentItemNumberComponentPathComponentSequenceIdEffectivityControlValueEndDateTimeFromSerialNumberFromUnitNumberItemClassNameItemStatusValueItemTypeValueOrganizationCodeParentBillSequenceIdParentItemNumberQuantityStartDateTimeStructureNameToSerialNumberToUnitNumberTopItemFlagExpansionGET Item Structure Explosion · 97 fieldsATPCodeATPComponentFlagATPComponentsCodeATPFlagAbsoluteYieldAutoRequestMaterialFlagBasisTypeBasisValueCheckATPFlagCommentsCommonComponentSequenceIdCompAlternateBomDesignatorCompletionTypeCompletionTypeValueComponentItemIdComponentItemNumberComponentPathComponentSequenceIdComponentSequencePathComponentStructureItemTypeValueComponentTypeComponentTypeValueComponentUOMCodeValueContributeToYieldContributeToYieldValueCustomerOrderEnabledFlagCustomerOrderFlagEndDateTimeEnforceIntRequirementsEnforceIntegerRequirementsValueExpandModelFlagExpandOptionExpansionDateTimeExpansionTypeExtendedQuantityFindNumberFromNumberFromSerialNumberFromUnitNumberImplementationDateImplementationOnlyFlagIncludeOnShipDocsFlagInstantiabilityCodeInstantiabilityValueInternalOrderEnabledFlagInternalOrderFlagInverseQuantityItemClassNameItemSequenceNumberItemStatusMaximumQuantityMinimumQuantityMutuallyExclusiveFlagOptionalFlagOrganizationCodeOrganizationIdParentBillSequenceIdParentCommonBillSequenceIdParentComponentSequencePathParentEffectivityControlParentEffectivityControlValueParentItemIdParentItemNumberParentStructureDescriptionParentStructureItemTypeValueParentStructureNamePercentBatchPercentFormulaPickComponentFlagPlanLevelPlanningPercentagePrimaryUOMValuePrimaryUomCodeProductTypeProductTypeValueQuantityQuantityRelatedFlagReplenishToOrderFlagRequiredForRevenueFlagRequiredToShipFlagSalesOrderBasisValueSalesOrderTransactionFlagShippableItemFlagShowInSalesShowInSalesValueSoBasisStartDateTimeSuggestedOperationSequenceSupplyTypeToNumberTopBillSequenceIdTopItemIdTopItemNumberUsePlaceholderFlagUserItemTypeValueWipSupplyTypeYieldStructureAttachmentsGET Attachments · 33 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileCheckedOutByContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDocumentURLDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlLastUpdateDateLastUpdatedByLastUpdatedByUserNameTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameStructureDFFGET · POST · PATCH StructureDFF · 3 fieldsBillSequenceId__FLEX_Context__FLEX_Context_DisplayValue
Actions 5
POST …/{BillSequenceId}/child/StructureAttachments/{StructureAttachmentsUniqID}/action/cancelCheckOutPOST …/{BillSequenceId}/child/StructureAttachments/{StructureAttachmentsUniqID}/action/checkIn·fileNamefiletitlecontentTypePOST …/{BillSequenceId}/child/StructureAttachments/{StructureAttachmentsUniqID}/action/checkOutPOST …/{BillSequenceId}/child/StructureAttachments/{StructureAttachmentsUniqID}/action/fetchVersionsPOST …/{BillSequenceId}/child/StructureAttachments/{StructureAttachmentsUniqID}/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/itemStructuresand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
AltKeyfor 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:AlternateBOMDesignator, notalternatebomdesignator. - 12 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.