Jump to

• Request
• Response
• Examples

Update one trading partner document

patch

/fscmRestApi/resources/11.13.18.05/b2bTradingPartners/{TradingPartnerId}/child/documents/{TradingPartnerDocumentId}

Request

Path Parameters

• TradingPartnerDocumentId(required): integer
  Value that uniquely identifies the trading partner document. This attribute is a foreign key reference to the trading partner document.
• TradingPartnerId(required): integer(int64)
  Value that uniquely identifies the trading partner. It is a primary key that the application generates when it creates a trading partner record. This attribute is required.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DocumentId: integer
  Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
• DocumentName: string
  Name of the trading partner document.
• messageProcessingRules: array Message Processing Rules
  Title: Message Processing Rules

  The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
• ServiceRequestId: integer
  Value that uniquely identifies the service request. The application generates this value when a setup request is made to a service provider.
• TradingPartnerDocumentId: integer
  Value that uniquely identifies the trading partner document. This attribute is a foreign key reference to the trading partner document.
• TradingPartnerDocumentStatus: string
  Value that specifies the status of the trading partner document.

{
    "type":"object",
    "properties":{
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.",
            "nullable":true
        },
        "TradingPartnerDocumentStatus":{
            "type":"string",
            "description":"Value that specifies the status of the trading partner document.",
            "nullable":true
        },
        "TradingPartnerDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner document. This attribute is a foreign key reference to the trading partner document.",
            "nullable":true
        },
        "messageProcessingRules":{
            "title":"Message Processing Rules",
            "type":"array",
            "description":"The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-documents-messageProcessingRules-item-patch-request"
            }
        },
        "DocumentName":{
            "type":"string",
            "description":"Name of the trading partner document.",
            "nullable":true
        },
        "ServiceRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service request. The application generates this value when a setup request is made to a service provider.",
            "nullable":true
        }
    }
}

Nested Schema : Message Processing Rules

Type: array

Title: Message Processing Rules

The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.

Show Source

• Array of: object schema

{
    "title":"Message Processing Rules",
    "type":"array",
    "description":"The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-documents-messageProcessingRules-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DefaultValue: string
  Maximum Length: 512

  Value that specifies the default value of the node identified in the XPath.
• IncludeInOutputFlag: boolean
  Maximum Length: 100

  Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
• MessageNodeXpath: string
  Maximum Length: 2000

  Value that specifies the cross reference path of the external message.
• Name: string
  Maximum Length: 512

  Name of the message processing rule.
• ValueRequiredFlag: boolean
  Maximum Length: 100

  Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.

{
    "type":"object",
    "properties":{
        "MessageNodeXpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that specifies the cross reference path of the external message.",
            "nullable":false
        },
        "DefaultValue":{
            "maxLength":"512",
            "type":"string",
            "description":"Value that specifies the default value of the node identified in the XPath.",
            "nullable":true
        },
        "ValueRequiredFlag":{
            "maxLength":"100",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.",
            "nullable":true
        },
        "IncludeInOutputFlag":{
            "maxLength":"100",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the message processing rule.",
            "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 : b2bTradingPartners-documents-item-response

Type: object

Show Source

• DocumentId: integer
  Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.
• DocumentName: string
  Name of the trading partner document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• messageProcessingRules: array Message Processing Rules
  Title: Message Processing Rules

  The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.
• ServiceRequestId: integer
  Value that uniquely identifies the service request. The application generates this value when a setup request is made to a service provider.
• TradingPartnerDocumentId: integer
  Value that uniquely identifies the trading partner document. This attribute is a foreign key reference to the trading partner document.
• TradingPartnerDocumentStatus: string
  Value that specifies the status of the trading partner document.

{
    "type":"object",
    "properties":{
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document. This attribute is a foreign key reference to the collaboration document.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TradingPartnerDocumentStatus":{
            "type":"string",
            "description":"Value that specifies the status of the trading partner document.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the trading partner document. This attribute is a foreign key reference to the trading partner document.",
            "nullable":true,
            "x-queryable":true
        },
        "messageProcessingRules":{
            "title":"Message Processing Rules",
            "type":"array",
            "description":"The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.",
            "items":{
                "$ref":"#/components/schemas/b2bTradingPartners-documents-messageProcessingRules-item-response"
            }
        },
        "DocumentName":{
            "type":"string",
            "description":"Name of the trading partner document.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service request. The application generates this value when a setup request is made to a service provider.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Message Processing Rules

Type: array

Title: Message Processing Rules

The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.

Show Source

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

{
    "title":"Message Processing Rules",
    "type":"array",
    "description":"The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.",
    "items":{
        "$ref":"#/components/schemas/b2bTradingPartners-documents-messageProcessingRules-item-response"
    }
}

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-documents-messageProcessingRules-item-response

Type: object

Show Source

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

  Date when the user set up the processing rule for the trading partner's collaboration message.
• DefaultValue: string
  Maximum Length: 512

  Value that specifies the default value of the node identified in the XPath.
• IncludeInOutputFlag: boolean
  Maximum Length: 100

  Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the processing rule for the trading partner's collaboration message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageNodeXpath: string
  Maximum Length: 2000

  Value that specifies the cross reference path of the external message.
• Name: string
  Maximum Length: 512

  Name of the message processing rule.
• NodeId: integer (int64)
  Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.
• ValueRequiredFlag: boolean
  Maximum Length: 100

  Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user set up the processing rule for the trading partner's collaboration message.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "maxLength":"512",
            "type":"string",
            "description":"Value that specifies the default value of the node identified in the XPath.",
            "nullable":true,
            "x-queryable":true
        },
        "NodeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the message processing rule. It is a primary key that the application generates when it creates a message processing rule record. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MessageNodeXpath":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that specifies the cross reference path of the external message.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ValueRequiredFlag":{
            "maxLength":"100",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a value is required for a field. If false, then value is not required for a field. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeInOutputFlag":{
            "maxLength":"100",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the field should be included in the message. If false, then the field should not be included in the message. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the processing rule for the trading partner's collaboration message.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the message processing rule.",
            "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

messageProcessingRules

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

Parameters:

• TradingPartnerDocumentId: $request.path.TradingPartnerDocumentId
• TradingPartnerId: $request.path.TradingPartnerId

The Message Processing Rules resource gets all the rules associated with the trading partner that are implemented while processing a message.

Back to Top

Examples

This example describes how to update one trading partner document.

Example cURL Command

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

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

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.

{
 "TradingPartnerDocumentStatus" : "Inactive"
}

Example Response Body

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

{
  "DocumentId" : 40044,
  "DocumentName" : "PROCESS_SHIPMENT_IN",
  "TradingPartnerDocumentId" : 300100075227041,
  "TradingPartnerDocumentStatus" : "Inactive",
  "ServiceRequestId" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100075227034/child/documents/300100075227041",
    "name" : "documents",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100075227034/child/documents/300100075227041",
    "name" : "documents",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100075227034",
    "name" : "b2bTradingPartners",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100075227034/child/documents/300100075227041/lov/documentNamesLOV",
    "name" : "documentNamesLOV",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100075227034/child/documents/300100075227041/lov/partnerDocumentStatusLOV",
    "name" : "partnerDocumentStatusLOV",
    "kind" : "collection"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/b2bTradingPartners/300100075227034/child/documents/300100075227041/child/messageProcessingRules",
    "name" : "messageProcessingRules",
    "kind" : "collection"
  } ]
}

Back to Top