Jump to

• Request
• Response
• Examples

Update

patch

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

Request

Path Parameters

• TradingPartnerId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

• b2bServiceProviders: array b2bServiceProviders
• confirmationCodes: array confirmationCodes
• deliveryMethods: array deliveryMethods
• documents: array documents
• ExternalMessageStandardTag: string
  Maximum Length: 512
• ExternalMessageTypeTag: string
  Maximum Length: 512
• ExternalMessageVersionTag: string
  Maximum Length: 512
• FromPartnerIdTag: string
  Maximum Length: 512
• FromPartnerIdTypeTag: string
  Maximum Length: 512
• inboundCollaborationMessages: array inboundCollaborationMessages
• outboundCollaborationMessages: array outboundCollaborationMessages
• ToPartnerIdTag: string
  Maximum Length: 512
• ToPartnerIdTypeTag: string
  Maximum Length: 512

{
    "type":"object",
    "properties":{
        "ExternalMessageStandardTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "ExternalMessageTypeTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "ExternalMessageVersionTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "FromPartnerIdTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "FromPartnerIdTypeTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "ToPartnerIdTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "ToPartnerIdTypeTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "b2bServiceProviders":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-b2bServiceProviders-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "confirmationCodes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-confirmationCodes-item-patch-request"
            }
        },
        "deliveryMethods":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-deliveryMethods-item-patch-request"
            }
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-documents-item-patch-request"
            }
        },
        "inboundCollaborationMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-item-patch-request"
            }
        },
        "outboundCollaborationMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-item-patch-request"
            }
        }
    }
}

Nested Schema : b2bServiceProviders

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-b2bServiceProviders-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : confirmationCodes

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-confirmationCodes-item-patch-request"
    }
}

Nested Schema : deliveryMethods

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-deliveryMethods-item-patch-request"
    }
}

Nested Schema : documents

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-documents-item-patch-request"
    }
}

Nested Schema : inboundCollaborationMessages

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-item-patch-request"
    }
}

Nested Schema : outboundCollaborationMessages

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-item-patch-request"
    }
}

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

Type: object

Show Source

• ServiceProviderId: integer (int64)
• UserDefined: string
  Maximum Length: 1

  Default Value: Y

{
    "type":"object",
    "properties":{
        "ServiceProviderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UserDefined":{
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "default":"Y"
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CollaborationStatus: string
  Maximum Length: 100
• PartnerStatus: string
  Maximum Length: 256

{
    "type":"object",
    "properties":{
        "CollaborationStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerStatus":{
            "maxLength":256,
            "type":"string",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AttachXmlFlag: boolean
  Title: Attach Payload

  Maximum Length: 10
• CsfkeyPassword: string
• CsfkeyUser: string
• FileExtension: string
  Maximum Length: 10
• FileName: string
  Maximum Length: 256
• RecipientEmailId: string
  Title: Recipient Email ID

  Maximum Length: 256
• RemoteDir: string
  Maximum Length: 2000
• RequestHeaders: string
  Maximum Length: 2000
• SecurityPolicy: string
  Title: Security Policy

  Maximum Length: 256
• Service: string
  Title: Service Name

  Maximum Length: 256
• ServiceMeaning: string
• ServiceUri: string
• SftpHost: string
• SftpPort: string
  Maximum Length: 255

{
    "type":"object",
    "properties":{
        "AttachXmlFlag":{
            "title":"Attach Payload",
            "maxLength":10,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "CsfkeyPassword":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "CsfkeyUser":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "FileExtension":{
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "FileName":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "RecipientEmailId":{
            "title":"Recipient Email ID",
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "RemoteDir":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "RequestHeaders":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "SecurityPolicy":{
            "title":"Security Policy",
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Service":{
            "title":"Service Name",
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ServiceMeaning":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceUri":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "SftpHost":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SftpPort":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• DocumentId: integer
• DocumentName: string
• messageProcessingRules: array messageProcessingRules
• ServiceRequestId: integer
• TradingPartnerDocumentId: integer
• TradingPartnerDocumentStatus: string

{
    "type":"object",
    "properties":{
        "DocumentId":{
            "type":"integer",
            "nullable":true
        },
        "DocumentName":{
            "type":"string",
            "nullable":true
        },
        "ServiceRequestId":{
            "type":"integer",
            "nullable":true
        },
        "TradingPartnerDocumentId":{
            "type":"integer",
            "nullable":true
        },
        "TradingPartnerDocumentStatus":{
            "type":"string",
            "nullable":true
        },
        "messageProcessingRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-documents-messageProcessingRules-item-patch-request"
            }
        }
    }
}

Nested Schema : messageProcessingRules

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-documents-messageProcessingRules-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DefaultValue: string
  Maximum Length: 512
• IncludeInOutputFlag: boolean
  Maximum Length: 100
• MessageNodeXpath: string
  Maximum Length: 2000
• Name: string
  Maximum Length: 512
• ValueRequiredFlag: boolean
  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "DefaultValue":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "IncludeInOutputFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "MessageNodeXpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":false
        },
        "Name":{
            "maxLength":512,
            "type":"string",
            "nullable":false
        },
        "ValueRequiredFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AcknowledgementCode: string
  Maximum Length: 100

  Default Value: Never
• ApplicationPartnerCodeXpath: string
  Maximum Length: 2000
• domainValueMaps: array domainValueMaps
• LastUpdateDate: string (date-time)
• MessageId: integer (int64)
  Title: Collaboration Message Definition
• MessageName: string
• messageProcessingRules: array messageProcessingRules
• ObjectKey1Xpath: string
  Maximum Length: 2000
• ObjectKey2Xpath: string
  Maximum Length: 2000
• ObjectKey3Xpath: string
  Maximum Length: 2000
• ObjectKey4Xpath: string
  Maximum Length: 2000
• ObjectKey5Xpath: string
  Maximum Length: 2000
• ObjectKey6Xpath: string
  Maximum Length: 2000
• OverrideStatus: string
  Maximum Length: 100
• OverrideStatusDate: string (date-time)
• PartnerMessageStatus: string
  Maximum Length: 100
• PartnerMessageStatusDate: string (date-time)
• ProcessingAction: string
  Maximum Length: 256
• RetentionDuration: integer (int32)
  Title: Retention Duration
• RetentionDurationType: string
  Title: Retention Duration Unit

  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "AcknowledgementCode":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "default":"Never"
        },
        "ApplicationPartnerCodeXpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "MessageName":{
            "type":"string",
            "nullable":false
        },
        "ObjectKey1Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "ObjectKey2Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "ObjectKey3Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "ObjectKey4Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "ObjectKey5Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "ObjectKey6Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "OverrideStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideStatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "PartnerMessageStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "ProcessingAction":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            }
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "domainValueMaps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-patch-request"
            }
        },
        "messageProcessingRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-patch-request"
            }
        }
    }
}

Nested Schema : domainValueMaps

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-patch-request"
    }
}

Nested Schema : messageProcessingRules

Type: array

Show Source

• Array of: object b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-patch-request"
    }
}

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

Type: object

Show Source

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

Nested Schema : b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-patch-request

Type: object

Show Source

• DefaultValue: string
  Maximum Length: 512
• IncludeInOutputFlag: boolean
  Maximum Length: 100
• MessageNodeXpath: string
  Maximum Length: 2000
• Name: string
  Maximum Length: 512
• ValueRequiredFlag: boolean
  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "DefaultValue":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "IncludeInOutputFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "MessageNodeXpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":false
        },
        "Name":{
            "maxLength":512,
            "type":"string",
            "nullable":false
        },
        "ValueRequiredFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AlternateDeliveryMethodId: integer (int64)
• AlternateDeliveryMethodName: string
• AttachmentProcessingMethod: string
  Maximum Length: 64
• DeliveryMethodId: integer (int64)
• DeliveryMethodName: string
• domainValueMaps: array domainValueMaps
• MessageId: integer (int64)
  Title: Collaboration Message Definition
• MessageName: string
• messageProcessingRules: array messageProcessingRules
• OverrideStatus: string
  Maximum Length: 100
• OverrideStatusDate: string (date-time)
• PartnerMessageStatus: string
  Maximum Length: 100
• PartnerMessageStatusDate: string (date-time)
• ProcessingAction: string
  Maximum Length: 256
• RetentionDuration: integer (int32)
  Title: Retention Duration
• RetentionDurationType: string
  Title: Retention Duration Unit

  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "AlternateDeliveryMethodId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "DeliveryMethodId"
                ]
            }
        },
        "AlternateDeliveryMethodName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentProcessingMethod":{
            "maxLength":64,
            "type":"string",
            "nullable":true
        },
        "DeliveryMethodId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "DeliveryMethodName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "MessageName":{
            "type":"string",
            "nullable":false
        },
        "OverrideStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideStatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "PartnerMessageStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "ProcessingAction":{
            "maxLength":256,
            "type":"string",
            "nullable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            }
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "domainValueMaps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-patch-request"
            }
        },
        "messageProcessingRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-patch-request"
            }
        }
    }
}

Nested Schema : domainValueMaps

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-patch-request"
    }
}

Nested Schema : messageProcessingRules

Type: array

Show Source

• Array of: object b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-patch-request"
    }
}

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

Type: object

Show Source

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

Nested Schema : b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-patch-request

Type: object

Show Source

• DefaultValue: string
  Maximum Length: 512
• IncludeInOutputFlag: boolean
  Maximum Length: 100
• MessageNodeXpath: string
  Maximum Length: 2000
• Name: string
  Maximum Length: 512
• ValueRequiredFlag: boolean
  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "DefaultValue":{
            "maxLength":512,
            "type":"string",
            "nullable":true
        },
        "IncludeInOutputFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "MessageNodeXpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":false
        },
        "Name":{
            "maxLength":512,
            "type":"string",
            "nullable":false
        },
        "ValueRequiredFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true
        }
    }
}

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 : b2bTradingPartners-item-response

Type: object

Show Source

• b2bServiceProviders: array b2bServiceProviders
• confirmationCodes: array confirmationCodes
• CreationDate: string (date-time)
  Read Only: true
• deliveryMethods: array deliveryMethods
• documents: array documents
• ExternalMessageStandardTag: string
  Maximum Length: 512
• ExternalMessageTypeTag: string
  Maximum Length: 512
• ExternalMessageVersionTag: string
  Maximum Length: 512
• FromPartnerIdTag: string
  Maximum Length: 512
• FromPartnerIdTypeTag: string
  Maximum Length: 512
• inboundCollaborationMessages: array inboundCollaborationMessages
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualEntryIndicator: string
  Maximum Length: 10

  Default Value: Yes
• ObnId: string
  Read Only: true

  Maximum Length: 100
• outboundCollaborationMessages: array outboundCollaborationMessages
• ServiceProviderId: integer (int64)
• ServiceProviderName: string
• SPUserDefined: string
• ToPartnerIdTag: string
  Maximum Length: 512
• ToPartnerIdTypeTag: string
  Maximum Length: 512
• TradingPartner: string
  Title: Trading Partner ID

  Maximum Length: 100
• TradingPartnerId: integer (int64)
• TradingPartnerIdType: string
  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalMessageStandardTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalMessageTypeTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalMessageVersionTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FromPartnerIdTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FromPartnerIdTypeTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualEntryIndicator":{
            "maxLength":10,
            "type":"string",
            "nullable":false,
            "default":"Yes",
            "x-queryable":true
        },
        "ObnId":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SPUserDefined":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceProviderName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "Property2":"Value2",
                "Property1":"Value1",
                "Property":"Value"
            }
        },
        "ToPartnerIdTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ToPartnerIdTypeTag":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartner":{
            "title":"Trading Partner ID",
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TradingPartnerIdType":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "b2bServiceProviders":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-b2bServiceProviders-item-response"
            },
            "x-cardinality":"1"
        },
        "confirmationCodes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-confirmationCodes-item-response"
            }
        },
        "deliveryMethods":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-deliveryMethods-item-response"
            }
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-documents-item-response"
            }
        },
        "inboundCollaborationMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "outboundCollaborationMessages":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-item-response"
            }
        }
    }
}

Nested Schema : b2bServiceProviders

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-b2bServiceProviders-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : confirmationCodes

Type: array

Show Source

• Array of: object b2bTradingPartners-confirmationCodes-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-confirmationCodes-item-response"
    }
}

Nested Schema : deliveryMethods

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-deliveryMethods-item-response"
    }
}

Nested Schema : documents

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-documents-item-response"
    }
}

Nested Schema : inboundCollaborationMessages

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-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 : outboundCollaborationMessages

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-item-response"
    }
}

Nested Schema : b2bTradingPartners-b2bServiceProviders-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerId: string
  Title: Provider ID

  Maximum Length: 100
• PartnerIdType: string
  Maximum Length: 100
• ServiceProviderId: integer (int64)
• ServiceProviderName: string
  Maximum Length: 256
• UserDefined: string
  Maximum Length: 1

  Default Value: Y

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Provider ID",
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerIdType":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ServiceProviderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ServiceProviderName":{
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefined":{
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "default":"Y",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : b2bTradingPartners-confirmationCodes-item-response

Type: object

Show Source

• CollaborationStatus: string
  Maximum Length: 100
• ConfStatusXrefId: integer (int64)
• CreationDate: string (date-time)
  Read Only: true
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerStatus: string
  Maximum Length: 256

{
    "type":"object",
    "properties":{
        "CollaborationStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConfStatusXrefId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerStatus":{
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : b2bTradingPartners-deliveryMethods-item-response

Type: object

Show Source

• AttachXmlFlag: boolean
  Title: Attach Payload

  Maximum Length: 10
• B2bRoutingFlag: boolean
  Title: B2B Routing Enabled

  Maximum Length: 10

  Default Value: false
• CreationDate: string (date-time)
  Read Only: true
• CsfkeyPassword: string
• CsfkeyUser: string
• DeliveryMethodId: integer (int64)
• DeliveryMethodName: string
  Title: Name

  Maximum Length: 256
• DeliveryMethodType: string
  Maximum Length: 100
• FileExtension: string
  Maximum Length: 10
• FileName: string
  Maximum Length: 256
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

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

  Maximum Length: 256
• RemoteDir: string
  Maximum Length: 2000
• RequestHeaders: string
  Maximum Length: 2000
• SecurityPolicy: string
  Title: Security Policy

  Maximum Length: 256
• Service: string
  Title: Service Name

  Maximum Length: 256
• ServiceMeaning: string
• ServiceUri: string
• SftpHost: string
• SftpPort: string
  Maximum Length: 255
• UcmExportDocumentAccount: string
  Title: Repository Account

  Maximum Length: 1024

{
    "type":"object",
    "properties":{
        "AttachXmlFlag":{
            "title":"Attach Payload",
            "maxLength":10,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "B2bRoutingFlag":{
            "title":"B2B Routing Enabled",
            "maxLength":10,
            "type":"boolean",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CsfkeyPassword":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "CsfkeyUser":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "DeliveryMethodId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DeliveryMethodName":{
            "title":"Name",
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "DeliveryMethodType":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FileExtension":{
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientEmailId":{
            "title":"Recipient Email ID",
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RemoteDir":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RequestHeaders":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SecurityPolicy":{
            "title":"Security Policy",
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Service":{
            "title":"Service Name",
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ServiceMeaning":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceUri":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "SftpHost":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SftpPort":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "UcmExportDocumentAccount":{
            "title":"Repository Account",
            "maxLength":1024,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : b2bTradingPartners-documents-item-response

Type: object

Show Source

• DocumentId: integer
• DocumentName: string
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• messageProcessingRules: array messageProcessingRules
• ServiceRequestId: integer
• TradingPartnerDocumentId: integer
• TradingPartnerDocumentStatus: string

{
    "type":"object",
    "properties":{
        "DocumentId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentName":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceRequestId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerDocumentId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerDocumentStatus":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "messageProcessingRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-documents-messageProcessingRules-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 : messageProcessingRules

Type: array

Show Source

• Array of: object b2bTradingPartners-documents-messageProcessingRules-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-documents-messageProcessingRules-item-response"
    }
}

Nested Schema : b2bTradingPartners-documents-messageProcessingRules-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true
• DefaultValue: string
  Maximum Length: 512
• IncludeInOutputFlag: boolean
  Maximum Length: 100
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageNodeXpath: string
  Maximum Length: 2000
• Name: string
  Maximum Length: 512
• NodeId: integer (int64)
• ValueRequiredFlag: boolean
  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeInOutputFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNodeXpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":512,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "NodeId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValueRequiredFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Type: object

Show Source

• AcknowledgementCode: string
  Maximum Length: 100

  Default Value: Never
• ApplicationPartnerCodeXpath: string
  Maximum Length: 2000
• CreationDate: string (date-time)
• DocumentId: integer (int64)
• DocumentName: string
  Read Only: true

  Maximum Length: 256
• domainValueMaps: array domainValueMaps
• LastUpdateDate: string (date-time)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageId: integer (int64)
  Title: Collaboration Message Definition
• MessageName: string
• messageProcessingRules: array messageProcessingRules
• ObjectKey1Xpath: string
  Maximum Length: 2000
• ObjectKey2Xpath: string
  Maximum Length: 2000
• ObjectKey3Xpath: string
  Maximum Length: 2000
• ObjectKey4Xpath: string
  Maximum Length: 2000
• ObjectKey5Xpath: string
  Maximum Length: 2000
• ObjectKey6Xpath: string
  Maximum Length: 2000
• OverrideStatus: string
  Maximum Length: 100
• OverrideStatusDate: string (date-time)
• PartnerMessageCustomizationId: integer (int64)
• PartnerMessageId: integer (int64)
• PartnerMessageName: string
  Title: Name

  Maximum Length: 256
• PartnerMessageStatus: string
  Maximum Length: 100
• PartnerMessageStatusDate: string (date-time)
• ProcessingAction: string
  Maximum Length: 256
• RetentionDuration: integer (int32)
  Title: Retention Duration
• RetentionDurationType: string
  Title: Retention Duration Unit

  Maximum Length: 100
• UserDefinedFlag: boolean
  Read Only: true

{
    "type":"object",
    "properties":{
        "AcknowledgementCode":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "default":"Never",
            "x-queryable":true
        },
        "ApplicationPartnerCodeXpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentName":{
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectKey1Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey2Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey3Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey4Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey5Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKey6Xpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverrideStatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerMessageCustomizationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerMessageId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartnerMessageName":{
            "title":"Name",
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerMessageStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingAction":{
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "domainValueMaps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "messageProcessingRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-response"
            }
        }
    }
}

Nested Schema : domainValueMaps

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-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 : messageProcessingRules

Type: array

Show Source

• Array of: object b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-inboundCollaborationMessages-messageProcessingRules-item-response"
    }
}

Nested Schema : b2bTradingPartners-inboundCollaborationMessages-domainValueMaps-item-response

Type: object

Show Source

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

  Maximum Length: 256
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageDvmId: integer (int64)
  Read Only: true
• MessageId: integer (int64)
  Read Only: true
• MessageName: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DvmName":{
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDvmId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "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"
            }
        }
    }
}

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

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true
• DefaultValue: string
  Maximum Length: 512
• IncludeInOutputFlag: boolean
  Maximum Length: 100
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageNodeXpath: string
  Maximum Length: 2000
• Name: string
  Maximum Length: 512
• NodeId: integer (int64)
• ValueRequiredFlag: boolean
  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeInOutputFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNodeXpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":512,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "NodeId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValueRequiredFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Type: object

Show Source

• AlternateDeliveryMethodId: integer (int64)
• AlternateDeliveryMethodName: string
• AttachmentProcessingMethod: string
  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• DeliveryMethodId: integer (int64)
• DeliveryMethodName: string
• DocumentId: integer (int64)
• DocumentName: string
  Read Only: true

  Maximum Length: 256
• domainValueMaps: array domainValueMaps
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageId: integer (int64)
  Title: Collaboration Message Definition
• MessageName: string
• messageProcessingRules: array messageProcessingRules
• OverrideStatus: string
  Maximum Length: 100
• OverrideStatusDate: string (date-time)
• PartnerMessageCustomizationId: integer (int64)
• PartnerMessageId: integer (int64)
• PartnerMessageName: string
  Title: Name

  Maximum Length: 256
• PartnerMessageStatus: string
  Maximum Length: 100
• PartnerMessageStatusDate: string (date-time)
• ProcessingAction: string
  Maximum Length: 256
• RetentionDuration: integer (int32)
  Title: Retention Duration
• RetentionDurationType: string
  Title: Retention Duration Unit

  Maximum Length: 100
• ServiceProviderId: integer (int64)
• UserDefinedFlag: boolean
  Read Only: true

{
    "type":"object",
    "properties":{
        "AlternateDeliveryMethodId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "DeliveryMethodId"
                ]
            },
            "x-queryable":true
        },
        "AlternateDeliveryMethodName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentProcessingMethod":{
            "maxLength":64,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveryMethodId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "DeliveryMethodName":{
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentName":{
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "title":"Collaboration Message Definition",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "OverrideStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverrideStatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerMessageCustomizationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerMessageId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartnerMessageName":{
            "title":"Name",
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerMessageStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerMessageStatusDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingAction":{
            "maxLength":256,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RetentionDuration":{
            "title":"Retention Duration",
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "RetentionDurationType":{
            "title":"Retention Duration Unit",
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ServiceProviderId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "domainValueMaps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "messageProcessingRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-response"
            }
        }
    }
}

Nested Schema : domainValueMaps

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-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 : messageProcessingRules

Type: array

Show Source

• Array of: object b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-outboundCollaborationMessages-messageProcessingRules-item-response"
    }
}

Nested Schema : b2bTradingPartners-outboundCollaborationMessages-domainValueMaps-item-response

Type: object

Show Source

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

  Maximum Length: 256
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageDvmId: integer (int64)
  Read Only: true
• MessageId: integer (int64)
  Read Only: true
• MessageName: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DvmName":{
            "maxLength":256,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDvmId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageName":{
            "type":"string",
            "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"
            }
        }
    }
}

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

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true
• DefaultValue: string
  Maximum Length: 512
• IncludeInOutputFlag: boolean
  Maximum Length: 100
• LastUpdateDate: string (date-time)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageNodeXpath: string
  Maximum Length: 2000
• Name: string
  Maximum Length: 512
• NodeId: integer (int64)
• ValueRequiredFlag: boolean
  Maximum Length: 100

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "maxLength":512,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeInOutputFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNodeXpath":{
            "maxLength":2000,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":512,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "NodeId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ValueRequiredFlag":{
            "maxLength":100,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

b2bServiceProviders

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/b2bServiceProviders

Parameters:

• TradingPartnerId: $request.path.TradingPartnerId

confirmationCodes

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/confirmationCodes

Parameters:

• TradingPartnerId: $request.path.TradingPartnerId

deliveryMethods

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/deliveryMethods

Parameters:

• TradingPartnerId: $request.path.TradingPartnerId

documents

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/documents

Parameters:

• TradingPartnerId: $request.path.TradingPartnerId

inboundCollaborationMessages

Operation: /fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/inboundCollaborationMessages

Parameters:

• TradingPartnerId: $request.path.TradingPartnerId

outboundCollaborationMessages

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

Parameters:

• TradingPartnerId: $request.path.TradingPartnerId

Back to Top

Examples

This example describes how to update one trading partner.

Example cURL Command

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

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

Example Request Body

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

{
 "FromPartnerIdTag" : 123
}

Example Response Body

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

{
  "TradingPartnerId" : 300100073313017,
  "TradingPartner" : "891678078",
  "TradingPartnerIdType" : "ORA_DUNS",
  "ManualEntryIndicator" : "Yes",
  "ServiceProviderId" : 50055,
  "ServiceProviderName" : "None",
  "FromPartnerIdTag" : "123",
  "FromPartnerIdTypeTag" : null,
  "ToPartnerIdTag" : null,
  "ToPartnerIdTypeTag" : null,
  "ExternalMessageTypeTag" : null,
  "ExternalMessageVersionTag" : null,
  "ExternalMessageStandardTag" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017",
    "name" : "b2bTradingPartners",
    "kind" : "item"
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017",
    "name" : "b2bTradingPartners",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/lov/tradingPartnerTypeLOV",
    "name" : "tradingPartnerTypeLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/lov/serviceProvidersLOV",
    "name" : "serviceProvidersLOV",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/documents",
    "name" : "documents",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/inboundCollaborationMessages",
    "name" : "inboundCollaborationMessages",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/outboundCollaborationMessages",
    "name" : "outboundCollaborationMessages",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/confirmationCodes",
    "name" : "confirmationCodes",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/b2bServiceProviders",
    "name" : "b2bServiceProviders",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100073313017/child/deliveryMethods",
    "name" : "deliveryMethods",
    "kind" : "collection"
  } ]
}

Back to Top