// fusionrest agent · supply chain and manufacturing · scm common

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.

/fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions
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
I want to…List the latest 25Count recordsGet one recordCreate oneUpdate one

Try it

Response fields ·
Filters (q)

Only attributes Oracle marks as searchable are offered.

Finder
Include children (expand)
Paging and options
limit
Endpoint and headers
GET /fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions?fields=ApplicationPartnerCodeXpath,AttachmentsFlag,DefaultEmailSubject,Direction,DirectionDescription&limit=25&onlyData=true
Response shape (placeholders)
{
  "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

AttributeTypeUse
ApplicationPartnerCodeXpathtext · max 2000Optional on createUpdatableSearchable
AttachmentsFlagyes/no · max 255Read-onlySearchable
DefaultEmailSubjecttext · max 512Optional on createUpdatableSearchable
Directiontext · max 100Read-onlySearchable
DirectionDescriptiontext · max 80Read-onlySearchable
DocumentDescriptiontext · max 256Read-onlySearchable
DocumentIdnumberOptional on createSearchable
DocumentNametext · max 255Optional on createSearchable
DocumentTypetext · max 256Read-onlySearchable
DocumentTypeDescriptiontext · max 80Read-onlySearchable
ExternalMessageTypeIdnumberOptional on createSearchable
ExternalMessageTypeNametextOptional on createSearchable
GenericXsltFileNametext · max 512Optional on createUpdatableSearchable
MappingFiletextOptional on createUpdatable
MappingFileNametext · max 512Optional on createUpdatableSearchable
MappingFunctionsFiletextOptional on createUpdatable
MappingFunctionsFilenametext · max 512Optional on createUpdatableSearchable
MessageDescriptiontext · max 256Optional on createUpdatableSearchable
MessageIdnumberOptional on createSearchable
MessageNametext · max 256Required on createSearchable
MessageStandardtext · max 100Read-onlySearchable
MessageStandardDescriptiontext · max 80Read-onlySearchable
MessageSubtypetext · max 512Read-onlySearchable
MessageTypetext · max 100Read-onlySearchable
MessageVersiontext · max 100Read-onlySearchable
ObjectKeyXpathtext · max 2000Optional on createUpdatableSearchable
PayloadTemplatetextOptional on createUpdatable
RecipientEmailXpathtext · max 2000Optional on createUpdatableSearchable
ServiceProviderNametextOptional on createSearchable
TrOrigionalMessageIdtextOptional on create
TransformModetext · max 30Required on createUpdatableSearchable
UserDefinedFlagyes/no · max 10Read-onlySearchable
XsltFiletextOptional 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.

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.

Actions 2

Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.

Use in AI Agent Studio

More in For Builders.

Pitfalls