B2B Message Definitions
b2bMessageDefinitions Based on 26C
Create, change, delete and look up B2B Message Definitions, with b2b location assignments and email properties. Actions include export package and message conversion.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE2 actions
- Record key
MessageId- Required on create
MessageNameTransformMode- At a glance
- 33 fields5 finders2 children4 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions?fields=ApplicationPartnerCodeXpath,AttachmentsFlag,DefaultEmailSubject,Direction,DirectionDescription&limit=25&onlyData=true
{
"items": [
{
"ApplicationPartnerCodeXpath": "<string, max 2000>",
"AttachmentsFlag": false,
"DefaultEmailSubject": "<string, max 512>",
"Direction": "<string, max 100>",
"DirectionDescription": "<string, max 80>"
}
],
"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 33
| Attribute | Type | Use |
|---|---|---|
ApplicationPartnerCodeXpath | text · max 2000 | Optional on createUpdatableSearchable |
AttachmentsFlag | yes/no · max 255 | Read-onlySearchable |
DefaultEmailSubject | text · max 512 | Optional on createUpdatableSearchable |
Direction | text · max 100 | Read-onlySearchable |
DirectionDescription | text · max 80 | Read-onlySearchable |
DocumentDescription | text · max 256 | Read-onlySearchable |
DocumentId | number | Optional on createSearchable |
DocumentName | text · max 255 | Optional on createSearchable |
DocumentType | text · max 256 | Read-onlySearchable |
DocumentTypeDescription | text · max 80 | Read-onlySearchable |
ExternalMessageTypeId | number | Optional on createSearchable |
ExternalMessageTypeName | text | Optional on createSearchable |
GenericXsltFileName | text · max 512 | Optional on createUpdatableSearchable |
MappingFile | text | Optional on createUpdatable |
MappingFileName | text · max 512 | Optional on createUpdatableSearchable |
MappingFunctionsFile | text | Optional on createUpdatable |
MappingFunctionsFilename | text · max 512 | Optional on createUpdatableSearchable |
MessageDescription | text · max 256 | Optional on createUpdatableSearchable |
MessageId | number | Optional on createSearchable |
MessageName | text · max 256 | Required on createSearchable |
MessageStandard | text · max 100 | Read-onlySearchable |
MessageStandardDescription | text · max 80 | Read-onlySearchable |
MessageSubtype | text · max 512 | Read-onlySearchable |
MessageType | text · max 100 | Read-onlySearchable |
MessageVersion | text · max 100 | Read-onlySearchable |
ObjectKeyXpath | text · max 2000 | Optional on createUpdatableSearchable |
PayloadTemplate | text | Optional on createUpdatable |
RecipientEmailXpath | text · max 2000 | Optional on createUpdatableSearchable |
ServiceProviderName | text | Optional on createSearchable |
TrOrigionalMessageId | text | Optional on create |
TransformMode | text · max 30 | Required on createUpdatableSearchable |
UserDefinedFlag | yes/no · max 10 | Read-onlySearchable |
XsltFile | text | Optional on createUpdatable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 5
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
AgentMessageFinder·pDocumentIdpMessageStandardpServiceProviderIdfindByMessageName·MessageNamefindByProviderOrNullProvider·bindProviderIdfindByWord·SearchTermshcmSearch·bindDirectionbindDocumentIdbindInputbindMessageStandardbindServiceProviderIdbindTransformModebindUserDefined
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 2
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions/{MessageId}/child/<name>. Add them to a GET with expand.
b2bLocationAssignmentsGET B2B Location Assignments · 3 fieldsCrossReferenceB2BLocationAssignmentIdTypeValueXpathemailPropertiesGET · POST · PATCH · DELETE Email Properties · 4 fieldsEmailPropertyIdNameSequenceNumberTitleType
Actions 2
POST …/action/exportPackage·MessageIdPOST …/action/messageConversion·EntityIdMappingIdentifierMessage
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/b2bMessageDefinitionsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
AgentMessageFinderfor 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:ApplicationPartnerCodeXpath, notapplicationpartnercodexpath. - 12 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- 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.