Jump to

• Request
• Response
• Examples

Update one delivery method

patch

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

Request

Path Parameters

• DeliveryMethodId(required): integer(int64)
  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.
• TradingPartnerId(required): integer(int64)
  Value that uniquely identifies the trading partner. It is a primary key that the application generates when it creates a trading partner record. This attribute is required.

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttachXmlFlag: boolean
  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.
• CsfkeyPassword: string
  Value that stores the password in the credential store.
• CsfkeyUser: string
  Value that stores the username in the credential store.
• FileExtension: string
  Maximum Length: 10

  Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.
• FileName: string
  Maximum Length: 256

  Value that identifies the file that is being delivered using SFTP.
• RecipientEmailId: string
  Title: Recipient Email ID

  Maximum Length: 256

  Value that uniquely identifies the email to which the outbound message is sent.
• RemoteDir: string
  Maximum Length: 2000

  Value that identifies the directory where outbound messages are delivered using SFTP.
• SecurityPolicy: string
  Title: Security Policy

  Maximum Length: 256

  Value that indicates the security policy used with the delivery method.
• Service: string
  Title: Service Name

  Maximum Length: 256

  Value that identifies the external service of the delivery method.
• ServiceMeaning: string
  Value that specifies the meaning of the service.
• ServiceUri: string
  Value that specifies the service endpoint stored in topology manager.
• SftpHost: string
  Value that identifies the host name for outbound message delivery using SFTP.
• SftpPort: string
  Maximum Length: 255

  Value that identifies the port for outbound message delivery using SFTP.

{
    "type":"object",
    "properties":{
        "CsfkeyUser":{
            "type":"string",
            "description":"Value that stores the username in the credential store.",
            "nullable":true,
            "x-queryable":false
        },
        "RemoteDir":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that identifies the directory where outbound messages are delivered using SFTP.",
            "nullable":true
        },
        "FileName":{
            "maxLength":256,
            "type":"string",
            "description":"Value that identifies the file that is being delivered using SFTP.",
            "nullable":true
        },
        "Service":{
            "title":"Service Name",
            "maxLength":256,
            "type":"string",
            "description":"Value that identifies the external service of the delivery method.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SftpHost":{
            "type":"string",
            "description":"Value that identifies the host name for outbound message delivery using SFTP.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RecipientEmailId":{
            "title":"Recipient Email ID",
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the email to which the outbound message is sent.",
            "nullable":true
        },
        "SftpPort":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the port for outbound message delivery using SFTP.",
            "nullable":true
        },
        "ServiceUri":{
            "type":"string",
            "description":"Value that specifies the service endpoint stored in topology manager.",
            "nullable":true,
            "x-queryable":false
        },
        "SecurityPolicy":{
            "title":"Security Policy",
            "maxLength":256,
            "type":"string",
            "description":"Value that indicates the security policy used with the delivery method.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FileExtension":{
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.",
            "nullable":true
        },
        "CsfkeyPassword":{
            "type":"string",
            "description":"Value that stores the password in the credential store.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceMeaning":{
            "type":"string",
            "description":"Value that specifies the meaning of the service.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachXmlFlag":{
            "title":"Attach Payload",
            "maxLength":10,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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".
• REST-Framework-Version(required):
  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

• AttachXmlFlag: boolean
  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.
• B2bRoutingFlag: boolean
  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.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the delivery method that the trading partner uses to send outbound messages.
• CsfkeyPassword: string
  Value that stores the password in the credential store.
• CsfkeyUser: string
  Value that stores the username in the credential store.
• DeliveryMethodId: integer (int64)
  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.
• DeliveryMethodName: string
  Title: Name

  Maximum Length: 256

  Name of the delivery method. This attribute is required.
• DeliveryMethodType: string
  Maximum Length: 100

  Value that identifies the type of delivery method. Valid values include One-Way Web Service or Request-Response Web Service.
• FileExtension: string
  Maximum Length: 10

  Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.
• FileName: string
  Maximum Length: 256

  Value that identifies the file that is being delivered using SFTP.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the delivery method that the trading partner uses to send outbound messages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecipientEmailId: string
  Title: Recipient Email ID

  Maximum Length: 256

  Value that uniquely identifies the email to which the outbound message is sent.
• RemoteDir: string
  Maximum Length: 2000

  Value that identifies the directory where outbound messages are delivered using SFTP.
• SecurityPolicy: string
  Title: Security Policy

  Maximum Length: 256

  Value that indicates the security policy used with the delivery method.
• Service: string
  Title: Service Name

  Maximum Length: 256

  Value that identifies the external service of the delivery method.
• ServiceMeaning: string
  Value that specifies the meaning of the service.
• ServiceUri: string
  Value that specifies the service endpoint stored in topology manager.
• SftpHost: string
  Value that identifies the host name for outbound message delivery using SFTP.
• SftpPort: string
  Maximum Length: 255

  Value that identifies the port for outbound message delivery using SFTP.
• UcmExportDocumentAccount: string
  Title: Repository Account

  Maximum Length: 1024

  Value that specifies the location from where files are picked for outbound process.

{
    "type":"object",
    "properties":{
        "CsfkeyUser":{
            "type":"string",
            "description":"Value that stores the username in the credential store.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the delivery method that the trading partner uses to send outbound messages.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RemoteDir":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that identifies the directory where outbound messages are delivered using SFTP.",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveryMethodName":{
            "title":"Name",
            "maxLength":256,
            "type":"string",
            "description":"Name of the delivery method. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "DeliveryMethodId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FileName":{
            "maxLength":256,
            "type":"string",
            "description":"Value that identifies the file that is being delivered using SFTP.",
            "nullable":true,
            "x-queryable":true
        },
        "DeliveryMethodType":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the type of delivery method. Valid values include One-Way Web Service or Request-Response Web Service.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Service":{
            "title":"Service Name",
            "maxLength":256,
            "type":"string",
            "description":"Value that identifies the external service of the delivery method.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SftpHost":{
            "type":"string",
            "description":"Value that identifies the host name for outbound message delivery using SFTP.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RecipientEmailId":{
            "title":"Recipient Email ID",
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the email to which the outbound message is sent.",
            "nullable":true,
            "x-queryable":true
        },
        "SftpPort":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the port for outbound message delivery using SFTP.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceUri":{
            "type":"string",
            "description":"Value that specifies the service endpoint stored in topology manager.",
            "nullable":true,
            "x-queryable":false
        },
        "SecurityPolicy":{
            "title":"Security Policy",
            "maxLength":256,
            "type":"string",
            "description":"Value that indicates the security policy used with the delivery method.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FileExtension":{
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies the extension of the B2B message file. If no value is provided, then .ZIP is used.",
            "nullable":true,
            "x-queryable":true
        },
        "UcmExportDocumentAccount":{
            "title":"Repository Account",
            "maxLength":1024,
            "type":"string",
            "description":"Value that specifies the location from where files are picked for outbound process.",
            "nullable":true,
            "x-queryable":true
        },
        "CsfkeyPassword":{
            "type":"string",
            "description":"Value that stores the password in the credential store.",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceMeaning":{
            "type":"string",
            "description":"Value that specifies the meaning of the service.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the delivery method that the trading partner uses to send outbound messages.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "B2bRoutingFlag":{
            "title":"B2B Routing Enabled",
            "maxLength":10,
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "AttachXmlFlag":{
            "title":"Attach Payload",
            "maxLength":10,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

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