Jump to

• Request
• Response

Patch one configuration parameter

patch

/fscmRestApi/resources/11.13.18.05/b2bMessageParameters/{MsgParamId}

Request

Path Parameters

• MsgParamId(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

• AutoReprocessTimePeriod: integer (int32)
  Title: Reprocessing Window

  Value that identifies the specific time period from which outbound messages with particular error subtypes are included for automatic reprocessing.
• DefaultSearchLocation: string
  Maximum Length: 100

  Value that defines the default service provider for trading partner searches.
• ElectronicOrderSrc: string
  Maximum Length: 100

  Value that indicates the electronic order source system.
• ESSOutEnable: string
  Title: Enable Reprocessing

  Maximum Length: 1

  Value that specifies whether automated reprocessing of outbound collaboration messages is enabled.
• ESSOutReprocessInterval: integer (int32)
  Title: Reprocessing Interval

  Value that specifies the interval, in minutes, for automatically reprocessing outbound messages with specific error subtypes.
• GlobalSenderId: string
  Maximum Length: 64

  Sender ID assigned to all outbound messages in the protocol header, such as the HTTP header.
• GlobalSenderIdType: string
  Maximum Length: 100

  Type of sender ID assigned to all outbound messages in the protocol header, such as the HTTP header.
• InDocumentSetupRequired: string
  Title: B2B setup required for inbound documents

  Maximum Length: 1

  Value used to set the maximum payload size accepted for processing by the Collaboration Messaging Framework.
• InvoiceOutSingleThreadCount: integer (int32)
  Value that identifies the invoice outbound per thread count.
• LargePOAttemptRetInt: integer (int32)
  Value that specifies the interval, in minutes, for attempting delivery of large purchase orders.
• LargePODelRetDur: integer (int32)
  Value that specifies the duration, in minutes, to attempt delivery of large purchase orders.
• LargePOMinimumLineCount: integer (int32)
  Value that specifies the minimum line count for large purchase orders.
• LinesRetSinQueryCount: integer (int32)
  Title: PO Lines Retrieved in a Single Query

  Value that indicates the number of PO lines retrieved at a time during payload processing.
• MaximumMsgInPayloadSize: integer (int32)
  Value used to determine whether payloads should be logged, payloads larger than the listed size aren't logged.
• MaximumMsgPayloadSize: integer (int32)
  Default Value: 10

  Value that indicates the maximum attachment size for outbound message processing.
• MaximumOutAttachmentSize: integer (int32)
  Value used to set the minimum length of time an outbound message can remain in process before any action is taken.
• MinimumInprocessTime: integer (int32)
  Value used to set the default date range of messaging history displayed on the Manage Collaboration Messaging History page.
• MsgHistoryDefaultDur: integer (int32)
  Value that's used to set the default date range of messaging history that appears on the Manage Collaboration Messaging History page.
• MsgParamId: integer (int64)
  Value that uniquely identifies the configuration parameters.
• MultiInMsgsWaitDur: integer (int32)
  Value that indicates the multi-inbound messages wait duration.
• StoreInInput: string
  Maximum Length: 10

  Value that enables storage of an inbound message before it's transformed.
• StoreInOutput: string
  Maximum Length: 10

  Value that stores an inbound message after it's transformed.
• StoreOutInput: string
  Maximum Length: 10

  Value that enables storage of an outbound message before it's transformed.
• StoreOutOutput: string
  Maximum Length: 10

  Value that stores an outbound message after it's transformed.
• SupplierLevelAccSetup: string
  Maximum Length: 1

  Value that identifies the supplier-level account setup.
• UcmDocumentSecurityGrp: string
  Maximum Length: 100

  Value that indicates the UCM document security group.
• UpdateOutBoundReprocessParamFlag: boolean
  Value that identifies the update outbound reprocess parameter.

{
    "type":"object",
    "properties":{
        "AutoReprocessTimePeriod":{
            "title":"Reprocessing Window",
            "type":"integer",
            "description":"Value that identifies the specific time period from which outbound messages with particular error subtypes are included for automatic reprocessing.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "DefaultSearchLocation":{
            "maxLength":100,
            "type":"string",
            "description":"Value that defines the default service provider for trading partner searches.",
            "nullable":true
        },
        "ESSOutEnable":{
            "title":"Enable Reprocessing",
            "maxLength":1,
            "type":"string",
            "description":"Value that specifies whether automated reprocessing of outbound collaboration messages is enabled.",
            "nullable":true
        },
        "ESSOutReprocessInterval":{
            "title":"Reprocessing Interval",
            "type":"integer",
            "description":"Value that specifies the interval, in minutes, for automatically reprocessing outbound messages with specific error subtypes.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "ElectronicOrderSrc":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates the electronic order source system.",
            "nullable":true
        },
        "GlobalSenderId":{
            "maxLength":64,
            "type":"string",
            "description":"Sender ID assigned to all outbound messages in the protocol header, such as the HTTP header.",
            "nullable":true
        },
        "GlobalSenderIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Type of sender ID assigned to all outbound messages in the protocol header, such as the HTTP header.",
            "nullable":true
        },
        "InDocumentSetupRequired":{
            "title":"B2B setup required for inbound documents",
            "maxLength":1,
            "type":"string",
            "description":"Value used to set the maximum payload size accepted for processing by the Collaboration Messaging Framework.",
            "nullable":true
        },
        "InvoiceOutSingleThreadCount":{
            "type":"integer",
            "description":"Value that identifies the invoice outbound per thread count.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        },
        "LargePOAttemptRetInt":{
            "type":"integer",
            "description":"Value that specifies the interval, in minutes, for attempting delivery of large purchase orders.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "LargePODelRetDur":{
            "type":"integer",
            "description":"Value that specifies the duration, in minutes, to attempt delivery of large purchase orders.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "LargePOMinimumLineCount":{
            "type":"integer",
            "description":"Value that specifies the minimum line count for large purchase orders.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":6
            }
        },
        "LinesRetSinQueryCount":{
            "title":"PO Lines Retrieved in a Single Query",
            "type":"integer",
            "description":"Value that indicates the number of PO lines retrieved at a time during payload processing.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        },
        "MaximumMsgInPayloadSize":{
            "type":"integer",
            "description":"Value used to determine whether payloads should be logged, payloads larger than the listed size aren't logged.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            }
        },
        "MaximumMsgPayloadSize":{
            "type":"integer",
            "description":"Value that indicates the maximum attachment size for outbound message processing.",
            "format":"int32",
            "nullable":true,
            "default":10,
            "x-hints":{
                "precision":3
            }
        },
        "MaximumOutAttachmentSize":{
            "type":"integer",
            "description":"Value used to set the minimum length of time an outbound message can remain in process before any action is taken.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "MinimumInprocessTime":{
            "type":"integer",
            "description":"Value used to set the default date range of messaging history displayed on the Manage Collaboration Messaging History page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "MsgHistoryDefaultDur":{
            "type":"integer",
            "description":"Value that's used to set the default date range of messaging history that appears on the Manage Collaboration Messaging History page.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "MsgParamId":{
            "type":"integer",
            "description":"Value that uniquely identifies the configuration parameters.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MultiInMsgsWaitDur":{
            "type":"integer",
            "description":"Value that indicates the multi-inbound messages wait duration.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "StoreInInput":{
            "maxLength":10,
            "type":"string",
            "description":"Value that enables storage of an inbound message before it's transformed.",
            "nullable":true
        },
        "StoreInOutput":{
            "maxLength":10,
            "type":"string",
            "description":"Value that stores an inbound message after it's transformed.",
            "nullable":true
        },
        "StoreOutInput":{
            "maxLength":10,
            "type":"string",
            "description":"Value that enables storage of an outbound message before it's transformed.",
            "nullable":true
        },
        "StoreOutOutput":{
            "maxLength":10,
            "type":"string",
            "description":"Value that stores an outbound message after it's transformed.",
            "nullable":true
        },
        "SupplierLevelAccSetup":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the supplier-level account setup.",
            "nullable":true
        },
        "UcmDocumentSecurityGrp":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates the UCM document security group.",
            "nullable":true
        },
        "UpdateOutBoundReprocessParamFlag":{
            "type":"boolean",
            "description":"Value that identifies the update outbound reprocess parameter.",
            "nullable":true,
            "x-queryable":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 : b2bMessageParameters-item-response

Type: object

Show Source

• AutoReprocessTimePeriod: integer (int32)
  Title: Reprocessing Window

  Value that identifies the specific time period from which outbound messages with particular error subtypes are included for automatic reprocessing.
• DefaultSearchLocation: string
  Maximum Length: 100

  Value that defines the default service provider for trading partner searches.
• ElectronicOrderSrc: string
  Maximum Length: 100

  Value that indicates the electronic order source system.
• ESSOutEnable: string
  Title: Enable Reprocessing

  Maximum Length: 1

  Value that specifies whether automated reprocessing of outbound collaboration messages is enabled.
• ESSOutReprocessInterval: integer (int32)
  Title: Reprocessing Interval

  Value that specifies the interval, in minutes, for automatically reprocessing outbound messages with specific error subtypes.
• GlobalSenderId: string
  Maximum Length: 64

  Sender ID assigned to all outbound messages in the protocol header, such as the HTTP header.
• GlobalSenderIdType: string
  Maximum Length: 100

  Type of sender ID assigned to all outbound messages in the protocol header, such as the HTTP header.
• InDocumentSetupRequired: string
  Title: B2B setup required for inbound documents

  Maximum Length: 1

  Value used to set the maximum payload size accepted for processing by the Collaboration Messaging Framework.
• InvoiceOutSingleThreadCount: integer (int32)
  Value that identifies the invoice outbound per thread count.
• LargePOAttemptRetInt: integer (int32)
  Value that specifies the interval, in minutes, for attempting delivery of large purchase orders.
• LargePODelRetDur: integer (int32)
  Value that specifies the duration, in minutes, to attempt delivery of large purchase orders.
• LargePOMinimumLineCount: integer (int32)
  Value that specifies the minimum line count for large purchase orders.
• LinesRetSinQueryCount: integer (int32)
  Title: PO Lines Retrieved in a Single Query

  Value that indicates the number of PO lines retrieved at a time during payload processing.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumMsgInPayloadSize: integer (int32)
  Value used to determine whether payloads should be logged, payloads larger than the listed size aren't logged.
• MaximumMsgPayloadSize: integer (int32)
  Default Value: 10

  Value that indicates the maximum attachment size for outbound message processing.
• MaximumOutAttachmentSize: integer (int32)
  Value used to set the minimum length of time an outbound message can remain in process before any action is taken.
• MinimumInprocessTime: integer (int32)
  Value used to set the default date range of messaging history displayed on the Manage Collaboration Messaging History page.
• MsgHistoryDefaultDur: integer (int32)
  Value that's used to set the default date range of messaging history that appears on the Manage Collaboration Messaging History page.
• MsgParamId: integer (int64)
  Value that uniquely identifies the configuration parameters.
• MultiInMsgsWaitDur: integer (int32)
  Value that indicates the multi-inbound messages wait duration.
• StoreInInput: string
  Maximum Length: 10

  Value that enables storage of an inbound message before it's transformed.
• StoreInOutput: string
  Maximum Length: 10

  Value that stores an inbound message after it's transformed.
• StoreOutInput: string
  Maximum Length: 10

  Value that enables storage of an outbound message before it's transformed.
• StoreOutOutput: string
  Maximum Length: 10

  Value that stores an outbound message after it's transformed.
• SupplierLevelAccSetup: string
  Maximum Length: 1

  Value that identifies the supplier-level account setup.
• UcmDocumentSecurityGrp: string
  Maximum Length: 100

  Value that indicates the UCM document security group.
• UpdateOutBoundReprocessParamFlag: boolean
  Value that identifies the update outbound reprocess parameter.

{
    "type":"object",
    "properties":{
        "AutoReprocessTimePeriod":{
            "title":"Reprocessing Window",
            "type":"integer",
            "description":"Value that identifies the specific time period from which outbound messages with particular error subtypes are included for automatic reprocessing.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "DefaultSearchLocation":{
            "maxLength":100,
            "type":"string",
            "description":"Value that defines the default service provider for trading partner searches.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSOutEnable":{
            "title":"Enable Reprocessing",
            "maxLength":1,
            "type":"string",
            "description":"Value that specifies whether automated reprocessing of outbound collaboration messages is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSOutReprocessInterval":{
            "title":"Reprocessing Interval",
            "type":"integer",
            "description":"Value that specifies the interval, in minutes, for automatically reprocessing outbound messages with specific error subtypes.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ElectronicOrderSrc":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates the electronic order source system.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalSenderId":{
            "maxLength":64,
            "type":"string",
            "description":"Sender ID assigned to all outbound messages in the protocol header, such as the HTTP header.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalSenderIdType":{
            "maxLength":100,
            "type":"string",
            "description":"Type of sender ID assigned to all outbound messages in the protocol header, such as the HTTP header.",
            "nullable":true,
            "x-queryable":true
        },
        "InDocumentSetupRequired":{
            "title":"B2B setup required for inbound documents",
            "maxLength":1,
            "type":"string",
            "description":"Value used to set the maximum payload size accepted for processing by the Collaboration Messaging Framework.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceOutSingleThreadCount":{
            "type":"integer",
            "description":"Value that identifies the invoice outbound per thread count.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "LargePOAttemptRetInt":{
            "type":"integer",
            "description":"Value that specifies the interval, in minutes, for attempting delivery of large purchase orders.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "LargePODelRetDur":{
            "type":"integer",
            "description":"Value that specifies the duration, in minutes, to attempt delivery of large purchase orders.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "LargePOMinimumLineCount":{
            "type":"integer",
            "description":"Value that specifies the minimum line count for large purchase orders.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":6
            },
            "x-queryable":true
        },
        "LinesRetSinQueryCount":{
            "title":"PO Lines Retrieved in a Single Query",
            "type":"integer",
            "description":"Value that indicates the number of PO lines retrieved at a time during payload processing.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "MaximumMsgInPayloadSize":{
            "type":"integer",
            "description":"Value used to determine whether payloads should be logged, payloads larger than the listed size aren't logged.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "MaximumMsgPayloadSize":{
            "type":"integer",
            "description":"Value that indicates the maximum attachment size for outbound message processing.",
            "format":"int32",
            "nullable":true,
            "default":10,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "MaximumOutAttachmentSize":{
            "type":"integer",
            "description":"Value used to set the minimum length of time an outbound message can remain in process before any action is taken.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "MinimumInprocessTime":{
            "type":"integer",
            "description":"Value used to set the default date range of messaging history displayed on the Manage Collaboration Messaging History page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "MsgHistoryDefaultDur":{
            "type":"integer",
            "description":"Value that's used to set the default date range of messaging history that appears on the Manage Collaboration Messaging History page.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "MsgParamId":{
            "type":"integer",
            "description":"Value that uniquely identifies the configuration parameters.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MultiInMsgsWaitDur":{
            "type":"integer",
            "description":"Value that indicates the multi-inbound messages wait duration.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "StoreInInput":{
            "maxLength":10,
            "type":"string",
            "description":"Value that enables storage of an inbound message before it's transformed.",
            "nullable":true,
            "x-queryable":true
        },
        "StoreInOutput":{
            "maxLength":10,
            "type":"string",
            "description":"Value that stores an inbound message after it's transformed.",
            "nullable":true,
            "x-queryable":true
        },
        "StoreOutInput":{
            "maxLength":10,
            "type":"string",
            "description":"Value that enables storage of an outbound message before it's transformed.",
            "nullable":true,
            "x-queryable":true
        },
        "StoreOutOutput":{
            "maxLength":10,
            "type":"string",
            "description":"Value that stores an outbound message after it's transformed.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierLevelAccSetup":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the supplier-level account setup.",
            "nullable":true,
            "x-queryable":true
        },
        "UcmDocumentSecurityGrp":{
            "maxLength":100,
            "type":"string",
            "description":"Value that indicates the UCM document security group.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateOutBoundReprocessParamFlag":{
            "type":"boolean",
            "description":"Value that identifies the update outbound reprocess parameter.",
            "nullable":true,
            "x-queryable":false
        },
        "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."
        }
    }
}

Back to Top