Update one delivery method

patch

/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/deliveryMethods/{DeliveryMethodId}

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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Attach Payload
    Maximum Length: 10
    Contains one of the following values: true or false. If true, then the transformed payload is sent along with the email as attachment. If false, then the transformed payload is not sent along with the email as attachment. The default value is false.
  • Value that stores the password in the credential store.
  • Value that stores the username in the credential store.
  • Maximum Length: 10
    Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.
  • Maximum Length: 256
    Value that identifies the file that is being delivered using SFTP.
  • Title: Recipient Email ID
    Maximum Length: 256
    Value that uniquely identifies the email to which the outbound message is sent.
  • Maximum Length: 2000
    Value that identifies the directory where outbound messages are delivered using SFTP.
  • Title: Security Policy
    Maximum Length: 256
    Value that indicates the security policy used with the delivery method.
  • Title: Service Name
    Maximum Length: 256
    Value that identifies the external service of the delivery method.
  • Value that specifies the meaning of the service.
  • Value that specifies the service endpoint stored in topology manager.
  • Value that identifies the host name for outbound message delivery using SFTP.
  • Maximum Length: 255
    Value that identifies the port for outbound message delivery using SFTP.
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-deliveryMethods-item-response
Type: object
Show Source
  • Title: Attach Payload
    Maximum Length: 10
    Contains one of the following values: true or false. If true, then the transformed payload is sent along with the email as attachment. If false, then the transformed payload is not sent along with the email as attachment. The default value is false.
  • Title: B2B Routing Enabled
    Maximum Length: 10
    Default Value: false
    Contains one of the following values: true or false. If true, then the messages to the service provider are routed through the internal B2B gateway. If false, then the messages to the service provider are not routed through the internal B2B gateway. The default value is false.
  • Read Only: true
    Date when the user created the delivery method that the trading partner uses to send outbound messages.
  • Value that stores the password in the credential store.
  • Value that stores the username in the credential store.
  • Value that uniquely identifies the delivery method. It is a primary key that the application generates when it creates a delivery method record. This attribute is required.
  • Title: Name
    Maximum Length: 256
    Name of the delivery method. This attribute is required.
  • Maximum Length: 100
    Value that identifies the type of delivery method. Valid values include One-Way Web Service or Request-Response Web Service.
  • Maximum Length: 10
    Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.
  • Maximum Length: 256
    Value that identifies the file that is being delivered using SFTP.
  • Read Only: true
    Date when the user most recently updated the delivery method that the trading partner uses to send outbound messages.
  • Links
  • Title: Recipient Email ID
    Maximum Length: 256
    Value that uniquely identifies the email to which the outbound message is sent.
  • Maximum Length: 2000
    Value that identifies the directory where outbound messages are delivered using SFTP.
  • Title: Security Policy
    Maximum Length: 256
    Value that indicates the security policy used with the delivery method.
  • Title: Service Name
    Maximum Length: 256
    Value that identifies the external service of the delivery method.
  • Value that specifies the meaning of the service.
  • Value that specifies the service endpoint stored in topology manager.
  • Value that identifies the host name for outbound message delivery using SFTP.
  • Maximum Length: 255
    Value that identifies the port for outbound message delivery using SFTP.
  • Title: Repository Account
    Maximum Length: 1024
    Value that specifies the location from where files are picked for outbound process.
Back to Top

Examples

This example describes how to update one delivery method.

Example cURL Command

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

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

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 updates.

{
    "AttachXmlFlag" : false
}

Example Response Body

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

{
  "DeliveryMethodId" : 300100177412680,
  "DeliveryMethodName" : "JKNewDeliveryMethod",
  "DeliveryMethodType" : "ORA_WebService",
  "Service" : "CollabMsgProcess",
  "B2bRoutingFlag" : false,
  "SecurityPolicy" : "NONE",
  "UcmExportDocumentAccount" : null,
  "RecipientEmailId" : null,
  "AttachXmlFlag" : false,
  "ServiceUri" : "http://abc.com/",
  "CsfkeyUser" : "SCM_IMPL_CONSU",
  "CsfkeyPassword" : "********",
  "ServiceMeaning" : "CollaborationMessage.Process",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/deliveryMethods/300100177412680",
    "name" : "deliveryMethods",
    "kind" : "item"
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/deliveryMethods/300100177412680",
    "name" : "deliveryMethods",
    "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/deliveryMethods/300100177412680/lov/securityPolicyLOV",
    "name" : "securityPolicyLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/deliveryMethods/300100177412680/lov/deliveryMethodTypesLOV",
    "name" : "deliveryMethodTypesLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/deliveryMethods/300100177412680/lov/servicesLOV",
    "name" : "servicesLOV",
    "kind" : "collection"
  } ]
}
Back to Top