Jump to

• Request
• Response

Update one sourcing notification subscription

patch

/fscmRestApi/resources/11.13.18.05/sourcingNotificationSubscriptions/{NotificationId}

Request

Path Parameters

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

• AuctionEnabledFlag: boolean
  Title: Auction

  Maximum Length: 1

  Indicates whether notifications are enabled for auctions. Contains one of the following values: true or false. If true, then notifications are enabled for auctions. If false, then notifications aren't enabled for auctions. This attribute doesn't have a default value.
• RequestForInformationEnabledFlag: boolean
  Title: RFI

  Maximum Length: 1

  Indicates whether request for information notifications are enabled. Contains one of the following values: true or false. If true, request-for-information notifications are enabled. If false, request-for-information notifications aren't enabled. This attribute doesn't have a default value.
• RequestForQoutationEnabledFlag: boolean
  Title: RFQ

  Maximum Length: 1

  Indicates whether notifications are enabled for the request for quotation. Contains one of the following values: true or false. If true, then notifications are sent for the request for quotation. If false, then notifications aren't sent for the request for quotation. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "AuctionEnabledFlag":{
            "title":"Auction",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether notifications are enabled for auctions. Contains one of the following values: true or false. If true, then notifications are enabled for auctions. If false, then notifications aren't enabled for auctions. This attribute doesn't have a default value.",
            "nullable":true
        },
        "RequestForInformationEnabledFlag":{
            "title":"RFI",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether request for information notifications are enabled. Contains one of the following values: true or false. If true, request-for-information notifications are enabled. If false, request-for-information notifications aren't enabled. This attribute doesn't have a default value.",
            "nullable":true
        },
        "RequestForQoutationEnabledFlag":{
            "title":"RFQ",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether notifications are enabled for the request for quotation. Contains one of the following values: true or false. If true, then notifications are sent for the request for quotation. If false, then notifications aren't sent for the request for quotation. This attribute doesn't have a default value.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : sourcingNotificationSubscriptions-item-response

Type: object

Show Source

• AuctionEnabledFlag: boolean
  Title: Auction

  Maximum Length: 1

  Indicates whether notifications are enabled for auctions. Contains one of the following values: true or false. If true, then notifications are enabled for auctions. If false, then notifications aren't enabled for auctions. This attribute doesn't have a default value.
• ExternalRecipientEnabledFlag: boolean
  Title: External

  Read Only: true

  Maximum Length: 1

  Indicates whether external recipients can receive the notification subscription. Contains one of the following values: true or false. If true, then external recipients can receive the notification. If false, then only internal recipients can receive the notification. This attribute doesn't have a default value.
• InternalRecipientEnabledFlag: boolean
  Title: Internal

  Read Only: true

  Maximum Length: 1

  Indicates whether internal recipients are enabled. Contains one of the following values: true or false. If true, then internal recipients are enabled. If false, then internal recipients aren't enabled. This attribute doesn't have a default value.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the notification subscription.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationId: integer (int64)
  Read Only: true

  Unique identifier of the notification.
• NotificationType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of notification subscription.
• NotificationTypeCode: string
  Title: Notification

  Read Only: true

  Maximum Length: 30

  Code that identifies the notification type. Valid values are defined by the notification type lookup.
• RequestForInformationEnabledFlag: boolean
  Title: RFI

  Maximum Length: 1

  Indicates whether request for information notifications are enabled. Contains one of the following values: true or false. If true, request-for-information notifications are enabled. If false, request-for-information notifications aren't enabled. This attribute doesn't have a default value.
• RequestForQoutationEnabledFlag: boolean
  Title: RFQ

  Maximum Length: 1

  Indicates whether notifications are enabled for the request for quotation. Contains one of the following values: true or false. If true, then notifications are sent for the request for quotation. If false, then notifications aren't sent for the request for quotation. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "AuctionEnabledFlag":{
            "title":"Auction",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether notifications are enabled for auctions. Contains one of the following values: true or false. If true, then notifications are enabled for auctions. If false, then notifications aren't enabled for auctions. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalRecipientEnabledFlag":{
            "title":"External",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether external recipients can receive the notification subscription. Contains one of the following values: true or false. If true, then external recipients can receive the notification. If false, then only internal recipients can receive the notification. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalRecipientEnabledFlag":{
            "title":"Internal",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether internal recipients are enabled. Contains one of the following values: true or false. If true, then internal recipients are enabled. If false, then internal recipients aren't enabled. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time of the last update of the row.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the notification subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationId":{
            "type":"integer",
            "description":"Unique identifier of the notification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "NotificationType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of notification subscription.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationTypeCode":{
            "title":"Notification",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the notification type. Valid values are defined by the notification type lookup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestForInformationEnabledFlag":{
            "title":"RFI",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether request for information notifications are enabled. Contains one of the following values: true or false. If true, request-for-information notifications are enabled. If false, request-for-information notifications aren't enabled. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestForQoutationEnabledFlag":{
            "title":"RFQ",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether notifications are enabled for the request for quotation. Contains one of the following values: true or false. If true, then notifications are sent for the request for quotation. If false, then notifications aren't sent for the request for quotation. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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