Create outbound messages

post

/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/outboundCollaborationMessages

Request

Path Parameters
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Domain Value Maps
Type: array
Title: Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Message Processing Rules
Type: array
Title: Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-post-request
Type: object
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-post-request
Type: object
Show Source
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : b2bTradingPartners-outboundCollaborationMessages-item-response
Type: object
Show Source
Nested Schema : Domain Value Maps
Type: array
Title: Domain Value Maps
The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : Message Processing Rules
Type: array
Title: Message Processing Rules
The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
Show Source
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the domain value map associated with the trading partner's predefined message definition.
  • Read Only: true
    Maximum Length: 256
    Name of the domain value map defined in the SOA composer.
  • Read Only: true
    Date when the user most recently updated the domain value map associated with the trading partner's predefined message definition.
  • Links
  • Read Only: true
    Value that uniquely identifies the domain value map. It is a primary key that the application generates when it creates a domain value map record. This attribute is required.
  • Read Only: true
    Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
  • Read Only: true
    Name of the collaboration message.
Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-response
Type: object
Show Source
  • Read Only: true
    Date when the user set up the processing rule for the trading partner's collaboration message.
  • Maximum Length: 512
    Value that specifies the default value of the node identified in the XPath.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
  • Read Only: true
    Date when the user most recently updated the processing rule for the trading partner's collaboration message.
  • Links
  • Maximum Length: 2000
    Value that specifies the cross reference path of the external message.
  • Maximum Length: 512
    Name of the message processing rule.
  • Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
  • Maximum Length: 100
    Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.
Back to Top

Examples

This example describes how to create outbound messages.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/b2bTradingPartners/TradingPartnerId/child/outboundCollaborationMessages"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "PartnerMessageName" : "Nameout10_1.2",
    "MessageName" : "OAGIS_10.1_CHANGE_PO_COLLAB_MSG_OUT",
    "DeliveryMethodName" : "891678078DUNS"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "PartnerMessageId" : 300100083098961,
  "PartnerMessageName" : "Nameout10_1.2",
  "PartnerMessageStatus" : "Entered",
  "PartnerMessageStatusDate" : "2015-12-09T19:48:50.536+00:00",
  "ProcessingAction" : "ChangePurchaseOrder",
  "MessageId" : 40022,
  "MessageName" : "OAGIS_10.1_CHANGE_PO_COLLAB_MSG_OUT",
  "ServiceProviderId" : 50055,
  "DocumentId" : 40055,
  "DeliveryMethodId" : 300100073313018,
  "DeliveryMethodName" : "891678078DUNS",
  "PartnerMessageCustomizationId" : 300100083098961,
  "RetentionDuration" : null,
  "RetentionDurationType" : null,
  "OverrideStatus" : "Inactive",
  "OverrideStatusDate" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961",
    "name" : "outboundCollaborationMessages",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000374001353434D5F494D504C5F434F4E53554C54414E5478"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961",
    "name" : "outboundCollaborationMessages",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017",
    "name" : "b2bTradingPartners",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/retentionDurationTypesLOV",
    "name" : "retentionDurationTypesLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/messagesLOV",
    "name" : "messagesLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/deliveryMethodsLOV",
    "name" : "deliveryMethodsLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/overrideStatusLOV",
    "name" : "overrideStatusLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/lov/partnerMessageStatusLOV",
    "name" : "partnerMessageStatusLOV",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/child/messageProcessingRules",
    "name" : "messageProcessingRules",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages/300100083098961/child/domainValueMaps",
    "name" : "domainValueMaps",
    "kind" : "collection"
  } ]
}
Back to Top