Jump to

• Request
• Response

Create message definitions

post

/fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApplicationPartnerCodeXpath: string
  Maximum Length: 2000

  Value that stores the sender application partner code cross reference path.
• b2bLocationAssignments: array B2B Location Assignments
  Title: B2B Location Assignments

  Details of the bill-to and ship-to location assignments configured for a message definition.
• DefaultEmailSubject: string
  Maximum Length: 512

  Subject of the message email, for example Purchase Order.
• DocumentId: integer
  Value that uniquely identifies the collaboration document.
• DocumentName: string
  Maximum Length: 255

  Name of the collaboration document associated with the message definition.
• emailProperties: array Email Properties
  Title: Email Properties

  An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email.
• ExternalMessageTypeId: integer (int64)
  Value that uniquely identifies the external message definition associated with the collaboration message definition.
• ExternalMessageTypeName: string
  Name of the external message definition associated with the collaboration message definition.
• GenericXsltFileName: string
  Maximum Length: 512

  Name of the XSLT file that contains the transformation to be applied, if any, for the message.
• MessageDescription: string
  Maximum Length: 256

  Description of the collaboration message definition.
• MessageId: integer (int64)
  Value that uniquely identifies the collaboration message definition.
• MessageName(required): string
  Maximum Length: 256

  Name of the collaboration message definition.
• ObjectKeyXpath: string
  Maximum Length: 2000

  Value that identifies the XPath expression locating the object key in an XML payload. For example, the invoice number is the object key in the invoice XML file.
• PayloadTemplate: string (byte)
  Payload template associated with the message definition. A payload template is an XML sample that may be used for testing or validating your message setup.
• RecipientEmailXpath: string
  Maximum Length: 2000

  Path that identifies the email recipient in the payload.
• ServiceProviderName: string
  Name of the service provider that the message definition was created for.
• TrOrigionalMessageId: string
  Value that uniquely identifies the original message from which attributes are used to create a new message definition.
• XsltFile: string (byte)
  XSL file that's associated with the message definition. An XSL file is used for the transformation of the message.

{
    "required":[
        "MessageName"
    ],
    "type":"object",
    "properties":{
        "PayloadTemplate":{
            "type":"string",
            "description":"Payload template associated with the message definition. A payload template is an XML sample that may be used for testing or validating your message setup.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ServiceProviderName":{
            "type":"string",
            "description":"Name of the service provider that the message definition was created for.",
            "nullable":true
        },
        "MessageDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the collaboration message definition.",
            "nullable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document.",
            "nullable":true
        },
        "MessageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the collaboration message definition.",
            "nullable":false
        },
        "ExternalMessageTypeName":{
            "type":"string",
            "description":"Name of the external message definition associated with the collaboration message definition.",
            "nullable":true
        },
        "RecipientEmailXpath":{
            "maxLength":2000,
            "type":"string",
            "description":"Path that identifies the email recipient in the payload.",
            "nullable":true
        },
        "TrOrigionalMessageId":{
            "type":"string",
            "description":"Value that uniquely identifies the original message from which attributes are used to create a new message definition.",
            "nullable":true,
            "x-queryable":false
        },
        "emailProperties":{
            "title":"Email Properties",
            "type":"array",
            "description":"An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the  message payload for the email.",
            "items":{
                "$ref":"#/components/schemas/b2bMessageDefinitions-emailProperties-item-post-request"
            }
        },
        "ApplicationPartnerCodeXpath":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that stores the sender application partner code cross reference path.",
            "nullable":true
        },
        "DefaultEmailSubject":{
            "maxLength":512,
            "type":"string",
            "description":"Subject of the message email, for example Purchase Order.",
            "nullable":true
        },
        "b2bLocationAssignments":{
            "title":"B2B Location Assignments",
            "type":"array",
            "description":"Details of the bill-to and ship-to location assignments configured for a message definition.",
            "items":{
                "$ref":"#/components/schemas/b2bMessageDefinitions-b2bLocationAssignments-item-post-request"
            }
        },
        "ExternalMessageTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external message definition associated with the collaboration message definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "GenericXsltFileName":{
            "maxLength":512,
            "type":"string",
            "description":"Name of the XSLT file that contains the transformation to be applied, if any, for the message.",
            "nullable":true
        },
        "XsltFile":{
            "type":"string",
            "description":"XSL file that's associated with the message definition. An XSL file is used for the transformation of the message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectKeyXpath":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that identifies the XPath expression locating the object key in an XML payload. For example, the invoice number is the object key in the invoice XML file.",
            "nullable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DocumentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the collaboration document associated with the message definition.",
            "nullable":true
        }
    }
}

Nested Schema : B2B Location Assignments

Type: array

Title: B2B Location Assignments

Details of the bill-to and ship-to location assignments configured for a message definition.

Show Source

• Array of: object b2bMessageDefinitions-b2bLocationAssignments-item-post-request

{
    "title":"B2B Location Assignments",
    "type":"array",
    "description":"Details of the bill-to and ship-to location assignments configured for a message definition.",
    "items":{
        "$ref":"#/components/schemas/b2bMessageDefinitions-b2bLocationAssignments-item-post-request"
    }
}

Nested Schema : Email Properties

Type: array

Title: Email Properties

An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email.

Show Source

• Array of: object schema

{
    "title":"Email Properties",
    "type":"array",
    "description":"An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the  message payload for the email.",
    "items":{
        "$ref":"#/components/schemas/b2bMessageDefinitions-emailProperties-item-post-request"
    }
}

Nested Schema : b2bMessageDefinitions-b2bLocationAssignments-item-post-request

Type: object

Show Source

• CrossReferenceB2BLocationAssignmentId: integer (int64)
  Value that uniquely identifies the cross reference domain assignments.
• Type: string
  Maximum Length: 100

  Type of field. Valid values are SHIP_TO and BILL_TO.
• ValueXpath: string
  Maximum Length: 2000

  Value that identifies the XPath of the value to be evaluated.

{
    "type":"object",
    "properties":{
        "Type":{
            "maxLength":100,
            "type":"string",
            "description":"Type of field. Valid values are SHIP_TO and BILL_TO.",
            "nullable":true
        },
        "ValueXpath":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that identifies the XPath of the value to be evaluated.",
            "nullable":true
        },
        "CrossReferenceB2BLocationAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cross reference domain assignments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EmailPropertyId: integer (int64)
  Value that uniquely identifies the email properties.
• Name: string
  Maximum Length: 512

  Title or name of an attribute that is displayed as a column or header in the body of a B2B message email.
• SequenceNumber: integer (int32)
  Autonumber starting with 1
• TitleType: string
  Maximum Length: 100

  Type of title for which the name is specified, valid values are Header or Column.

{
    "type":"object",
    "properties":{
        "SequenceNumber":{
            "type":"integer",
            "description":"Autonumber starting with 1",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":6
            }
        },
        "EmailPropertyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email properties.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TitleType":{
            "maxLength":100,
            "type":"string",
            "description":"Type of title for which the name is specified, valid values are Header or Column.",
            "nullable":false
        },
        "Name":{
            "maxLength":512,
            "type":"string",
            "description":"Title or name of an attribute that is displayed as a column or header in the body of a B2B message email.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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 : b2bMessageDefinitions-item-response

Type: object

Show Source

• ApplicationPartnerCodeXpath: string
  Maximum Length: 2000

  Value that stores the sender application partner code cross reference path.
• AttachmentsFlag: boolean
  Read Only: true

  Maximum Length: 10

  Contains one of the following values: true or false. If true, then the document supports attachments. If false, then the document doesn???t support attachments. The default value is false.
• b2bLocationAssignments: array B2B Location Assignments
  Title: B2B Location Assignments

  Details of the bill-to and ship-to location assignments configured for a message definition.
• DefaultEmailSubject: string
  Maximum Length: 512

  Subject of the message email, for example Purchase Order.
• Direction: string
  Read Only: true

  Maximum Length: 100

  Value that indicates the direction of the message, either inbound or outbound.
• DirectionDescription: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Description for the direction of the message.
• DocumentDescription: string
  Read Only: true

  Maximum Length: 256

  Description of the transient collaboration document.
• DocumentId: integer
  Value that uniquely identifies the collaboration document.
• DocumentName: string
  Maximum Length: 255

  Name of the collaboration document associated with the message definition.
• DocumentType: string
  Read Only: true

  Maximum Length: 256

  Value that uniquely identifies the type of document being sent, such as 'ProcessPurchaseOrder'.
• DocumentTypeDescription: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of document being sent, such as a Process Purchase Order.
• emailProperties: array Email Properties
  Title: Email Properties

  An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email.
• ExternalMessageTypeId: integer (int64)
  Value that uniquely identifies the external message definition associated with the collaboration message definition.
• ExternalMessageTypeName: string
  Name of the external message definition associated with the collaboration message definition.
• GenericXsltFileName: string
  Maximum Length: 512

  Name of the XSLT file that contains the transformation to be applied, if any, for the message.
• links: array Links
  Title: Links

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

  Description of the collaboration message definition.
• MessageId: integer (int64)
  Value that uniquely identifies the collaboration message definition.
• MessageName: string
  Maximum Length: 256

  Name of the collaboration message definition.
• MessageStandard: string
  Read Only: true

  Maximum Length: 100

  Value that identifies the code of the messaging standard.
• MessageStandardDescription: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that describes the messaging standard; for example, OracleB2B.
• MessageSubtype: string
  Read Only: true

  Maximum Length: 512

  A unique value used to identify a message when multiple messages share the same root element.
• MessageType: string
  Read Only: true

  Maximum Length: 100

  The name of a unique XML schema definition for a document, representing the root element of the payload, such as Process Purchase Order.
• MessageVersion: string
  Read Only: true

  Maximum Length: 100

  Version of the message standard, for example 10.1.
• ObjectKeyXpath: string
  Maximum Length: 2000

  Value that identifies the XPath expression locating the object key in an XML payload. For example, the invoice number is the object key in the invoice XML file.
• PayloadTemplate: string (byte)
  Payload template associated with the message definition. A payload template is an XML sample that may be used for testing or validating your message setup.
• RecipientEmailXpath: string
  Maximum Length: 2000

  Path that identifies the email recipient in the payload.
• ServiceProviderName: string
  Name of the service provider that the message definition was created for.
• TrOrigionalMessageId: string
  Value that uniquely identifies the original message from which attributes are used to create a new message definition.
• UserDefinedFlag: boolean
  Read Only: true

  Maximum Length: 10

  Value that indicates whether the message definition is predefined. Contains one of the following values: true or false. If true, it is a predefined message; if false, it is a user-created message
• XsltFile: string (byte)
  XSL file that's associated with the message definition. An XSL file is used for the transformation of the message.

{
    "type":"object",
    "properties":{
        "PayloadTemplate":{
            "type":"string",
            "description":"Payload template associated with the message definition. A payload template is an XML sample that may be used for testing or validating your message setup.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document.",
            "nullable":true,
            "x-queryable":true
        },
        "Direction":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates the direction of the message, either inbound or outbound.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the collaboration message definition.",
            "nullable":false,
            "x-queryable":true
        },
        "TrOrigionalMessageId":{
            "type":"string",
            "description":"Value that uniquely identifies the original message from which attributes are used to create a new message definition.",
            "nullable":true,
            "x-queryable":false
        },
        "b2bLocationAssignments":{
            "title":"B2B Location Assignments",
            "type":"array",
            "description":"Details of the bill-to and ship-to location assignments configured for a message definition.",
            "items":{
                "$ref":"#/components/schemas/b2bMessageDefinitions-b2bLocationAssignments-item-response"
            }
        },
        "MessageSubtype":{
            "maxLength":512,
            "type":"string",
            "description":"A unique value used to identify a message when multiple messages share the same root element.",
            "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"
            }
        },
        "ExternalMessageTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external message definition associated with the collaboration message definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GenericXsltFileName":{
            "maxLength":512,
            "type":"string",
            "description":"Name of the XSLT file that contains the transformation to be applied, if any, for the message.",
            "nullable":true,
            "x-queryable":true
        },
        "XsltFile":{
            "type":"string",
            "description":"XSL file that's associated with the message definition. An XSL file is used for the transformation of the message.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectKeyXpath":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that identifies the XPath expression locating the object key in an XML payload. For example, the invoice number is the object key in the invoice XML file.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageType":{
            "maxLength":100,
            "type":"string",
            "description":"The name of a unique XML schema definition for a document, representing the root element of the payload, such as Process Purchase Order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the collaboration document associated with the message definition.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageVersion":{
            "maxLength":100,
            "type":"string",
            "description":"Version of the message standard, for example 10.1.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserDefinedFlag":{
            "maxLength":10,
            "type":"boolean",
            "description":"Value that indicates whether the message definition is predefined. Contains one of the following values: true or false. If true, it is a predefined message; if false, it is a user-created message",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceProviderName":{
            "type":"string",
            "description":"Name of the service provider that the message definition was created for.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentsFlag":{
            "maxLength":10,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the document supports attachments. If false, then the document doesn???t support attachments. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the collaboration message definition.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":256,
            "type":"string",
            "description":"Value that uniquely identifies the type of document being sent, such as 'ProcessPurchaseOrder'.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageStandardDescription":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that describes the messaging standard; for example, OracleB2B.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageStandard":{
            "maxLength":100,
            "type":"string",
            "description":"Value that identifies the code of the messaging standard.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalMessageTypeName":{
            "type":"string",
            "description":"Name of the external message definition associated with the collaboration message definition.",
            "nullable":true,
            "x-queryable":true
        },
        "RecipientEmailXpath":{
            "maxLength":2000,
            "type":"string",
            "description":"Path that identifies the email recipient in the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "emailProperties":{
            "title":"Email Properties",
            "type":"array",
            "description":"An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the  message payload for the email.",
            "items":{
                "$ref":"#/components/schemas/b2bMessageDefinitions-emailProperties-item-response"
            }
        },
        "DocumentDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the transient collaboration document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationPartnerCodeXpath":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that stores the sender application partner code cross reference path.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultEmailSubject":{
            "maxLength":512,
            "type":"string",
            "description":"Subject of the message email, for example Purchase Order.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentTypeDescription":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of document being sent, such as a Process Purchase Order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionDescription":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description for the direction of the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration message definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : B2B Location Assignments

Type: array

Title: B2B Location Assignments

Details of the bill-to and ship-to location assignments configured for a message definition.

Show Source

• Array of: object b2bMessageDefinitions-b2bLocationAssignments-item-response

{
    "title":"B2B Location Assignments",
    "type":"array",
    "description":"Details of the bill-to and ship-to location assignments configured for a message definition.",
    "items":{
        "$ref":"#/components/schemas/b2bMessageDefinitions-b2bLocationAssignments-item-response"
    }
}

Nested Schema : Email Properties

Type: array

Title: Email Properties

An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email.

Show Source

• Array of: object b2bMessageDefinitions-emailProperties-item-response

{
    "title":"Email Properties",
    "type":"array",
    "description":"An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the  message payload for the email.",
    "items":{
        "$ref":"#/components/schemas/b2bMessageDefinitions-emailProperties-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 : b2bMessageDefinitions-b2bLocationAssignments-item-response

Type: object

Show Source

• CrossReferenceB2BLocationAssignmentId: integer (int64)
  Value that uniquely identifies the cross reference domain assignments.
• links: array Links
  Title: Links

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

  Type of field. Valid values are SHIP_TO and BILL_TO.
• ValueXpath: string
  Maximum Length: 2000

  Value that identifies the XPath of the value to be evaluated.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Type":{
            "maxLength":100,
            "type":"string",
            "description":"Type of field. Valid values are SHIP_TO and BILL_TO.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueXpath":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that identifies the XPath of the value to be evaluated.",
            "nullable":true,
            "x-queryable":true
        },
        "CrossReferenceB2BLocationAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cross reference domain assignments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : 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 : b2bMessageDefinitions-emailProperties-item-response

Type: object

Show Source

• EmailPropertyId: integer (int64)
  Value that uniquely identifies the email properties.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 512

  Title or name of an attribute that is displayed as a column or header in the body of a B2B message email.
• SequenceNumber: integer (int32)
  Autonumber starting with 1
• TitleType: string
  Maximum Length: 100

  Type of title for which the name is specified, valid values are Header or Column.

{
    "type":"object",
    "properties":{
        "SequenceNumber":{
            "type":"integer",
            "description":"Autonumber starting with 1",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmailPropertyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email properties.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TitleType":{
            "maxLength":100,
            "type":"string",
            "description":"Type of title for which the name is specified, valid values are Header or Column.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":512,
            "type":"string",
            "description":"Title or name of an attribute that is displayed as a column or header in the body of a B2B message email.",
            "nullable":false,
            "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

b2bLocationAssignments

Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions/{MessageId}/child/b2bLocationAssignments

Parameters:

• MessageId: $request.path.MessageId

Details of the bill-to and ship-to location assignments configured for a message definition.

emailProperties

Operation: /fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions/{MessageId}/child/emailProperties

Parameters:

• MessageId: $request.path.MessageId

An email property represents the layout of attributes that are included in the body of a B2B message email. The attributes are extracted from the message payload for the email.

Back to Top