Jump to

• Request
• Response

PATCH action not supported

patch

/fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}

Request

Path Parameters

• ServiceProviderId(required): integer(int64)
  Value that uniquely identifies the service provider. It is a primary key that the application generates when it creates a service provider 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

• deliveryMethods: array Delivery Methods
  Title: Delivery Methods

  The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.
• DelStatusUpdateEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the service provider provides message delivery status updates. If false, then the service provider doesn't provide message delivery status updates. The default value is false.
• documents: array Trading Partner Documents
  Title: Trading Partner Documents

  The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.
• inboundCollaborationMessages: array Inbound Collaboration Messages
  Title: Inbound Collaboration Messages

  The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.
• MsgExchangeStandard: string
  Maximum Length: 100

  Value that indicates the messaging standard used by the service provider.
• outboundCollaborationMessages: array Outbound Collaboration Messages
  Title: Outbound Collaboration Messages

  The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.
• ServiceProviderId: integer (int64)
  Value that uniquely identifies the service provider. It is a primary key that the application generates when it creates a service provider record. This attribute is required.
• UserDefined: string
  Maximum Length: 1

  Default Value: Y

  Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.

{
    "type":"object",
    "properties":{
        "MsgExchangeStandard":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the messaging standard used by the service provider.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "documents":{
            "title":"Trading Partner Documents",
            "type":"array",
            "description":"The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-documents-item-patch-request"
            }
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service provider. It is a primary key that the application generates when it creates a service provider record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DelStatusUpdateEnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the service provider provides message delivery status updates. If false, then the service provider doesn't provide message delivery status updates. The default value is false.",
            "nullable":true
        },
        "outboundCollaborationMessages":{
            "title":"Outbound Collaboration Messages",
            "type":"array",
            "description":"The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-outboundCollaborationMessages-item-patch-request"
            }
        },
        "UserDefined":{
            "maxLength":"1",
            "type":"string",
            "description":"Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.",
            "nullable":true,
            "default":"Y"
        },
        "deliveryMethods":{
            "title":"Delivery Methods",
            "type":"array",
            "description":"The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-deliveryMethods-item-patch-request"
            }
        },
        "inboundCollaborationMessages":{
            "title":"Inbound Collaboration Messages",
            "type":"array",
            "description":"The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-item-patch-request"
            }
        }
    }
}

Nested Schema : Delivery Methods

Type: array

Title: Delivery Methods

The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.

Show Source

• Array of: object b2bServiceProviders-deliveryMethods-item-patch-request

{
    "title":"Delivery Methods",
    "type":"array",
    "description":"The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-deliveryMethods-item-patch-request"
    }
}

Nested Schema : Trading Partner Documents

Type: array

Title: Trading Partner Documents

The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.

Show Source

• Array of: object b2bServiceProviders-documents-item-patch-request

{
    "title":"Trading Partner Documents",
    "type":"array",
    "description":"The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-documents-item-patch-request"
    }
}

Nested Schema : Inbound Collaboration Messages

Type: array

Title: Inbound Collaboration Messages

The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.

Show Source

• Array of: object b2bServiceProviders-inboundCollaborationMessages-item-patch-request

{
    "title":"Inbound Collaboration Messages",
    "type":"array",
    "description":"The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-item-patch-request"
    }
}

Nested Schema : Outbound Collaboration Messages

Type: array

Title: Outbound Collaboration Messages

The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.

Show Source

• Array of: object b2bServiceProviders-outboundCollaborationMessages-item-patch-request

{
    "title":"Outbound Collaboration Messages",
    "type":"array",
    "description":"The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-outboundCollaborationMessages-item-patch-request"
    }
}

Nested Schema : b2bServiceProviders-deliveryMethods-item-patch-request

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 indicates the encrypted password in the credential store.
• CsfkeyUser: string
  Value that indicates 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 the 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 indicates 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 the 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 indicates the encrypted 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
        }
    }
}

Nested Schema : b2bServiceProviders-documents-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : b2bServiceProviders-inboundCollaborationMessages-item-patch-request

Type: object

Show Source

• AcknowledgementCode: string
  Maximum Length: 100

  Default Value: Never

  Value that indicates whether the application processing feedback is sent for inbound messages or not.
• ApplicationPartnerCodeXpath: string
  Maximum Length: 2000

  Value that stores the application partner code cross reference path.
• domainValueMaps: array Domain Value Maps
  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.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the inbound collaboration message for the service provider.
• MessageId: integer (int64)
  Title: Collaboration Message Definition

  Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
• MessageName: string
  Name of the collaboration message.
• ObjectKey1Xpath: string
  Maximum Length: 2000

  Value that identifies the first key of the XPath in the input payload.
• ObjectKey2Xpath: string
  Maximum Length: 2000

  Value that identifies the second key of the XPath in the input payload.
• ObjectKey3Xpath: string
  Maximum Length: 2000

  Value that identifies the third key of the XPath in the input payload.
• ObjectKey4Xpath: string
  Maximum Length: 2000

  Value that identifies the fourth key of the XPath in the input payload.
• ObjectKey5Xpath: string
  Maximum Length: 2000

  Value that identifies the fifth key of the XPath in the input payload.
• ObjectKey6Xpath: string
  Maximum Length: 2000

  Value that identifies the sixth key of the XPath in the input payload.
• OverrideStatus: string
  Maximum Length: 100

  Value that indicates the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.
• OverrideStatusDate: string (date-time)
  Date when the inbound collaboration message was overridden.
• PartnerMessageStatus: string
  Maximum Length: 100

  Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive.
• PartnerMessageStatusDate: string (date-time)
  Date when the inbound collaboration message was created or updated.
• ProcessingAction: string
  Maximum Length: 256

  Value that defines the action of the inbound message.
• RetentionDuration: integer (int32)
  Title: Retention Duration

  Value that indicates the retention duration of the inbound collaboration message.
• RetentionDurationType: string
  Title: Retention Duration Unit

  Maximum Length: 100

  Value that indicates the retention duration type of the inbound collaboration message.

{
    "type":"object",
    "properties":{
        "ObjectKey4Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the fourth key of the XPath in the input payload.",
            "nullable":true
        },
        "domainValueMaps":{
            "title":"Domain Value Maps",
            "type":"array",
            "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request"
            }
        },
        "AcknowledgementCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates whether the application processing feedback is sent for inbound messages or not.",
            "nullable":true,
            "default":"Never"
        },
        "ObjectKey1Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the first key of the XPath in the input payload.",
            "nullable":true
        },
        "PartnerMessageStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":true
        },
        "OverrideStatusDate":{
            "type":"string",
            "description":"Date when the inbound collaboration message was overridden.",
            "format":"date-time",
            "nullable":true
        },
        "ObjectKey2Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the second key of the XPath in the input payload.",
            "nullable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "description":"Value that indicates the retention duration of the inbound collaboration message.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            }
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":false
        },
        "ProcessingAction":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that defines the action of the inbound message.",
            "nullable":true
        },
        "ObjectKey6Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the sixth key of the XPath in the input payload.",
            "nullable":true
        },
        "ApplicationPartnerCodeXpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that stores the application partner code cross reference path.",
            "nullable":true
        },
        "ObjectKey5Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the fifth key of the XPath in the input payload.",
            "nullable":true
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the retention duration type of the inbound collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "description":"Date when the inbound collaboration message was created or updated.",
            "format":"date-time",
            "nullable":true
        },
        "ObjectKey3Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the third key of the XPath in the input payload.",
            "nullable":true
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the inbound collaboration message for the service provider.",
            "format":"date-time",
            "nullable":false
        }
    }
}

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

• Array of: object b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request

{
    "title":"Domain Value Maps",
    "type":"array",
    "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request"
    }
}

Nested Schema : b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : b2bServiceProviders-outboundCollaborationMessages-item-patch-request

Type: object

Show Source

• AlternateDeliveryMethodId: integer (int64)
  Value that uniquely identifies the alternate delivery method. It is a primary key that the application generates when it creates a delivery method record.
• AlternateDeliveryMethodName: string
  Name of the alternate delivery method.
• AttachmentProcessingMethod: string
  Maximum Length: 64

  Value that indicates how the message attachments are sent to trading partners. Valid values include In message, In payload, and MIME part.
• DeliveryMethodId: integer (int64)
  Value that uniquely identifies the delivery method for the outbound collaboration message. This attribute is a foreign key reference to the delivery method for the outbound collaboration message.
• DeliveryMethodName: string
  Name of the delivery method for the outbound collaboration message.
• domainValueMaps: array Domain Value Maps
  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.
• MessageId: integer (int64)
  Title: Collaboration Message Definition

  Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
• MessageName: string
  Name of the collaboration message.
• OverrideStatus: string
  Maximum Length: 100

  Value that indicates the override status of the outbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.
• OverrideStatusDate: string (date-time)
  Date when the status of the inbound collaboration message was overridden.
• PartnerMessageStatus: string
  Maximum Length: 100

  Value that indicates the status of the outbound collaboration message.
• PartnerMessageStatusDate: string (date-time)
  Date when the outbound collaboration message status is set.
• ProcessingAction: string
  Maximum Length: 256

  Value that indicates the action of the outbound message.
• RetentionDuration: integer (int32)
  Title: Retention Duration

  Value that indicates the retention duration of the outbound collaboration message.
• RetentionDurationType: string
  Title: Retention Duration Unit

  Maximum Length: 100

  Value that indicates the retention duration type of the outbound collaboration message.

{
    "type":"object",
    "properties":{
        "AlternateDeliveryMethodName":{
            "type":"string",
            "description":"Name of the alternate delivery method.",
            "nullable":true,
            "x-queryable":false
        },
        "DeliveryMethodName":{
            "type":"string",
            "description":"Name of the delivery method for the outbound collaboration message.",
            "nullable":true,
            "x-queryable":false
        },
        "domainValueMaps":{
            "title":"Domain Value Maps",
            "type":"array",
            "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-patch-request"
            }
        },
        "DeliveryMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delivery method for the outbound collaboration message. This attribute is a foreign key reference to the delivery method for the outbound collaboration message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "PartnerMessageStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the status of the outbound collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideStatusDate":{
            "type":"string",
            "description":"Date when the status of the inbound collaboration message was overridden.",
            "format":"date-time",
            "nullable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "description":"Value that indicates the retention duration of the outbound collaboration message.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            }
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":false
        },
        "ProcessingAction":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that indicates the action of the outbound message.",
            "nullable":true
        },
        "AttachmentProcessingMethod":{
            "maxLength":"64",
            "type":"string",
            "description":"Value that indicates how the message attachments are sent to trading partners. Valid values include In message, In payload, and MIME part.",
            "nullable":true
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the retention duration type of the outbound collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the override status of the outbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "description":"Date when the outbound collaboration message status is set.",
            "format":"date-time",
            "nullable":true
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "AlternateDeliveryMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate delivery method. It is a primary key that the application generates when it creates a delivery method record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "DeliveryMethodId"
                ]
            }
        }
    }
}

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

• Array of: object b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-patch-request

{
    "title":"Domain Value Maps",
    "type":"array",
    "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-patch-request"
    }
}

Nested Schema : b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : b2bServiceProviders-item-response

Type: object

Show Source

• AttchProcessMthd: string
  Read Only: true

  Maximum Length: 100

  Value that indicates how the service provider can send message attachments to trading partners. Valid values include In message, In payload, and MIME part.
• ConnectionType: string
  Read Only: true

  Maximum Length: 100

  Value that indicates the type of outbound delivery connection that is configured for the service provider, i.e., Test or Production. This value is not editable.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the service provider.
• deliveryMethods: array Delivery Methods
  Title: Delivery Methods

  The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.
• DelStatusUpdateEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the service provider provides message delivery status updates. If false, then the service provider doesn't provide message delivery status updates. The default value is false.
• Description: string
  Maximum Length: 256

  Description of the service provider.
• documents: array Trading Partner Documents
  Title: Trading Partner Documents

  The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.
• inboundCollaborationMessages: array Inbound Collaboration Messages
  Title: Inbound Collaboration Messages

  The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the service provider.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MsgExchangeStandard: string
  Maximum Length: 100

  Value that indicates the messaging standard used by the service provider.
• ObnId: string
  Read Only: true

  Maximum Length: 100

  Value that uniquely identifies the Oracle Business Network Account identifier of the service provider.
• outboundCollaborationMessages: array Outbound Collaboration Messages
  Title: Outbound Collaboration Messages

  The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.
• PartnerId: string
  Title: Provider ID

  Maximum Length: 100

  Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner for a service provider.
• PartnerIdType: string
  Maximum Length: 100

  Value that uniquely identifies the type of trading partner.
• ServiceProviderId: integer (int64)
  Value that uniquely identifies the service provider. It is a primary key that the application generates when it creates a service provider record. This attribute is required.
• ServiceProviderName: string
  Maximum Length: 256

  Name of the service provider.
• UserDefined: string
  Maximum Length: 1

  Default Value: Y

  Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the service provider.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProviderName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name of the service provider.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"256",
            "type":"string",
            "description":"Description of the service provider.",
            "nullable":true,
            "x-queryable":true
        },
        "MsgExchangeStandard":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the messaging standard used by the service provider.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConnectionType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the type of outbound delivery connection that is configured for the service provider, i.e., Test or Production. This value is not editable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "documents":{
            "title":"Trading Partner Documents",
            "type":"array",
            "description":"The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-documents-item-response"
            }
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service provider. It is a primary key that the application generates when it creates a service provider record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AttchProcessMthd":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates how the service provider can send message attachments to trading partners. Valid values include In message, In payload, and MIME part.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Provider ID",
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the trading partner. This attribute is a foreign key reference to the trading partner for a service provider.",
            "nullable":false,
            "x-queryable":true
        },
        "DelStatusUpdateEnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the service provider provides message delivery status updates. If false, then the service provider doesn't provide message delivery status updates. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "outboundCollaborationMessages":{
            "title":"Outbound Collaboration Messages",
            "type":"array",
            "description":"The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-outboundCollaborationMessages-item-response"
            }
        },
        "deliveryMethods":{
            "title":"Delivery Methods",
            "type":"array",
            "description":"The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-deliveryMethods-item-response"
            }
        },
        "inboundCollaborationMessages":{
            "title":"Inbound Collaboration Messages",
            "type":"array",
            "description":"The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-item-response"
            }
        },
        "ObnId":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the Oracle Business Network Account identifier of the service provider.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UserDefined":{
            "maxLength":"1",
            "type":"string",
            "description":"Value that identifies service provider type. The value is Y when the service provider is user-defined and N otherwise.",
            "nullable":true,
            "default":"Y",
            "x-queryable":true
        },
        "PartnerIdType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that uniquely identifies the type of trading partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the service provider.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Delivery Methods

Type: array

Title: Delivery Methods

The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.

Show Source

• Array of: object b2bServiceProviders-deliveryMethods-item-response

{
    "title":"Delivery Methods",
    "type":"array",
    "description":"The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-deliveryMethods-item-response"
    }
}

Nested Schema : Trading Partner Documents

Type: array

Title: Trading Partner Documents

The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.

Show Source

• Array of: object b2bServiceProviders-documents-item-response

{
    "title":"Trading Partner Documents",
    "type":"array",
    "description":"The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-documents-item-response"
    }
}

Nested Schema : Inbound Collaboration Messages

Type: array

Title: Inbound Collaboration Messages

The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.

Show Source

• Array of: object b2bServiceProviders-inboundCollaborationMessages-item-response

{
    "title":"Inbound Collaboration Messages",
    "type":"array",
    "description":"The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-item-response"
    }
}

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 : Outbound Collaboration Messages

Type: array

Title: Outbound Collaboration Messages

The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.

Show Source

• Array of: object b2bServiceProviders-outboundCollaborationMessages-item-response

{
    "title":"Outbound Collaboration Messages",
    "type":"array",
    "description":"The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-outboundCollaborationMessages-item-response"
    }
}

Nested Schema : b2bServiceProviders-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 service provider uses to send outbound messages.
• CsfkeyPassword: string
  Value that indicates the encrypted password in the credential store.
• CsfkeyUser: string
  Value that indicates 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 service provider 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 the 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 indicates 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 service provider 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 the 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 indicates the encrypted 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 service provider 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."
        }
    }
}

Nested Schema : b2bServiceProviders-documents-item-response

Type: object

Show Source

• CollaborationObject: string
  Read Only: true

  Maximum Length: 256

  Value that identifies the collaboration object. A list of accepted values is defined in the lookup type Collaboration Object.
• Direction: string
  Read Only: true

  Maximum Length: 100

  Value that indicates if the collaboration document operation is for an outbound or an inbound collaboration.
• DocumentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
• DocumentName: string
  Read Only: true

  Maximum Length: 256

  Name of the trading partner document.
• DocumentType: string
  Read Only: true

  Maximum Length: 256

  Value that identifies the type of collaboration document such as, Process Purchase Order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SenderRole: string
  Read Only: true

  Maximum Length: 100

  Value that indicates the role of the sender in the collaboration such as Customer.

{
    "type":"object",
    "properties":{
        "CollaborationObject":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that identifies the collaboration object. A list of accepted values is defined in the lookup type Collaboration Object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that identifies the type of collaboration document such as, Process Purchase Order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Direction":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates if the collaboration document operation is for an outbound or an inbound collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderRole":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the role of the sender in the collaboration such as Customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name of the trading partner document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : b2bServiceProviders-inboundCollaborationMessages-item-response

Type: object

Show Source

• AcknowledgementCode: string
  Maximum Length: 100

  Default Value: Never

  Value that indicates whether the application processing feedback is sent for inbound messages or not.
• ApplicationPartnerCodeXpath: string
  Maximum Length: 2000

  Value that stores the application partner code cross reference path.
• CreationDate: string (date-time)
  Date when the user set up the inbound collaboration message for the service provider.
• DocumentId: integer (int64)
  Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
• DocumentName: string
  Read Only: true

  Maximum Length: 256

  Name of the document associated with the inbound collaboration message.
• domainValueMaps: array Domain Value Maps
  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.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the inbound collaboration message for the service provider.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageId: integer (int64)
  Title: Collaboration Message Definition

  Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
• MessageName: string
  Name of the collaboration message.
• ObjectKey1Xpath: string
  Maximum Length: 2000

  Value that identifies the first key of the XPath in the input payload.
• ObjectKey2Xpath: string
  Maximum Length: 2000

  Value that identifies the second key of the XPath in the input payload.
• ObjectKey3Xpath: string
  Maximum Length: 2000

  Value that identifies the third key of the XPath in the input payload.
• ObjectKey4Xpath: string
  Maximum Length: 2000

  Value that identifies the fourth key of the XPath in the input payload.
• ObjectKey5Xpath: string
  Maximum Length: 2000

  Value that identifies the fifth key of the XPath in the input payload.
• ObjectKey6Xpath: string
  Maximum Length: 2000

  Value that identifies the sixth key of the XPath in the input payload.
• OverrideStatus: string
  Maximum Length: 100

  Value that indicates the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.
• OverrideStatusDate: string (date-time)
  Date when the inbound collaboration message was overridden.
• PartnerMessageCustomizationId: integer (int64)
  Values that uniquely identifies the partner message customization. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required. This is a read-only attribute.
• PartnerMessageId: integer (int64)
  Value that uniquely identifies the trading partner message. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required.
• PartnerMessageName: string
  Title: Name

  Maximum Length: 256

  Name of the inbound collaboration message.
• PartnerMessageStatus: string
  Maximum Length: 100

  Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive.
• PartnerMessageStatusDate: string (date-time)
  Date when the inbound collaboration message was created or updated.
• ProcessingAction: string
  Maximum Length: 256

  Value that defines the action of the inbound message.
• RetentionDuration: integer (int32)
  Title: Retention Duration

  Value that indicates the retention duration of the inbound collaboration message.
• RetentionDurationType: string
  Title: Retention Duration Unit

  Maximum Length: 100

  Value that indicates the retention duration type of the inbound collaboration message.
• UserDefinedFlag: boolean
  Read Only: true

  Value that indicates whether the inbound collaboration message is user defined. This value is not editable.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user set up the inbound collaboration message for the service provider.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerMessageCustomizationId":{
            "type":"integer",
            "description":"Values that uniquely identifies the partner message customization. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required. This is a read-only attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerMessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner message. It is a primary key that the application generates when it creates a inbound collaboration message record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerMessageStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that specifies the status of the trading partner message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideStatusDate":{
            "type":"string",
            "description":"Date when the inbound collaboration message was overridden.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey2Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the second key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectKey6Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the sixth key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the retention duration type of the inbound collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name of the document associated with the inbound collaboration message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectKey3Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the third key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerMessageName":{
            "title":"Name",
            "maxLength":"256",
            "type":"string",
            "description":"Name of the inbound collaboration message.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectKey4Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the fourth key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "type":"boolean",
            "description":"Value that indicates whether the inbound collaboration message is user defined. This value is not editable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "domainValueMaps":{
            "title":"Domain Value Maps",
            "type":"array",
            "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response"
            }
        },
        "AcknowledgementCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates whether the application processing feedback is sent for inbound messages or not.",
            "nullable":true,
            "default":"Never",
            "x-queryable":true
        },
        "ObjectKey1Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the first key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "description":"Value that indicates the retention duration of the inbound collaboration message.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ProcessingAction":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that defines the action of the inbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationPartnerCodeXpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that stores the application partner code cross reference path.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey5Xpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the fifth key of the XPath in the input payload.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the override status of the inbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "description":"Date when the inbound collaboration message was created or updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the inbound collaboration message for the service provider.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response

{
    "title":"Domain Value Maps",
    "type":"array",
    "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response"
    }
}

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 : b2bServiceProviders-inboundCollaborationMessages-domainValueMaps-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true

  Date when the user set up the domain value map associated with the service provider's predefined message definition.
• DvmName: string
  Read Only: true

  Maximum Length: 256

  Name of the domain value map.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the domain value map associated with the service provider's predefined message definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageDvmId: integer (int64)
  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.
• MessageId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
• MessageName: string
  Read Only: true

  Name of the collaboration message.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user set up the domain value map associated with the service provider's predefined message definition.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDvmId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DvmName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name of the domain value map.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the domain value map associated with the service provider's predefined message definition.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : b2bServiceProviders-outboundCollaborationMessages-item-response

Type: object

Show Source

• AlternateDeliveryMethodId: integer (int64)
  Value that uniquely identifies the alternate delivery method. It is a primary key that the application generates when it creates a delivery method record.
• AlternateDeliveryMethodName: string
  Name of the alternate delivery method.
• AttachmentProcessingMethod: string
  Maximum Length: 64

  Value that indicates how the message attachments are sent to trading partners. Valid values include In message, In payload, and MIME part.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user set up the inbound collaboration message for the service provider.
• DeliveryMethodId: integer (int64)
  Value that uniquely identifies the delivery method for the outbound collaboration message. This attribute is a foreign key reference to the delivery method for the outbound collaboration message.
• DeliveryMethodName: string
  Name of the delivery method for the outbound collaboration message.
• DocumentId: integer (int64)
  Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
• DocumentName: string
  Read Only: true

  Maximum Length: 256

  Name of the document associated with the outbound collaboration message.
• domainValueMaps: array Domain Value Maps
  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.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the inbound collaboration message for the service.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageId: integer (int64)
  Title: Collaboration Message Definition

  Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
• MessageName: string
  Name of the collaboration message.
• OverrideStatus: string
  Maximum Length: 100

  Value that indicates the override status of the outbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.
• OverrideStatusDate: string (date-time)
  Date when the status of the inbound collaboration message was overridden.
• PartnerMessageCustomizationId: integer (int64)
  Value that uniquely identifies the trading partner message customization. This attribute is a foreign key reference to the trading partner message customization.
• PartnerMessageId: integer (int64)
  Value that uniquely identifies the trading partner message. This attribute is a foreign key reference to the trading partner message.
• PartnerMessageName: string
  Title: Name

  Maximum Length: 256

  Name of the outbound collaboration message.
• PartnerMessageStatus: string
  Maximum Length: 100

  Value that indicates the status of the outbound collaboration message.
• PartnerMessageStatusDate: string (date-time)
  Date when the outbound collaboration message status is set.
• ProcessingAction: string
  Maximum Length: 256

  Value that indicates the action of the outbound message.
• RetentionDuration: integer (int32)
  Title: Retention Duration

  Value that indicates the retention duration of the outbound collaboration message.
• RetentionDurationType: string
  Title: Retention Duration Unit

  Maximum Length: 100

  Value that indicates the retention duration type of the outbound collaboration message.
• ServiceProviderId: integer (int64)
  Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.
• UserDefinedFlag: boolean
  Read Only: true

  Value that indicates whether the outbound collaboration message is user defined. This value is not editable.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user set up the inbound collaboration message for the service provider.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerMessageCustomizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner message customization. This attribute is a foreign key reference to the trading partner message customization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerMessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner message. This attribute is a foreign key reference to the trading partner message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerMessageStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the status of the outbound collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverrideStatusDate":{
            "type":"string",
            "description":"Date when the status of the inbound collaboration message was overridden.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":false,
            "x-queryable":true
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the retention duration type of the outbound collaboration message.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name of the document associated with the outbound collaboration message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateDeliveryMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate delivery method. It is a primary key that the application generates when it creates a delivery method record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "DeliveryMethodId"
                ]
            },
            "x-queryable":true
        },
        "PartnerMessageName":{
            "title":"Name",
            "maxLength":"256",
            "type":"string",
            "description":"Name of the outbound collaboration message.",
            "nullable":false,
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "type":"boolean",
            "description":"Value that indicates whether the outbound collaboration message is user defined. This value is not editable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateDeliveryMethodName":{
            "type":"string",
            "description":"Name of the alternate delivery method.",
            "nullable":true,
            "x-queryable":false
        },
        "DeliveryMethodName":{
            "type":"string",
            "description":"Name of the delivery method for the outbound collaboration message.",
            "nullable":true,
            "x-queryable":false
        },
        "domainValueMaps":{
            "title":"Domain Value Maps",
            "type":"array",
            "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
            "items":{
                "$ref":"#/components/schemas/b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-response"
            }
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service provider. This attribute is a foreign key reference to the service provider.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeliveryMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the delivery method for the outbound collaboration message. This attribute is a foreign key reference to the delivery method for the outbound collaboration message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "description":"Value that indicates the retention duration of the outbound collaboration message.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ProcessingAction":{
            "maxLength":"256",
            "type":"string",
            "description":"Value that indicates the action of the outbound message.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentProcessingMethod":{
            "maxLength":"64",
            "type":"string",
            "description":"Value that indicates how the message attachments are sent to trading partners. Valid values include In message, In payload, and MIME part.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates the override status of the outbound collaboration message. Values include Inactive, Active, or Loopback. The default value is Inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the inbound collaboration message for the service.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "description":"Date when the outbound collaboration message status is set.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-response

{
    "title":"Domain Value Maps",
    "type":"array",
    "description":"The Domain Value Maps resource gets all the mappings associated with the trading partner that are implemented while processing a message.",
    "items":{
        "$ref":"#/components/schemas/b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-response"
    }
}

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 : b2bServiceProviders-outboundCollaborationMessages-domainValueMaps-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true

  Date when the user set up the domain value map associated with the service provider's predefined message definition.
• DvmName: string
  Read Only: true

  Maximum Length: 256

  Name of the domain value map.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the domain value map associated with the service provider's predefined message definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageDvmId: integer (int64)
  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.
• MessageId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.
• MessageName: string
  Read Only: true

  Name of the collaboration message.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user set up the domain value map associated with the service provider's predefined message definition.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDvmId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DvmName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name of the domain value map.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "description":"Name of the collaboration message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message. This attribute is a foreign key reference to the collaboration message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the domain value map associated with the service provider's predefined message definition.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

deliveryMethods

Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/deliveryMethods

Parameters:

• ServiceProviderId: $request.path.ServiceProviderId

The Delivery Methods resource gets the details of mode of communication between Oracle Collaboration Messaging Framework Cloud and trading partners.

documents

Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/documents

Parameters:

• ServiceProviderId: $request.path.ServiceProviderId

The Trading Partner Documents resource gets all the documents associated with the trading partner that are exchanged for business-to-business message processing.

inboundCollaborationMessages

Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/inboundCollaborationMessages

Parameters:

• ServiceProviderId: $request.path.ServiceProviderId

The Inbound Collaboration Messages resource gets the details of all the inbound messages that a trading partner sends to Oracle Collaboration Messaging Framework Cloud.

outboundCollaborationMessages

Operation: /fscmRestApi/resources/11.13.18.05/b2bServiceProviders/{ServiceProviderId}/child/outboundCollaborationMessages

Parameters:

• ServiceProviderId: $request.path.ServiceProviderId

The Outbound Collaboration Messages resource gets the details of all the outbound messages that a trading partner receives from Oracle Collaboration Messaging Framework Cloud.

Back to Top