1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. SCM Common
  4. B2B Message Definitions

Get one message definition

get

/fscmRestApi/resources/11.13.18.05/b2bMessageDefinitions/{MessageName}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : b2bMessageDefinitions-item-response
Type: object
Show Source
  • Maximum Length: 2000
    Value that stores the sender application partner code cross reference path.
  • 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.
  • B2B Location Assignments
    Title: B2B Location Assignments
    Details of the bill-to and ship-to location assignments configured for a message definition.
  • Read Only: true
    Maximum Length: 256
    Description of the transient collaboration document.
  • Read Only: true
    Maximum Length: 256
    Name of the collaboration document associated with the message definition.
  • Name of the external message definition associated with the collaboration message definition.
  • Maximum Length: 512
    Name of the XSLT file that contains the transformation to be applied, if any, for the message.
  • Links
  • Maximum Length: 256
    Description of the collaboration message definition.
  • Value that uniquely identifies the collaboration message definition.
  • Maximum Length: 256
    Name of the collaboration message definition.
  • Read Only: true
    Maximum Length: 100
    Value that identifies the code of the messaging standard.
  • Read Only: true
    Maximum Length: 512
    A unique value used to identify a message when multiple messages share the same root element.
  • 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.
  • Read Only: true
    Maximum Length: 100
    Version of the message standard, for example 10.1.
  • 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.
  • 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.
  • Name of the service provider that the message definition was created for.
  • 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
  • XSL file that's associated with the message definition. An XSL file is used for the transformation of the message.
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
Nested Schema : b2bMessageDefinitions-b2bLocationAssignments-item-response
Type: object
Show Source
Links
b2bLocationAssignments
Parameters:
  • MessageName: $request.path.MessageName
Details of the bill-to and ship-to location assignments configured for a message definition.
Back to Top

Examples

This example describes how to get one message definition.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/b2bMessageDefinitions/MessageName"

For example, the following command gets one message definition where the message name is OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT:

curl -u username:password "https://servername/fscmRestApi/resources/version/b2bMessageDefinitions/OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "MessageId": 40011,
    "MessageName": "OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT",
    "MessageDescription": "Purchase Order to OAGIS 10. 1 Process Purchase Order Collaboration Message transformation",
    "GenericXsltFileName": "PRC-PO-OrderResponseToOAGIS-10.1-ProcessPurchaseOrderCollaborationMessage.xsl",
    "MessageSubtype": "ProcessPurchaseOrder",
    "MessageType": "CollaborationMessage",
    "MessageStandard": "ORA_OAGIS",
    "MessageVersion": "10.1",
    "UserDefinedFlag": "false",
    "ApplicationPartnerCodeXpath": null,
    "ObjectKeyXpath": null,
    "ReferenceObjectKeyXpath": null,
    "DocumentName": "PROCESS_PO_OUT",
    "ExternalMessageTypeName": "OAGIS_10.1_PROCESS_PO_COLLAB_MSG",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/b2bMessageDefinitions/OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT",
            "name": "b2bMessageDefinitions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/b2bMessageDefinitions/OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT",
            "name": "b2bMessageDefinitions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/b2bMessageDefinitions/OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT/child/b2bLocationAssignments",
            "name": "b2bLocationAssignments",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/b2bMessageDefinitions/OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT/enclosure/PayloadTemplate",
            "name": "PayloadTemplate",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/b2bMessageDefinitions/OAGIS_10.1_PROCESS_PO_COLLAB_MSG_OUT/enclosure/XsltFile",
            "name": "XsltFile",
            "kind": "other"
        }
    ]
}
Back to Top