Jump to

• Request
• Response

Create notification controls

post

/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/notificationControls

Request

Path Parameters

• draftPurchaseAgreementsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Purchase Agreements resource and used to uniquely identify an instance of Draft Purchase Agreements. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Agreements collection resource in order to navigate to a specific instance of Draft Purchase Agreements to get the hash key.

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

• Amount: number
  Notification amount of purchase agreement document total.
• Condition: string
  Title: Condition

  Maximum Length: 80

  Notification type of the purchase agreement.
• ConditionCode: string
  Maximum Length: 25

  Notification type of the purchase agreement.
• DFF: array DFF
• EndDate: string (date)
  Expiration date of the notification.
• Percentage: number
  Notification percentage of purchase agreement document total.
• ReminderDays: number
  Title: Reminder Days

  Value that identifies the number of days before the expiration event that the reminder notification needs to be sent.
• StartDate: string (date)
  Effective date of the notification.

{
    "type":"object",
    "properties":{
        "Amount":{
            "type":"number",
            "description":"Notification amount of purchase agreement document total.",
            "nullable":true,
            "x-queryable":false
        },
        "Condition":{
            "title":"Condition",
            "maxLength":80,
            "type":"string",
            "description":"Notification type of the purchase agreement.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConditionCode":{
            "maxLength":25,
            "type":"string",
            "description":"Notification type of the purchase agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-notificationControls-DFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "EndDate":{
            "type":"string",
            "description":"Expiration date of the notification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Percentage":{
            "type":"number",
            "description":"Notification percentage of purchase agreement document total.",
            "nullable":true,
            "x-queryable":false
        },
        "ReminderDays":{
            "title":"Reminder Days",
            "type":"number",
            "description":"Value that identifies the number of days before the expiration event that the reminder notification needs to be sent.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Effective date of the notification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-notificationControls-DFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• NotificationId: integer (int64)

{
    "type":"object",
    "properties":{
        "NotificationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : draftPurchaseAgreements-notificationControls-item-response

Type: object

Show Source

• Amount: number
  Notification amount of purchase agreement document total.
• Condition: string
  Title: Condition

  Maximum Length: 80

  Notification type of the purchase agreement.
• ConditionCode: string
  Maximum Length: 25

  Notification type of the purchase agreement.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the notification controls on the purchase agreement.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the buyer or application created the notification controls of a purchase agreement.
• DFF: array DFF
• EndDate: string (date)
  Expiration date of the notification.
• EntityChangeTypeCode: string
  Read Only: true

  Maximum Length: 1

  Value that identifies if the row is new or changed.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the buyer or application last updated the notification controls of a purchase agreement.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the notification controls of a purchase agreement.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the agreement notification control.
• Percentage: number
  Notification percentage of purchase agreement document total.
• ReminderDays: number
  Title: Reminder Days

  Value that identifies the number of days before the expiration event that the reminder notification needs to be sent.
• StartDate: string (date)
  Effective date of the notification.

{
    "type":"object",
    "properties":{
        "Amount":{
            "type":"number",
            "description":"Notification amount of purchase agreement document total.",
            "nullable":true,
            "x-queryable":false
        },
        "Condition":{
            "title":"Condition",
            "maxLength":80,
            "type":"string",
            "description":"Notification type of the purchase agreement.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConditionCode":{
            "maxLength":25,
            "type":"string",
            "description":"Notification type of the purchase agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the notification controls on the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the notification controls of a purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-notificationControls-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "EndDate":{
            "type":"string",
            "description":"Expiration date of the notification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EntityChangeTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies if the row is new or changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the notification controls of a purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the notification controls of a purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NotificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement notification control.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Percentage":{
            "type":"number",
            "description":"Notification percentage of purchase agreement document total.",
            "nullable":true,
            "x-queryable":false
        },
        "ReminderDays":{
            "title":"Reminder Days",
            "type":"number",
            "description":"Value that identifies the number of days before the expiration event that the reminder notification needs to be sent.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Effective date of the notification.",
            "format":"date",
            "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 : DFF

Type: array

Show Source

• Array of: object draftPurchaseAgreements-notificationControls-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-notificationControls-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : draftPurchaseAgreements-notificationControls-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "NotificationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/notificationControls/{NotificationId}/child/DFF

Parameters:

• NotificationId: $request.path.NotificationId
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID

Back to Top